設定
アクセスキーとデータベース への接続設定です。値が欠けているか無効な場合、起動は停止します。
Human Plugin は、起動時に一度だけ環境から設定を読み込みます。値を変更するには、コンテナの再起動が必要です。
クイックリファレンス
以下のデフォルト値を使用するデータベース向けの、最小限の .env です。
.env
HUMAN_API_ACCESS_KEY=<your access key>
POSTGRES_ADDRESS_HOST=<database host>
POSTGRES_PASSWORD=<database password>
アクセスキー
| 変数 | 必須 | 備考 |
|---|---|---|
HUMAN_API_ACCESS_KEY | はい | ア クセスキー。インストールを Unico に接続し、アカウントを識別します。空白文字や制御文字は使用できません。ログには出力されません |
アクセスキーは機密情報です。シークレットストアで管理し、実行時にコンテナへ注入してください。
データベース接続
| 変数 | 必須 | デフォルト | 備考 |
|---|---|---|---|
POSTGRES_ADDRESS_HOST | はい | PostgreSQL サーバーのホスト名または IP アドレス | |
POSTGRES_PASSWORD | はい | 空白文字、シングルクォート、バックスラッシュ、制御文字は使用できません。これらが含まれる場合、Human Plugin は値をログに出力せずに起動を拒否します | |
POSTGRES_ADDRESS_PORT | いいえ | 5432 | |
POSTGRES_USER | いいえ | postgres | Human Plugin 専用のロールを使用してください |
POSTGRES_DATABASE | いいえ | human_plugin | Human Plugin 専用のデータベースを使用してください |
POSTGRES_SSL_MODE | いいえ | require | disable は、PostgreSQL が同じホスト上、またはサイドカーとして動作している場合にのみ使用してください |
データベースは Human Plugin 専用にする必要があります。ロールには、データ ベース内にテーブルを作成する権限が必要です。Human Plugin は、リクエストを受け付ける前に、起動時に自身のテーブルを作成および更新します。
パスワードは機密情報です。アクセスキーと同様に、シークレットストアで管理してください。
その他すべて
その他の値はすべてイメージ側で設定されます。Unico から指示がない限り、他の変数は設定しないでください。サポートされる設定には含まれません。
例
docker run -d --name human-plugin --stop-timeout 60 -p 127.0.0.1:8080:8080 \
-e HUMAN_API_ACCESS_KEY \
-e POSTGRES_ADDRESS_HOST=db.internal \
-e POSTGRES_USER=human_plugin \
-e POSTGRES_PASSWORD \
pkg.unico.run/human-plugin-api:latest
値を指定しない -e NAME は、シェルから変数を引き渡すため、シークレットがコマンドラインに表示されません。