メインコンテンツまでスキップ

設定

環境変数

使い方

Logto は環境変数を次の順序で処理します:

  • システム環境変数
  • プロジェクトルートの .env ファイル( dotenv 形式に準拠)

したがって、システム環境変数が .env の値を上書きします。

変数

注意:

プロジェクトルートで npm start を使用して Logto を実行する場合、NODE_ENV は常に production になります。

デフォルト値では、protocol は HTTPS 設定に応じて http または https になります。

Keyデフォルト値説明
NODE_ENVundefined'production' | 'test' | undefinedLogto が実行される環境の種類。
PORT3001numberLogto がリッスンするローカルポート。
ADMIN_PORT3002numberLogto 管理コンソールがリッスンするローカルポート。
ADMIN_DISABLE_LOCALHOSTN/Astring | boolean | number管理コンソール用のポートを無効にするには 1 または true を設定します。ADMIN_ENDPOINT が未設定の場合、管理コンソールが完全に無効になります。
DB_URLN/AstringLogto データベース用の Postgres DSN
HTTPS_CERT_PATHundefinedstring | undefined詳細は HTTPS の有効化 を参照してください。
HTTPS_KEY_PATHundefinedstring | undefined同上。
TRUST_PROXY_HEADERfalseboolean同上。
ENDPOINT'protocol://localhost:$PORT'stringオンラインテストや本番用にカスタムドメインの URL を指定できます。これにより OIDC 発行者識別子 の値も影響を受けます。
ADMIN_ENDPOINT'protocol://localhost:$ADMIN_PORT'string本番用にカスタムドメインの URL を指定できます(例:ADMIN_ENDPOINT=https://admin.domain.com)。これにより管理コンソールのリダイレクト URI の値も影響を受けます。
CASE_SENSITIVE_USERNAMEtruebooleanユーザー名が大文字小文字を区別するかどうかを指定します。この値を変更する際は注意してください。既存のデータベースデータは自動的に調整されないため、手動で管理する必要があります。
SECRET_VAULT_KEKundefinedstringSecret Vault でデータ暗号化キー (DEK) を暗号化するために使用されるキー暗号化キー (KEK)。Secret Vault を正しく機能させるために必須です。base64 エンコードされた文字列である必要があります。AES-256(32 バイト)推奨。例:crypto.randomBytes(32).toString('base64')

HTTPS の有効化

Node を使用する場合

Node はネイティブで HTTPS をサポートしています。Node で HTTPS を有効にするには、HTTPS_CERT_PATHHTTPS_KEY_PATH両方 を指定してください。

HTTPS_CERT_PATH は HTTPS 証明書のパス、HTTPS_KEY_PATH は HTTPS キーのパスを意味します。

HTTPS プロキシを使用する場合

もう一つの一般的な方法は、Node の前段に HTTPS プロキシ(例:Nginx)を配置することです。

この場合、TRUST_PROXY_HEADERtrue に設定することを推奨します。これはプロキシヘッダーフィールドを信頼するかどうかを示します。Logto はこの値を Koa アプリ設定 に渡します。

このフィールドを設定するタイミングについては TLS オフロードプロキシの信頼 を参照してください。

データベース設定

環境変数が多すぎると管理が非効率かつ柔軟性に欠けるため、一般的な設定の多くはデータベーステーブル logto_configs に保存されています。

このテーブルはシンプルなキー・バリュー型ストレージであり、キーは以下のように列挙可能です:

Key説明
oidc.cookieKeysstring[]署名クッキーキー の文字列配列。
oidc.privateKeysstring[]OIDC JWT 署名 用の秘密鍵内容の文字列配列。

サポートされている秘密鍵タイプ

  • EC(P-256、secp256k1、P-384、P-521 曲線)
  • RSA
  • OKP(Ed25519、Ed448、X25519、X448 サブタイプ)