設定 Docker Compose 中的預先定義環境變數

Docker Compose 包含幾個預先定義的環境變數。它也會繼承通用的 Docker CLI 環境變數，例如 DOCKER_HOST 和 DOCKER_CONTEXT。詳情請參閱 Docker CLI 環境變數參考。

本頁說明如何設定或變更下列預先定義的環境變數

• COMPOSE_PROJECT_NAME
• COMPOSE_FILE
• COMPOSE_PROFILES
• COMPOSE_CONVERT_WINDOWS_PATHS
• COMPOSE_PATH_SEPARATOR
• COMPOSE_IGNORE_ORPHANS
• COMPOSE_REMOVE_ORPHANS
• COMPOSE_PARALLEL_LIMIT
• COMPOSE_ANSI
• COMPOSE_STATUS_STDOUT
• COMPOSE_ENV_FILES
• COMPOSE_DISABLE_ENV_FILE
• COMPOSE_MENU
• COMPOSE_EXPERIMENTAL
• COMPOSE_PROGRESS

覆寫方法

在變更或設定任何環境變數時，請留意環境變數優先順序。

設定細節

專案與檔案設定

COMPOSE_PROJECT_NAME

設定專案名稱。此值在啟動時會與服務名稱一同置於容器名稱之前。

例如，如果您的專案名稱是 myapp，且包含 db 和 web 兩個服務，則 Compose 會啟動分別名為 myapp-db-1 和 myapp-web-1 的容器。

Compose 可以透過不同方式設定專案名稱。各方法的優先順序（由高至低）如下：

1. -p 命令列旗標
2. COMPOSE_PROJECT_NAME
3. 來自設定檔的頂層 name: 變數（或透過 -f 指定的一系列設定檔中的最後一個 name:）
4. 包含設定檔（或透過 -f 指定的第一個設定檔）之專案目錄的 basename
5. 如果未指定設定檔，則為目前目錄的 basename

專案名稱必須僅包含小寫字母、十進位數字、連字號和底線，並且必須以小寫字母或十進位數字開頭。如果專案目錄或目前目錄的 basename 違反此限制，您必須使用其他機制之一。

另請參閱命令列選項總覽以及使用 -p 指定專案名稱。

COMPOSE_FILE

指定 Compose 檔案的路徑。支援指定多個 Compose 檔案。

• 預設行為：如果未提供，Compose 會在目前目錄中尋找名為 compose.yaml 的檔案；如果找不到，Compose 會遞迴地搜尋每個父目錄，直到找到該名稱的檔案為止。
• 指定多個 Compose 檔案時，預設的路徑分隔符為：

  • Mac 和 Linux：: (冒號)

  • Windows：; (分號)。例如：

    COMPOSE_FILE=compose.yaml:compose.prod.yaml
    

  路徑分隔符也可以使用 COMPOSE_PATH_SEPARATOR 自訂。

另請參閱命令列選項總覽以及使用 -f 指定一個或多個 Compose 檔案的名稱與路徑。

COMPOSE_PROFILES

指定執行 docker compose up 時要啟用的一個或多個設定檔（profile）。

具有相符設定檔的服務會啟動，未定義任何設定檔的服務也會啟動。

例如，呼叫 docker compose up 時帶入 COMPOSE_PROFILES=frontend，會選擇具有 frontend 設定檔的服務，以及未指定設定檔的服務。

若指定多個設定檔，請使用逗號作為分隔符。

下列範例會啟用所有符合 frontend 和 debug 設定檔的服務，以及沒有設定檔的服務。

COMPOSE_PROFILES=frontend,debug

另請參閱在 Compose 中使用設定檔以及--profile 命令列選項。

COMPOSE_PATH_SEPARATOR

為列於 COMPOSE_FILE 中的項目指定不同的路徑分隔符。

• 預設為：
• 在 macOS 和 Linux 上為 :
• 在 Windows 上為 ;

COMPOSE_ENV_FILES

如果未使用 --env-file，指定 Compose 應該使用的環境檔案。

使用多個環境檔案時，請使用逗號作為分隔符。例如：

COMPOSE_ENV_FILES=.env.envfile1,.env.envfile2

如果未設定 COMPOSE_ENV_FILES，且您在 CLI 中未提供 --env-file，Docker Compose 將採用預設行為，即在專案目錄中尋找 .env 檔案。

COMPOSE_DISABLE_ENV_FILE

讓您可以停用預設 .env 檔案的使用。

• 支援的值：
• true 或 1，Compose 會忽略 .env 檔案
• false 或 0，Compose 會在專案目錄中尋找 .env 檔案