環境変数構成
このドキュメントでは、ABC User FeedbackのAPIサーバーおよびウェブサーバーで使用する主要な環境変数と設定方法を説明します。
1. APIサーバー環境変数
必須環境変数
| 環境変数 | 説明 | デフォルト | 例 |
|---|---|---|---|
JWT_SECRET | JWT署名用シークレットキー | なし | jwtsecretjwtsecretjwtsecret |
MYSQL_PRIMARY_URL | MySQL接続URL | なし | mysql://user:pass@host:3306/db |
ACCESS_TOKEN_EXPIRED_TIME | Access Token有効期間 | 10m | 10m、30s、1h |
REFRESH_TOKEN_EXPIRED_TIME | Refresh Token有効期間 | 1h | 1h、7d |
JWTシークレットは十分に複雑で安全な文字列を使用する必要があります。
⚠️ セキュリティ注意事項：
JWT_SECRETは最低32文字以上の複雑な文字列を使用してください- 本番環境では絶対にデフォルト値を使用しないでください
- 環境変数ファイル（
.env）はバージョン管理に含めないでください - 機密情報は環境変数やシークレット管理システムを通じて管理してください
オプション環境変数
| 環境変数 | 説明 | デフォルト | 例 |
|---|---|---|---|
APP_PORT | APIサーバーポート | 4000 | 4000 |
APP_ADDRESS | バインドアドレス | 0.0.0.0 | 127.0.0.1 |
ADMIN_WEB_URL | 管理者ウェブURL | http://localhost:3000 | https://admin.company.com |
BASE_URL | Swaggerドキュメントで使用するAPIサーバーの公開URL | なし | https://api.example.com |
MYSQL_SECONDARY_URLS | セカンダリDB URL（JSON配列） | なし | ["mysql://..."] |
AUTO_MIGRATION | アプリ起動時のDB自動マイグレーション | true | false |
MASTER_API_KEY | マスター権限APIキー（オプション） | なし | abc123xyz |
NODE_OPTIONS | Node実行オプション | なし | --max_old_space_size=4096 |
SMTP設定（メール認証）
| 環境変数 | 説明 | 例 |
|---|---|---|
SMTP_HOST | SMTPサーバーアドレス | smtp.gmail.com |
SMTP_PORT | ポート（通常587または465） | 587 |
SMTP_USERNAME | ログインユーザー | user@example.com |
SMTP_PASSWORD | ログインパスワードまたはトークン | app-password |
SMTP_SENDER | 送信者アドレス | noreply@company.com |
SMTP_BASE_URL | メール内リンク用基本URL | https://feedback.company.com |
SMTP_TLS | TLS使用有無 | true |
SMTP_CIPHER_SPEC | 暗号化仕様 | TLSv1.2 |
SMTP_OPPORTUNISTIC_TLS | STARTTLSサポート有無 | true |
📎 詳細設定については、SMTP統合ガイドを参照してください。
2. OpenSearch設定（オプション）
| 環境変数 | 説明 | 例 |
|---|---|---|
OPENSEARCH_USE | OpenSearch有効化有無 | true |
OPENSEARCH_NODE | OpenSearchノードURL | http://localhost:9200 |
OPENSEARCH_USERNAME | 認証ID | admin |
OPENSEARCH_PASSWORD | 認証パスワード | admin123 |
OpenSearchは検索速度向上およびAI機能改善に使用されます。
3. 自動フィードバック削除設定
| 環境変数 | 説明 | デフォルト / 条件 |
|---|---|---|
AUTO_FEEDBACK_DELETION_ENABLED | 古いフィードバック削除機能有効化 | false |
AUTO_FEEDBACK_DELETION_PERIOD_DAYS | 削除基準日数 | 365（有効な場合必須） |
4. ウェブサーバー環境変数
必須環境変数
| 環境変数 | 説明 | 例 |
|---|---|---|
NEXT_PUBLIC_API_BASE_URL | クライアントで使用するAPIサーバーアドレス | http://localhost:4000 |
オプション環境変数
| 環境変数 | 説明 | デフォルト | 例 |
|---|---|---|---|
PORT | フロントエンドポート | 3000 | 3000 |
5. 設定方法
Docker Compose例
services:
api:
image: line/abc-user-feedback-api
environment:
- JWT_SECRET=changeme
- MYSQL_PRIMARY_URL=mysql://user:pass@mysql:3306/userfeedback
- SMTP_HOST=smtp.sendgrid.net
- SMTP_USERNAME=apikey
- SMTP_PASSWORD=your-sendgrid-key
.envファイル例
# apps/api/.env
JWT_SECRET=changemechangemechangeme
MYSQL_PRIMARY_URL=mysql://root:pass@localhost:3306/db
ACCESS_TOKEN_EXPIRED_TIME=10m
REFRESH_TOKEN_EXPIRED_TIME=1h
SMTP_HOST=smtp.example.com
SMTP_SENDER=noreply@example.com
# BASE_URL=https://api.example.com # リバースプロキシの後ろで提供する場合に設定
# apps/web/.env
NEXT_PUBLIC_API_BASE_URL=http://localhost:4000
7. トラブルシューティングガイド
| 問題 | 原因と解決策 |
|---|---|
| 環境変数が認識されない | .env位置確認またはコンテナ再起動 |
| DB接続失敗 | MYSQL_PRIMARY_URL形式または接続情報確認 |
| SMTPエラー | ポート/TLS設定または認証情報再確認 |
| OpenSearchエラー | ノードURLまたはユーザー認証確認 |
| JWTトークンエラー | JWT_SECRET長さおよび複雑性確認 |
| 環境変数検証失敗 | 必須環境変数欠落またはタイプエラー確認 |
| ポート競合 | APP_PORT、PORT設定確認 |