feat(docs): Explain configuration file location for Docker Compose #24989
+11
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
When setting up folder configuration as per https://docs.immich.app/install/config-file it wasn't clear how the configuration file should be mounted in Docker Compose. Also it was a bit confusing as different file/folder location-related variables are used in different ways.
This PR clarifies how this variable should be used icw Docker Compose.
How Has This Been Tested?
IMMICH_CONFIG_FILEspecifies the location of the config file as needed by the server application, and on the host any location is picked via the volume declaration.IMMICH_CONFIG_FILEspecifies the location of the config file on the host, and on the server side the location/data/configuration.ymlis set via the volume declaration.Checklist:
src/services/uses repositories implementations for database calls, filesystem operations, etc.src/repositories/is pretty basic/simple and does not have any immich specific logic (that belongs insrc/services/)Please describe to which degree, if any, an LLM was used in creating this pull request.
Not used.