h23w_01-backend

23 冬ハッカソンチーム 01 バックエンド

環境変数

DB設定

名前	値
MYSQL_USER	MySQLのユーザー名。DockerイメージのMYSQL_USERと対応
MYSQL_PASSWORD	MySQLのユーザー パスワード。DockerイメージのMYSQL_PASSWORDと対応
MYSQL_HOSTNAME	MySQLサーバーのホスト名。localhostなど
MYSQL_PORT	MySQLサーバーのポート。3306など
MYSQL_DATABASE	MySQLサーバーのデータベース名。DockerイメージのMYSQL_DATABASEと対応
MIGRATION	アプリ起動時に行うMigrationの設定。up, down, refresh, noneのいずれか。デフォルトはnoneで何も行わない

※ MYSQL_*の環境変数が見つからなければNS_MARIADB_*の環境変数も探索される。(NeoShowcase対応)

traQ BOTの設定

名前	値
BOT_ACCESS_TOKEN	traQ BOTのAccess Token
VERIFICATION_TOKEN	traQ BOTのVerification Token

その他

名前	値
ALLOWED_ORIGINS	CORSでAccess-Control-Allow-Originに含めるOriginのリスト。空白区切り
ALLOW_CREDENTIALS	(optional)CORSでAccess-Control-Allow-Credentialsに含める値。trueまたはfalse, デフォルトはtrue
ALLOWED_METHODS	(optional)CORSでAccess-Control-Allow-Methodsに含めるHTTPメソッドのリスト。空白区切り
ALLOWED_HEADERS	(optional)CORSでAccess-Control-Allow-Headersに含めるHTTPヘッダのリスト。空白区切り
CHECK_AUTH	主要なエンドポイントでX-Forwarded-Userによるユーザーの確認を行うかどうか。trueまたはfalse

値の例は.env.devを参照

docker compose

docker compose --env-file .env.dev up -d

このコマンドでバックエンドアプリが立ち上がる。ポートとコンテナの対応は以下の通り

• MariaDB :3306
• Adminer :8080
• アプリ :8000

migration の手順

• up

DATABASE_URL=mysql://... sea-orm-cli migrate up

• down

DATABASE_URL=mysql://... sea-orm-cli migrate down