実践的な設定
ここでは、実際の開発・運用で役立つ追加の設定項目を紹介します。
1. env_file(環境変数ファイル)
これまでの例では、パスワードなどの環境変数をcompose.yamlに直接記述していました。しかし、この方法には問題があります。compose.yamlをチームで共有したり、バージョン管理システムに保存したりすると、パスワードも一緒に共有されてしまいます。
env_fileを使用すると、環境変数を別のファイルに分離できます。機密情報をcompose.yamlから切り離すことで、設定ファイルを安全に共有できるようになります。
1.1 環境変数ファイルの作成
一般的な方法として、compose.yamlと同じディレクトリに.envという名前のファイルを作成し、そこに環境変数を記述します。ファイル名の先頭にドット(.)が付いているのは、「隠しファイル」であることを示す慣習です。
.envファイルの例:
MYSQL_ROOT_PASSWORD=rootpassword
MYSQL_DATABASE=appdb
MYSQL_USER=appuser
MYSQL_PASSWORD=apppassword
このように、変数名=値の形式で環境変数を1行ずつ記述します。
1.2 compose.yamlでの参照
compose.yamlでは、env_fileを使ってこのファイルを参照します。
services:
db:
image: mysql:8.0
env_file:
- .env
この設定により、.envファイルに記述されたすべての環境変数がdbサービスに渡されます。environmentで個別に指定する必要がなくなり、compose.yamlにパスワードを直接書かずに済みます。
| 💡 ポイント |
|---|
.envファイルにはパスワードなどの機密情報が含まれます。このファイルは各自のマシンで作成し、チームメンバーには共有しないようにしましょう。代わりに.env.exampleのようなテンプレートファイル(値を空にしたもの)を用意し、「このような環境変数が必要です」という一覧を共有するのが一般的です。 |
2. restart(再起動ポリシー)
restartは、コンテナが停止した際の再起動ポリシーを設定します。本番環境やサーバ上でコンテナを常時稼働させたい場合に重要です。
services:
api:
build: ./api
restart: unless-stopped
利用可能な再起動ポリシーは以下のとおりです。
| ポリシー | 説明 |
|---|---|
| no | 再起動しない(デフォルト) |
| always | 常に再起動する(手動で停止しても再起動) |
| on-failure | 異常終了時のみ再起動(終了コードが0以外) |
| unless-stopped | 手動で停止するまで常に再起動する |
開発環境ではno(デフォルト)、本番環境ではunless-stoppedまたはalwaysを使用することが多いです。
3. docker compose watch(ファイル監視)
docker compose watchは、ソースコードの変更を監視し、自動的にコンテナを更新する機能です。開発時のワークフローを効率化できます。
services:
api:
build: ./api
develop:
watch:
- action: sync
path: ./api/src
target: /app/src
- action: rebuild
path: ./api/requirements.txt
この設定では以下の動作をします。
| action | 説明 |
|---|---|
| sync | 指定したパスのファイル変更を、コンテナ内のtargetにリアルタイムで同期 |
| rebuild | 指定したファイルが変更されたら、イメージを再ビルド |
ファイル監視を開始するには、以下のコマンドを実行します。
docker compose watch
これにより、ソースコードを変更するたびに手動で再起動やリビルドをする必要がなくなります。
3.1 バインドマウントとの違い
syncの動作は、前述のバインドマウント(volumesでホストのディレクトリをマウントする方法)と似ていますが、いくつかの違いがあります。
| 項目 | バインドマウント | docker compose watch (sync) |
|---|---|---|
| 仕組み | ホストのディレクトリを直接マウント | ファイル変更を検知してコピー |
| 同期方向 | 双方向(ホスト↔コンテナ) | 一方向(ホスト→コンテナ) |
| コンテナ内の変更 | ホストにも反映される | ホストには反映されない |
バインドマウントは手軽ですが、コンテナ内で生成されるファイル(ビルド成果物やキャッシュなど)がホスト側に作成されることがあります。docker compose watchを使うと、ホストとコンテナのファイル構成を分離しつつ、開発時の変更を反映できます。
どちらを使うべきか?
多くの開発シーンでは、シンプルなバインドマウントで十分です。以下を参考に選択してください。
- HTMLやCSS、設定ファイルなど、変更を即座に反映させたいだけの場合は、シンプルで設定も簡単なバインドマウントが向いています
- Pythonの
__pycache__(バイトコードキャッシュ)のように、コンテナ内で生成されるファイルをホストに反映させたくない場合や、ファイル変更時に自動でリビルドさせたい場合は、docker compose watchが便利です
一般的な用途であれば、まずバインドマウントで十分です。開発を進める中で不都合が出てきたら、docker compose watchを検討してみてください。