環境変数一覧
Keelson がアプリのコンテナに設定する環境変数の一覧です。いずれも keelson.yaml の env には書きません。KEELSON_ で始まる名前はプラットフォーム予約で、env / secrets には使えません。
常に設定されるもの
Section titled “常に設定されるもの”| 変数 | 内容 |
|---|---|
PORT | アプリが listen するポート。読むだけで、設定しない |
TZ | ワークスペースのタイムゾーン(例: Asia/Tokyo) |
KEELSON_MODE | keelson。「Keelson 上で動いているか」の判定に使う。ローカルでは未設定 |
KEELSON_APP_ID | アプリの内部 ID |
KEELSON_WORKSPACE_ID | ワークスペースの内部 ID |
KEELSON_TENANT_ID | KEELSON_WORKSPACE_ID の互換用別名(値は同じ) |
KEELSON_DEPLOY_ID | 現在のデプロイの内部 ID |
KEELSON_APP_URL | アプリの公開 URL(https://<ws>--<app>.keelson.run)。絶対 URL が必要な場面で使う。ホストを解決できる場合に設定される |
KEELSON_DIRECTORY_BASE_URL | Directory API のベース URL。Identity SDK が使う。KEELSON_APP_URL と同じ条件(ホストを解決できる場合)で設定される |
旧 tenant 名の変数も互換のため受け付けます。撤去時期は未定です。
機能を有効にすると設定されるもの
Section titled “機能を有効にすると設定されるもの”| 変数 | 条件 | 内容 |
|---|---|---|
KEELSON_DB_URL | db.mode: libsql | Managed SQLite の接続 URL |
KEELSON_DB_AUTH_TOKEN | db.mode: libsql | Managed SQLite の認証トークン |
TURSO_DATABASE_URL / TURSO_AUTH_TOKEN | db.mode: libsql | 上 2 つの別名(互換用) |
KEELSON_FILES_BUCKET / KEELSON_FILES_PREFIX | コンテナ型のデプロイで、ファイル保存先が構成されているとき(通常のデプロイでは自動) | Files SDK が使う保存先。直接は使わない |
KEELSON_INTERNAL_MEDIA_BASE_URL / KEELSON_APP_MEDIA_TOKEN | コンテナ型のデプロイで、Media 機能が有効なとき(通常のデプロイでは自動) | Media SDK が使うアップロード先と認証。直接は使わない |
KEELSON_MEDIA_URL_PREFIX | 上と同じ | Media の配信 URL プレフィックス(/__keelson/media/) |
KEELSON_DIRECTORY_TOKEN | keelson apps directory enable 後 | Directory API のトークン。Identity SDK が使う。サーバー側だけで扱う |
KEELSON_EMAIL_WEBHOOK_SECRET | email.inbound.enabled: true | 受信メール Webhook の署名シークレット。Email SDK の署名検証が使う |
KEELSON_EMAIL_API_URL / KEELSON_EMAIL_TOKEN | メール送信が有効なとき | Email SDK の送信先と認証。直接は使わない |
KEELSON_EMAIL_BASE_URL | メール送信が有効で、ホストを解決できるとき | Email SDK がゲートウェイ経由で送るときの接続先。直接は使わない |
静的サイト(command なし)にはコンテナがないので、これらの変数は注入されません。Files / Media / Email の SDK は静的サイトからは使えません。
設定されないもの
Section titled “設定されないもの”NODE_ENV— 自動では設定されません。keelson.yamlのenvで"production"を宣言してください- 外部 DB の接続情報 —
db.mode: noneのときは何も注入されません。シークレットで渡します
ローカル開発で使うもの
Section titled “ローカル開発で使うもの”SDK をローカルで動かすときの変数です。Keelson 上では設定しません。
| 変数 | 内容 |
|---|---|
KEELSON_FILES_DIR | Files SDK のローカル保存先(既定 ./.keelson/files) |
MEDIA_DIR | Media SDK のローカル保存先(既定 ./media) |
KEELSON_LOCAL_MODE=1 | Identity SDK をダミーデータで動かす |
KEELSON_LOCAL_USER_ID / KEELSON_LOCAL_USER_EMAIL / KEELSON_LOCAL_USER_NAME | ダミーユーザー |
KEELSON_LOCAL_WORKSPACE_ID / KEELSON_LOCAL_WORKSPACE_ROLE / KEELSON_LOCAL_APP_ID | ダミーのワークスペース・ロール・アプリ |
旧名の KEELSON_LOCAL_TENANT_ID と KEELSON_LOCAL_TENANT_ROLE も互換のため
受け付けます。撤去時期は未定です。
- 環境変数とシークレット — 自分で設定する値
- ファイルとメディア
- 認証情報をアプリで使う