環境變數設定
Redash 的許多功能可以透過設定來變更。設定會由 redash.settings
從環境變數讀取,這些變數(對於大多數安裝)可以在 /opt/redash/.env
中設定。使用 Docker 開發時,請在根目錄中建立 .env
檔案。
以下是設定及其控制內容的清單
名稱 | 描述 | 預設值 |
---|---|---|
REDASH_ADDITIONAL_DESTINATIONS |
要啟用的非預設警示目標的逗號分隔清單 | |
REDASH_ADDITIONAL_QUERY_RUNNERS |
要啟用的非預設查詢執行器的逗號分隔清單 | |
REDASH_ADHOC_QUERY_TIME_LIMIT |
臨時查詢的時間限制(以秒為單位) | None |
REDASH_ALERTS_DEFAULT_MAIL_BODY_TEMPLATE_FILE |
用於格式化電子郵件警示的 HTML 範本。支援自訂警示變數。依照慣例,允許在 <head> 區段中使用 CSS。 |
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 伺服器和 Worker 服務將用來存取中繼資料庫的 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 內未被 Worker 選取,則會過期。 | 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 |
JSON Web Key (JWK) 格式的 RSA 公開金鑰,用於 HTTP;或者用於 FILE 位置的 PEM | |
REDASH_JWT_LOGIN_ENABLED |
false | |
REDASH_LDAP_BIND_DN_PASSWORD |
||
REDASH_LDAP_BIND_DN |
None | |
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 |
None | |
REDASH_LIMITER_STORAGE |
直接對應至 Flask-Limiter 的 storage_uri。 | REDIS_URL |
REDASH_LOG_LEVEL |
將忽略嚴重程度低於 level 的記錄訊息。深入了解 Python 記錄於此 | INFO |
REDASH_MAIL_ASCII_ATTACHMENTS |
false | |
REDASH_MAIL_DEFAULT_SENDER |
None | |
REDASH_MAIL_MAX_EMAILS |
None | |
REDASH_MAIL_PASSWORD |
None | |
REDASH_MAIL_PORT |
25 | |
REDASH_MAIL_SERVER |
localhost | |
REDASH_MAIL_USERNAME |
None | |
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 等 Proxy 後面也能獲得正確的參照位址。 | 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 |
排程查詢的時間限制(以秒為單位) | None |
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 |