环境变量设置
Redash 的许多功能可以通过设置进行更改。设置由 redash.settings
从环境变量读取,环境变量(对于大多数安装)可以在 /opt/redash/.env
中设置。使用 Docker 进行开发时,请在根目录中创建 .env
文件。
以下是设置列表及其控制的功能
名称 | 描述 | 默认值 |
---|---|---|
REDASH_ADDITIONAL_DESTINATIONS |
要启用的非默认警报目标,以逗号分隔的列表 | |
REDASH_ADDITIONAL_QUERY_RUNNERS |
要启用的非默认查询运行器,以逗号分隔的列表 | |
REDASH_ADHOC_QUERY_TIME_LIMIT |
临时查询的时间限制(以秒为单位) | 无 |
REDASH_ALERTS_DEFAULT_MAIL_BODY_TEMPLATE_FILE |
用于格式化电子邮件警报的 HTML 模板。支持自定义警报变量。按照惯例,CSS 允许在 <head> 部分中使用。 |
templates/emails/alert.html |
REDASH_ALERTS_DEFAULT_MAIL_SUBJECT_TEMPLATE |
用于电子邮件警报通知的主题。{state} 和 {alert_name} 是唯一可用的变量。 |
({state}) {alert_name} |
REDASH_ALLOW_SCRIPTS_IN_USER_INPUT |
禁用文本输入的清理,允许完整的 HTML | false |
REDASH_AUTH_TYPE |
可以是 api_key 或 hmac 。在此处实现 |
api_key |
REDASH_BIGQUERY_HTTP_TIMEOUT |
BigQuery 查询运行器的 HTTP 超时 | 600 |
REDASH_BLOCKED_DOMAINS |
不能创建用户帐户的电子邮件域,以逗号分隔 | “qq.com” |
REDASH_COOKIE_SECRET |
必需。用于 Web 服务器的各种加密功能。请在此处阅读更多关于 Redash 如何使用密钥的信息这里 | |
REDASH_CORS_ACCESS_CONTROL_ALLOW_CREDENTIALS |
false | |
REDASH_CORS_ACCESS_CONTROL_ALLOW_HEADERS |
Content-Type | |
REDASH_CORS_ACCESS_CONTROL_ALLOW_ORIGIN |
||
REDASH_CORS_ACCESS_CONTROL_REQUEST_METHOD |
GET, POST, PUT | |
REDASH_DASHBOARD_REFRESH_INTERVALS |
仪表板刷新允许的整数秒数,以逗号分隔的列表 | 60,300,600,1800,3600,43200,86400 |
REDASH_DATABASE_URL |
Redash 服务器和工作服务将用于访问元数据数据库的 URL | postgresql://postgres |
REDASH_DATE_FORMAT |
在整个 Web 应用程序中使用的 Moment.js 格式 | DD/MM/YY |
REDASH_DISABLED_QUERY_RUNNERS |
不会在 Redash 中显示的查询运行器,以逗号分隔的列表 | |
REDASH_DISABLE_PUBLIC_URLS |
是否禁用对公共 URL 的访问 | “false” |
REDASH_ENABLED_DESTINATIONS |
要启用的警报目标,以逗号分隔的列表(例如 redash.destinations.email,redash.destinations.slack ) |
”,”.join(default_destinations) |
REDASH_ENABLED_QUERY_RUNNERS |
要启用的查询运行器,以逗号分隔的列表(例如 redash.query_runner.pg,redash.query_runner.mysql ) |
”,”.join(default_query_runners) |
REDASH_ENFORCE_CSRF |
在 API 请求上强制执行 CSRF 令牌验证。默认情况下,此选项处于关闭状态,以避免破坏任何现有部署,但强烈建议打开此切换以防止 CSRF 攻击。 | false |
REDASH_ENFORCE_HTTPS |
传递给 Flask-Talisman | false |
REDASH_EVENT_REPORTING_WEBHOOKS |
将事件转发到的 Webhook URL,以逗号分隔的列表 | |
REDASH_FEATURE_ALLOW_CUSTOM_JS_VISUALIZATIONS |
启用自定义可视化选项。这在 UI 中显示为“图表”可视化的子类型。 | true |
REDASH_FEATURE_AUTO_PUBLISH_NAMED_QUERIES |
在查询名称从“新查询”更改后自动发布新查询 | true |
REDASH_FEATURE_DISABLE_REFRESH_QUERIES |
禁用计划查询执行 | false |
REDASH_FEATURE_SHOW_PERMISSIONS_CONTROL |
启用实验性的多所有者支持 | false |
REDASH_FEATURE_SHOW_QUERY_RESULTS_COUNT |
禁用/启用在状态中显示查询结果计数 | true |
REDASH_GOOGLE_CLIENT_ID |
用于 Google 登录的客户端 ID,请务必同时设置客户端密钥 | |
REDASH_GOOGLE_CLIENT_SECRET |
用于 Google 登录的客户端密钥,请务必同时设置客户端 ID | |
REDASH_HOST |
发送给用户的电子邮件(邀请、警报、通知等)中使用的 URL 主机 | |
REDASH_INVITATION_TOKEN_MAX_AGE |
邀请链接过期之前的秒数整数 | 60 _ 60 _ 24 * 7 |
REDASH_JOB_EXPIRY_TIME |
队列中作业的 TTL(以秒为单位)。如果作业在此 TTL 内未被工作进程拾取,它将过期。 | 3600 * 12 |
REDASH_JWT_AUTH_ALGORITHMS |
HS256,RS256,ES256 | |
REDASH_JWT_AUTH_AUDIENCE |
||
REDASH_JWT_AUTH_COOKIE_NAME |
||
REDASH_JWT_AUTH_HEADER_NAME |
||
REDASH_JWT_AUTH_ISSUER |
||
REDASH_JWT_AUTH_PUBLIC_CERTS_URL |
HTTP 的 JSON Web 密钥 (JWK) 格式的 RSA 公钥,或 FILE 位置的 PEM 格式 | |
REDASH_JWT_LOGIN_ENABLED |
false | |
REDASH_LDAP_BIND_DN_PASSWORD |
||
REDASH_LDAP_BIND_DN |
无 | |
REDASH_LDAP_CUSTOM_USERNAME_PROMPT |
LDAP/AD/SSO 用户名 | |
REDASH_LDAP_DISPLAY_NAME_KEY |
displayName | |
REDASH_LDAP_EMAIL_KEY |
||
REDASH_LDAP_LOGIN_ENABLED |
false | |
REDASH_LDAP_SEARCH_DN |
REDASH_SEARCH_DN | |
REDASH_LDAP_SEARCH_TEMPLATE |
(cn=%(username)s) | |
REDASH_LDAP_URL |
无 | |
REDASH_LIMITER_STORAGE |
直接映射到 Flask-Limiter 的 storage_uri。 | REDIS_URL |
REDASH_LOG_LEVEL |
将忽略严重性低于级别的日志消息。在此处阅读更多关于 Python 日志的信息 这里 | INFO |
REDASH_MAIL_ASCII_ATTACHMENTS |
false | |
REDASH_MAIL_DEFAULT_SENDER |
无 | |
REDASH_MAIL_MAX_EMAILS |
无 | |
REDASH_MAIL_PASSWORD |
无 | |
REDASH_MAIL_PORT |
25 | |
REDASH_MAIL_SERVER |
localhost | |
REDASH_MAIL_USERNAME |
无 | |
REDASH_MAIL_USE_SSL |
false | |
REDASH_MAIL_USE_TLS |
false | |
REDASH_MULTI_ORG |
是否启用多组织模式。注意:多组织模式目前未提供文档或支持 | false |
REDASH_PASSWORD_LOGIN_ENABLED |
切换以允许密码登录。如果启用了 Google 登录、SAML、LDAP 或 REMOTE_USER_LOGIN,通常会禁用此项。 | true |
REDASH_PROXIES_COUNT |
传递给 Werkzeug 的 ProxyFix 以确保即使在 nginx 等代理后面也能获得正确的引用地址。 | 1 |
REDASH_QUERY_REFRESH_INTERVALS |
计划查询刷新允许的整数秒数,以逗号分隔的列表 | 60, 300, 600, 900, 1800, 3600, 7200, 10800, 14400, 18000, 21600, 25200, 28800, 32400, 36000, 39600, 43200, 86400, 604800, 1209600, 2592000 |
REDASH_QUERY_RESULTS_CLEANUP_COUNT |
每次调用 cleanup_query_results 时要清理的结果数 |
100 |
REDASH_QUERY_RESULTS_CLEANUP_ENABLED |
是否应自动运行清理未使用查询结果的作业 | true |
REDASH_QUERY_RESULTS_CLEANUP_MAX_AGE |
整数天数,如果查询结果未被其他查询引用,则可以清理过去的天数。 | 7 |
REDASH_QUERY_RESULTS_EXPIRED_TTL_ENABLED |
启用查询结果集默认过期 ttl。 | false |
REDASH_QUERY_RESULTS_EXPIRED_TTL |
默认设置查询结果过期 ttl 为 86400 秒。 | 86400 |
REDASH_REDIS_URL |
Redash 服务将用于读写 Redis 的 URL | “redis://127.0.0.1:6379/0” |
REDASH_REMOTE_USER_HEADER |
如果 REDASH_REMOTE_USER_LOGIN_ENABLED 为 true,则使用的标头的名称 |
X-Forwarded-Remote-User |
REDASH_REMOTE_USER_LOGIN_ENABLED |
允许通过 HTTP 标头使用外部提供且受信任的远程用户。“用户”必须是电子邮件地址。 更多详情 | false |
REDASH_SAML_ENTITY_ID |
||
REDASH_SAML_METADATA_URL |
||
REDASH_SAML_NAMEID_FORMAT |
||
REDASH_SCHEDULED_QUERY_TIME_LIMIT |
计划查询的时间限制(以秒为单位) | 无 |
REDASH_SCHEMAS_REFRESH_SCHEDULE |
刷新数据源架构的频率(以分钟为单位) | 30 |
REDASH_SCHEMAS_REFRESH_TIMEOUT |
刷新数据源架构的时间限制(以秒为单位) | 300 |
REDASH_SCHEMA_RUN_TABLE_SIZE_CALCULATIONS |
启用在架构浏览器中显示每个表的大小。 | false |
REDASH_SENTRY_DSN |
||
REDASH_STATIC_ASSETS_PATH |
包含所有前端资源的目录。相对于 ./redash 目录 | “../client/dist/” |
REDASH_STATSD_HOST |
STATSD 守护程序的主机 | 127.0.0.1 |
REDASH_STATSD_PORT |
STATSD 守护程序的端口 | 8125 |
REDASH_STATSD_PREFIX |
发送到 STATSD 守护程序的指标的前缀 | redash |
REDASH_STATSD_USE_TAGS |
是否在 StatsD 指标中使用标签(InfluxDB 的格式) | false |
REDASH_THROTTLE_LOGIN_PATTERN |
用于限制对 /login 路由的请求速率的 Flask-Limiter 字符串模式。 | 50/小时 |
REDASH_VERSION_CHECK |
切换是否定期检查是否有更新版本的 Redash 可用。 | true |
REDASH_WEB_WORKERS |
gunicorn 将启动多少个进程来处理 Web 请求 | 4 |