設定オプション

設定オプション

設定ファイル

環境変数は、Superfast プロジェクト内のすべての設定に使用されます。

.env

Superfast は、環境変数として.env ファイル設定を読み込もうとします。これは次のような構造になっています。

DB_CLIENT="sqlite3"
DB_FILENAME="./data.db"
MIGRATE_EXTENSIONS=".js"

General

変数名説明初期値
SERVER_URLExpressサーバー URLhttp://localhost:4000
SERVER_HOSTExpressサーバー ホストhttp://localhost
SERVER_PORTApp Server ポート4000
ADMIN_PORTApp Admin ポート4001

Express

変数名説明初期値
REQ_LIMITリクエストボディの最大サイズ4mb

Database

変数名説明初期値
DB_CLIENTDatabase クライアント(sqlite3)sqlite3
DB_FILENAMEDatabase ファイルへのパス./data.db
MIGRATE_EXTENSIONSmigrations として扱うファイル拡張子.js (変更不可)

ハッシュ

変数名説明初期値
HASH_MEMORY_COSTハッシュを生成する際に使用するメモリ量を KiB 単位で指定します。4096 (4 MiB)
HASH_HASH_LENGTHハッシュ関数出力の長さをバイト数で指定します。32
HASH_TIME_COSTハッシュ関数が使用するパス数(反復回数)。計算に必要な時間を犠牲にして、ハッシュ強度を高めることができます。3
HASH_PARALLELISMハッシュを計算するスレッドの数。各スレッドは HASH_MEMORY_COST サイズのメモリプールを持つ。1 (single thread)
HASH_TYPEハッシュ関数の種類 (0: argon2d, 1: argon2i, または 2: argon2id).2 (argon2id)
HASH_ASSOCIATED_DATA追加オプションの非機密値。この値は、ダイジェストのパラメータ部分に Base64 でエンコードされた形で含まれます。--

セッション

変数名説明初期値
ACCESS_TOKEN_TTLアクセストークンの有効期間。8h
REFRESH_TOKEN_TTL(WIP)リフレッシュトークンの有効期間7d

シークレット

変数名説明初期値
SECRETJWT トークン生成時の秘密鍵ランダム

CORS

変数名説明初期値
CORS_ENABLEDCORS 設定全体を有効化するには true を設定します。false
CORS_ORIGINAccess-Control-Allow-Origin 文字列または正規表現で指定可能。false を指定して CORS を無効化できます。false
CORS_METHODSAccess-Control-Allow-Methods 許可するメソッドをカンマ区切りの文字列で渡します。GET,POST,PATCH,DELETE
CORS_ALLOWED_HEADERSAccess-Control-Allow-Headers 指定がない場合は、リクエストの Access-Control-Request-Headers ヘッダで指定されたヘッダを反映します。Content-Type,Authorization
CORS_EXPOSED_HEADERSAccess-Control-Expose-Headers 指定しない場合は、カスタムヘッダーは公開されません。Content-Range
CORS_CREDENTIALSAccess-Control-Allow-Credentials 有効化する場合は true を設定します。true
CORS_MAX_AGEAccess-Control-Max-Age ヘッダを渡す場合は整数値を指定します。1800

Log

変数名説明初期値
LOG_LEVELログの出力レベル(fatal, error, warn, info, debug, trace, silentinfo

Email

変数名説明初期値
EMAIL_TRANSPORTemail の送信プロバイダsendgrid
EMAIL_FROMemail の送信元メールアドレス--
EMAIL_SENDGRID_API_KEYsendgrid の API キー--