basforge

Ищем по названиям, тексту и разборам «Если не работает».

    EN

    Короткий конфиг — прямо в compose: configs с content

    Конфиг в десяток строк держим в самом compose-файле — configs: с content:, и переменные из .env подставляются в него сами. После правки текста нужен up -d --force-recreate: обычный up -d правку не замечает.

    Зачем

    Короткий конфиг nginx обычно держат отдельным файлом рядом с compose.yaml и монтируют в контейнер:

    services:
      web:
        image: nginx:1.29-alpine
        volumes:
          - ./site.conf:/etc/nginx/conf.d/default.conf:ro

    Этот файл compose не читает, он только передаёт его в контейнер. Поэтому переменные из .env в нём не работают: в server_name ${DOMAIN}; подставлять значение некому, а сам nginx переменных окружения в конфиге не понимает. Домен приходится вписывать в файл руками на каждом сервере, и эта правка потом мешает git pull.

    Текст в content: — часть самого compose-файла. Compose подставляет в него переменные так же, как в image: или ports: («Обязательные переменные compose»): конфиг один на все серверы и лежит в git, а домен у каждого сервера свой, в .env. У образа nginx есть и свой способ — шаблоны в /etc/nginx/templates/, — а content работает с любой программой.

    Как пишем

    Текст конфига — в разделе configs: в конце файла. У сервиса — ссылка на него и путь в контейнере:

    services:
      web:
        image: nginx:1.29-alpine
        configs:
          - source: site                            # имя из раздела configs
            target: /etc/nginx/conf.d/default.conf  # куда положить в контейнере
    
    configs:
      site:
        content: |
          server {
              listen 80;
              server_name ${DOMAIN};
              root /usr/share/nginx/html;
          }

    С DOMAIN=example.org в .env в контейнере появится /etc/nginx/conf.d/default.conf со строкой server_name example.org;.

    Этот файл compose кладёт в контейнер копией, когда создаёт контейнер, — без монтирования, только для чтения (-r--r--r--, владелец root). Вариант file: ./site.conf вместо content — снова монтирование отдельного файла, со всеми его ловушками («Монтирование отдельного файла»), и переменные в нём не подставляются.

    Знак $ в конфиге — двойной

    У nginx свои переменные, тоже со знаком $: $uri, $host, $remote_addr. Compose считает своей любую $ в compose-файле, в том числе внутри content: на месте $uri он подставит пустую строку и предупредит The "uri" variable is not set. Чтобы знак дошёл до nginx, пишем его дважды. $$ compose превращает в один $ и больше не трогает («Знак $»):

    configs:
      site:
        content: |
          server {
              listen 80;
              server_name ${DOMAIN};
              root /usr/share/nginx/html;
              location / {
                  try_files $$uri $$uri/ /index.html;
              }
          }

    В контейнер уйдёт try_files $uri $uri/ /index.html;, а ${DOMAIN} строкой выше compose по-прежнему заменит значением из .env.

    После правки — пересоздать

    up -d пересоздаёт контейнер, только когда изменилось описание сервиса («Хэш конфига compose»). Текст content в это описание не входит: поправили конфиг — up -d отвечает Running, а в контейнере лежит старая копия. Пересоздаём явно:

    docker compose up -d --force-recreate web

    Если вместе с конфигом поменялось что-то в самом сервисе — образ, переменная, — контейнер пересоздастся и возьмёт новый текст без флага.

    Если не работает

    Поправили content, up -d пишет Running, а nginx отдаёт старое

    Причина
    Текст content не входит в описание сервиса, по которому up -d решает, пересоздавать ли контейнер. Compose считает, что менять нечего, и в контейнере остаётся старая копия.
    Делаем
    docker compose up -d --force-recreate web.

    В конфиге пусто на месте $uri, а при запуске — The "uri" variable is not set

    Причина
    Compose принял $uri за свою переменную и подставил пустую строку.
    Делаем
    Переменные nginx пишем с двумя знаками: $$uri, $$host. В контейнер уйдёт один.

    Как проверить

    Что лежит в контейнере и принимает ли это nginx:

    docker compose exec web cat /etc/nginx/conf.d/default.conf
    docker compose exec web nginx -t
    # nginx: configuration file /etc/nginx/nginx.conf test is successful