Список предопределенных переменных среды Compose

В этом разделе вы можете найти список предопределенных переменных среды, которые вы можете использовать для настройки поведения командной строки Docker Compose.

См. также Объявление переменных среды по умолчанию в файле, чтобы проверить, как объявить переменные среды по умолчанию в файле среды с именем .env, расположенном в каталоге проекта.

COMPOSE_PROJECT_NAME

Задаёт имя проекта. Это значение добавляется вместе с именем службы к имени контейнера при запуске.

Например, если имя вашего проекта myapp и он включает две службы db и web, Compose запускает контейнеры с именами myapp-db-1 и myapp-web-1 соответственно.

  • По умолчанию: basename каталога проекта.

См. также обзор параметров командной строки и использование -p для указания названия проекта.

COMPOSE_FILE

Указывает путь к файлу Compose. Поддерживается указание нескольких файлов Compose.

  • Поведение по умолчанию: Если не указано, Compose ищет файл с именем compose.yaml или docker-compose.yaml в текущем каталоге и, если он не найден, Compose выполняет рекурсивный поиск в каждом родительском каталоге, пока не будет найден файл с таким именем.

  • Разделитель по умолчанию: При указании нескольких файлов Compose разделители путей по умолчанию включены:

    • Mac и Linux: : (двоеточие),

    • Windows: ; (точка с запятой).

Разделитель путей также можно настроить с помощью COMPOSE_PATH_SEPARATOR. Пример: COMPOSE_FILE=docker-compose.yml:docker-compose.prod.yml. См. также обзор параметров командной строки и использование -f для указания имени и пути одного или нескольких Создание файлов.

COMPOSE_PROFILES

Указывает один или несколько профилей, которые должны быть включены при выполнении compose up. Службы с соответствующими профилями запускаются , а также любые службы, для которых не был определён профиль.

Например, при вызове docker compose up с COMPOSE_PROFILES=frontend выбираются службы с профилем frontend, а также любые службы без указанного профиля.

  • Разделитель по умолчанию: указывает список профилей, используя запятую в качестве разделителя. Пример: COMPOSE_PROFILES=frontend,debug В этом примере будут включены все службы, соответствующие профилям frontend и debug и службы без профиля.

См. также Использование профилей с Compose и --profile параметр командной строки.

DOCKER_HOST

Задаёт URL-адрес демона Docker. * По умолчанию: unix:///var/run/docker.sock (так же, как в клиенте Docker).

DOCKER_TLS_VERIFY

См. DOCKER_TLS_VERIFY на странице Использование командной строки Docker.

DOCKER_CERT_PATH

Настраивает путь к файлам ca.pem, cert.pem и key.pem, используемым для проверки TLS. По умолчанию: ~/.docker.

См. DOCKER_CERT_PATH на странице Использование командной строки Docker.

COMPOSE_CONVERT_WINDOWS_PATHS

Если данный параметр включён, Compose выполняет преобразовывает пути из стиля Windows в стиль Unix в определениях томов.

  • Поддерживаемые значения:

    • true или 1, чтобы включить,

    • false или 0, чтобы отключить.

  • По умолчанию: 0.

COMPOSE_PATH_SEPARATOR

Задаёт другой разделитель пути для элементов, перечисленных в COMPOSE_FILE.

  • По умолчанию:

    • На Mac и Linux — :,

    • В Windows до ;.

COMPOSE_IGNORE_ORPHANS

Если данный параметр включён, Compose не пытается обнаружить потерянные контейнеры для проекта.

  • Поддерживаемые значения:

    • true или 1, чтобы включить,

    • false или 0, чтобы отключить.

  • По умолчанию: 0.

Устарело в Compose v2

Важно

Перечисленные далее переменные среды устарели в v2.

COMPOSE_API_VERSION

Устарело в v2. По умолчанию версия API согласовывается с сервером. Используйте DOCKER_API_VERSION. См. DOCKER_API_VERSION на странице Использование командной строки Docker.

COMPOSE_HTTP_TIMEOUT

Устарело в v2.

COMPOSE_TLS_VERSION

Устарело в v2.

COMPOSE_FORCE_WINDOWS_HOST

Устарело в v2.

COMPOSE_PARALLEL_LIMIT

Устарело в v2.

COMPOSE_INTERACTIVE_NO_CLI

Устарело в v2. Поскольку v2 теперь использует код поставщика Докер CLI.

COMPOSE_DOCKER_CLI_BUILDx

Устарело в v2. Используйте DOCKER_BUILDKIT, чтобы выбрать между BuildKit и классическим компоновщиком. Если DOCKER_BUILDKIT=0, то docker build использует классический построитель для создания образов.