Skip to content

feat(docs): Explain configuration file location for Docker Compose #24989

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.

Sign up for GitHub

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

Open
keunes wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −0
Open

feat(docs): Explain configuration file location for Docker Compose #24989

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/docs/install/config-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,3 +254,14 @@ For more information, refer to the [Environment Variables](/install/environment-
:::tip
YAML-formatted config files are also supported.
:::

:::info Docker Compose
In your `.env` file, the variables `UPLOAD_LOCATION` and `DB_DATA_LOCATION` concern the location on the host. However, the variable `IMMICH_CONFIG_FILE` concerns the location inside the container, and informs the `immich-server` container that a configuration file is present.

It is recommended to reuse this variable in your `docker-compose.yml`:
```
volumes:
...
- ./configuration.yml:${IMMICH_CONFIG_FILE}
```
::
Loading