環境変数

変数

目的

JWT_SECRET

APIサーバーによる認証のためのJWTへの署名に使用します。

ENCRYPTION_KEY

Postgres DBに格納されるもの(データベース資格情報、SSH鍵など)を暗号化します。複数のインスタンスを共通のGitリポジトリーを介して同期させている場合は、それらすべてで同じENCRYPTION_KEYが共有されていることを確認する必要があります。

COOKIE_INSECURE

安全でないCookieを使用して認証リクエストを送信します。HTTPSでないURLや生のIPアドレスでRetoolがホストされている場合はtrueに設定します。これは通常は、Retoolをまだカスタム・ドメインにデプロイしていない場合に使用します。

BASE_DOMAIN

BASE_DOMAIN変数は、新しいユーザーの招待や忘れたパスワードのリセットなどの場合に、ユーザー用のリンクを作成するのに役立ちます。バックエンドではこのリンクの推定が行われますが、実際のWebサイトの手前にプロキシがある場合はそれが正しくないことがあります。

Retoolがデプロイされているフル・ドメインを含めてください。次に例を示します。

BASE_DOMAIN=https://retool.yourwebsite.com

VERSION_CONTROL_LOCKED

Git Syncingに使用します。このRetoolインスタンスでリポジトリーからのプルのみを行う(リポジトリーへのプッシュは行わない)場合は、trueに設定します。

CLIENT_ID

Google SheetsまたはGoogle SSOのインテグレーション、もしくは両方に使用します。

CLIENT_SECRET

Google SheetsまたはGoogle SSOのインテグレーション、もしくは両方に使用します。

SCIM_AUTH_TOKEN

ユーザー・アカウントをプロビジョニングするためにサードパーティのSSOプロバイダー(Oktaなど)と共有するシークレット・トークンです。

RETOOL_EXPOSED_XYZ

このフォーマットの.env変数にはResource configuration画面でアクセスできます。詳細はこちら

DEBUG

冗長ロギングを有効にするには、DEBUG=1に設定します。

RESTRICTED_DOMAIN

ログインをSSOに限定します(サインイン・ページでのユーザー名とパスワードの入力を無効にします)。

注意: Retoolのデプロイ時に、この環境変数でSSOのみでのログインを有効にするには、最初にユーザー名とパスワードでサインアップする必要があります。(つまり、最初のユーザーはユーザー名とパスワードでサインアップする必要があります。)

この環境変数の値は電子メール・ドメインと一致している必要があります。

例: RESTRICTED_DOMAIN=yourcompany.com

複数のドメインを認証する場合は、カンマ区切りのリストを使用します(例: RESTRICTED_DOMAIN=acme.com,acme.dev)。

CLIENT_MAX_BODY_SIZE

クエリーのレスポンスのサイズを制限するためにnginxコンテナーhttps-portalで使用します。

LOG_AUDIT_EVENTS

監査ログをログに出力するには、trueに設定します。デフォルトはfalseです。

USE_SHORT_SESSIONS

短いセッションを有効にする場合は、trueに設定します。これには、ユーザーが12時間ごとにログインする必要があります(これが有効になっていない場合のデフォルトは1週間であり、ログインするたびに延長されます)。これはSSOでも同様に機能します。

HIDE_PROD_AND_STAGING_TOGGLES

trueに設定すると、編集モードとエンド・ユーザー・モードの両方のUIで、本番とステージングのトグルが非表示になります。これは、Retoolで本番とステージングを管理していない場合に(例えば、2つ以上のインスタンスの間のGit Syncingによって)、混乱を減らすのに役立ちます。

DISABLE_MEMORY_AND_CPU_USAGE_LOGGING

CPU使用率とメモリー統計のロギングを無効にするには、trueに設定します。

CUSTOM_API_KEY

カスタムAPIキーを提供します(Retoolによって生成されたAPIキーより優先されます)。

SENDING_INVITES_WITH_EMAIL_DISABLED

trueに設定すると、ユーザーが、招待サーバーをpingせずに招待できるようになります(Retoolが招待サーバーへの接続を試みて失敗した場合、新規ユーザーの追加はできません)。エアギャップ済みのデプロイに役立ちます。

