Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add note on vhost.d files with acme-companion #2036

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -431,10 +431,14 @@ If you are using multiple hostnames for a single container (e.g. `VIRTUAL_HOST=e
ln -s /path/to/vhost.d/www.example.com /path/to/vhost.d/example.com
```

**NOTE**: If you use the [acme-companion](https://github.com/nginx-proxy/acme-companion) companion container, configuration files mounted in `/etc/nginx/vhost.d` will be appended by the container. Appended files contain an extra location, for ACME challenges, that should be left as-is.

#### Per-VIRTUAL_HOST default configuration

If you want most of your virtual hosts to use a default single configuration and then override on a few specific ones, add those settings to the `/etc/nginx/vhost.d/default` file. This file will be used on any virtual host which does not have a `/etc/nginx/vhost.d/{VIRTUAL_HOST}` file associated with it.

**NOTE**: If you use the [acme-companion](https://github.com/nginx-proxy/acme-companion) companion container, configuration files mounted in `/etc/nginx/vhost.d` will be appended by the container. Appended files contain an extra location, for ACME challenges, that should be left as-is.

#### Per-VIRTUAL_HOST location configuration

To add settings to the "location" block on a per-`VIRTUAL_HOST` basis, add your configuration file under `/etc/nginx/vhost.d` just like the previous section except with the suffix `_location`.
Expand Down