immich-app/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2026-07-15 21:32:32 +03:00
Code Issues 783 Packages Projects Releases 22 Wiki Activity

[PR #24989] feat(docs): Explain configuration file location for Docker Compose #18030

New Issue
Open
opened 2026-02-05 16:31:28 +03:00 by OVERLORD · 0 comments
OVERLORD commented 2026-02-05 16:31:28 +03:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/immich-app/immich/pull/24989
Author: @keunes
Created: 1/3/2026
Status: 🔄 Open

Base: main ← Head: patch-1

📝 Commits (1)

  • abaeaf4 Explain configuration file location for Docker Compose

📊 Changes

1 file changed (+11 additions, -0 deletions)

View changed files

📝 docs/docs/install/config-file.md (+11 -0)

📄 Description

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?

  • ✅ Test A: IMMICH_CONFIG_FILE specifies the location of the config file as needed by the server application, and on the host any location is picked via the volume declaration.
  • ❌ Test B: IMMICH_CONFIG_FILE specifies the location of the config file on the host, and on the server side the location /data/configuration.yml is set via the volume declaration.

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation if applicable
  • I have no unrelated changes in the PR.
  • I have confirmed that any new dependencies are strictly necessary.
  • I have written tests for new code (if applicable)
  • I have followed naming conventions/patterns in the surrounding code
  • All code in src/services/ uses repositories implementations for database calls, filesystem operations, etc.
  • All code in src/repositories/ is pretty basic/simple and does not have any immich specific logic (that belongs in src/services/)

Please describe to which degree, if any, an LLM was used in creating this pull request.

Not used.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/immich-app/immich/pull/24989 **Author:** [@keunes](https://github.com/keunes) **Created:** 1/3/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `patch-1` --- ### 📝 Commits (1) - [`abaeaf4`](https://github.com/immich-app/immich/commit/abaeaf4f987eb843c9dd132ba951d8f10e736853) Explain configuration file location for Docker Compose ### 📊 Changes **1 file changed** (+11 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `docs/docs/install/config-file.md` (+11 -0) </details> ### 📄 Description ## 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? - ✅ Test A: `IMMICH_CONFIG_FILE` specifies the location of the config file as needed by the server application, and on the host any location is picked via the volume declaration. - ❌ Test B: `IMMICH_CONFIG_FILE` specifies the location of the config file on the host, and on the server side the location `/data/configuration.yml` is set via the volume declaration. ## Checklist: - [x] I have performed a self-review of my own code - [ ] I have made corresponding changes to the documentation if applicable - [x] I have no unrelated changes in the PR. - [ ] I have confirmed that any new dependencies are strictly necessary. - [ ] I have written tests for new code (if applicable) - [ ] I have followed naming conventions/patterns in the surrounding code - [ ] All code in `src/services/` uses repositories implementations for database calls, filesystem operations, etc. - [ ] All code in `src/repositories/` is pretty basic/simple and does not have any immich specific logic (that belongs in `src/services/`) ## Please describe to which degree, if any, an LLM was used in creating this pull request. Not used. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
OVERLORD added the pull-request label 2026-02-05 16:31:28 +03:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
accessibility
changelog:enhancement
changelog:security
changelog:skip
changelog:translation
cli
date-time
dependencies
documentation
external-library
format
good first issue
mobile-beta
mobile-beta
mobile-beta
needs-answer
nice to have
pull-request
Mirrored from GitHub Pull Request
 sharing
tech-debt
📱mobile
🖥️web
🗄️server
🧠machine-learning
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
OVERLORD
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: immich-app/immich#18030
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?