DEFAULT_GROUP_FOR_DOMAINS

SSOドメインをRetoolグループにマップします。例: DEFAULT_GROUP_FOR_DOMAINS=retool.com -> admin, foo.com -> viewer

LOG_LEVEL

標準出力へのログの量を制御します。

指定可能な値
"info": デフォルトのロギング・レベル
"verbose": Git Syncingや認証システムなどのためのより冗長なログ
"debug": 未加工のデバッグ・ログ

CUSTOM_LOGOUT_REDIRECT

ログアウト時にユーザーをリダイレクトする、カスタムURLを設定します。これは、ユーザーを、SSOプロバイダーからグローバルにログアウトさせるURLにリダイレクトする場合などに役立ちます。

TRIGGER_SAML_LOGIN_AUTOMATICALLY
TRIGGER_OAUTH_2_SSO_LOGIN_AUTOMATICALLY

SAMLログインまたはOauth2 SSOログインのSSOフローの自動開始を有効にするには、このそれぞれの環境変数をtrueに設定します。つまり、認証されていないユーザーは、retool.yourdomain.xyzにアクセスすると自動的にSSOワークフローに送られます。

ENABLE_CLIENT_SIDE_CUSTOM_AUTH_BROWSER_CALLS

この環境変数を設定すると、編集者が、REST APIコールをブラウザーから直接実行するリソース・カスタム認証ステップを設定できるようになります。 ブラウザーの資格情報は、オリジン間コールの場合であっても、これらのリクエストとともに含まれます。

ENABLE_CUSTOM_PLATFORM_LEVEL_AUTH_STEPS

この環境変数を設定すると、ユーザーがRetoolにログインするたびに実行される、カスタム認証ステップを構成できるようになります。これらのステップはOrganization Settings -> Authenticationで定義します。これらのステップでは、すべてのREST APIリソースで使用可能な変数を定義できます(複数のリソースで共有されているトークンの場合など)。

DBCONNECTOR_QUERY_TIMEOUT_MS

完了までに2分より長くかかるクエリーを実行する必要がある場合は、この環境変数を設定します。タイムアウトをミリ秒単位で指定します。例えば、デフォルト値は120000 ms(2分)です。

注意: ロード・バランサーの後ろにRetoolがある場合は、それに応じてロード・バランサーのタイムアウトも延長してください。

POSTGRES_SSL_ENABLED

RetoolのPostgres DBへのSSL接続を強制するには、trueに設定します。

CUSTOM_RETOOL_SANDBOX_RESTRICTIONS

RetoolのJavascriptのサンドボックス制限をカスタマイズします。例えば、RetoolのRun JSクエリーからのダウンロードを有効にするには、これをallow-downloadsに設定します。現在は、allow-popupsallow-downloads、およびallow-modalsのみがサポートされています(複数の制限を有効にするには、スペースで区切ります)。注意: セキュリティへの影響に問題がない場合のみ、この環境変数を設定するようにしてください。

HIDE_ALL_HEADERS_IN_AUDIT_LOG_EVENTS

監査ログのエントリーにすべてのクエリー・ヘッダー(Cookieを含む)が追加されないようにします。

CUSTOM_OAUTH2_SSO_ACCESS_TOKEN_LIFESPAN_MINUTES

分単位で値を指定します。Custom OpenIdプロバイダーにより%USER_OAUTH2_ACCESS_TOKEN%などの変数へのアクセス時に使用される、カスタム・トークン存続期間を設定することができます。

POSTGRES_CUSTOM_SSL_CERT_PATH

Retool DBへの接続時にカスタム証明書を使用する必要がある場合に、この環境変数を設定します。

例えば、証明書が/var/data/certs/certificate.pemにマウントされているとします。
Dockerコンテナーで、この変数の値に
/var/data/certs
を使用します。

POSTGRES_CUSTOM_SSL_CERT_FILE_NAME
POSTGRES_CUSTOM_SSL_KEY_FILE_NAME
POSTGRES_CUSTOM_SSL_CA_FILE_NAME

Google Cloud SQLをRetool DBとして使用する場合は、これら3つがすべて必要です。