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

[BUG] Improve installation documentation #882

New Issue
Closed
opened 2026-02-04 23:16:25 +03:00 by OVERLORD · 0 comments
OVERLORD commented 2026-02-04 23:16:25 +03:00
Owner
Copy Link

Originally created by @uhthomas on GitHub (May 23, 2023).

The bug

The architecture documentation is fine and provides a good insight into how immich works at a high level, but it's difficult to deploy the service beyond the standard suggestions.

In my case, I'm deploying Immich in Kubernetes. The official Helm chart and docker-compose examples share all environment variables across all containers, even if they're not needed. I like to keep things minimal and trying to figure out whether a need access to the JWT secret, for instance, is tricky. I've found myself looking through the code to figure it out.

I think the best thing to do would be to provide some sort of documentation which lists the services and which environment variables they require. In addition, cleaning up the docker-compose example and Helm chart to use only the environment variables they need would be great. It should also be noted this extends beyond just environment variables, documentation on volume mounts and ports would be really helpful too.

The OS that Immich Server is running on

N/A

Version of Immich Server

N/A

Version of Immich Mobile App

N/A

Platform with the issue

  • Server
  • Web
  • Mobile

Your docker-compose.yml content

N/A

Your .env content

N/A

Reproduction steps

N/A

Additional information

No response

Originally created by @uhthomas on GitHub (May 23, 2023). ### The bug The [architecture documentation](https://immich.app/docs/developer/architecture) is fine and provides a good insight into how immich works at a high level, but it's difficult to deploy the service beyond the [standard suggestions](https://immich.app/docs/install/requirements). In my case, I'm deploying [Immich in Kubernetes](https://github.com/uhthomas/automata/tree/1d4e3cd516452d96abed753123f8c466ac69fc7d/k8s/unwind/immich). The official Helm chart and docker-compose examples share all environment variables across all containers, even if they're not needed. I like to keep things minimal and trying to figure out whether a need access to the JWT secret, for instance, is tricky. I've found myself looking through the code to figure it out. I think the best thing to do would be to provide some sort of documentation which lists the services and which environment variables they require. In addition, cleaning up the docker-compose example and Helm chart to use only the environment variables they need would be great. It should also be noted this extends beyond just environment variables, documentation on volume mounts and ports would be really helpful too. ### The OS that Immich Server is running on N/A ### Version of Immich Server N/A ### Version of Immich Mobile App N/A ### Platform with the issue - [ ] Server - [ ] Web - [ ] Mobile ### Your docker-compose.yml content ```YAML N/A ``` ### Your .env content ```Shell N/A ``` ### Reproduction steps ```bash N/A ``` ### Additional information _No response_
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
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#882
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?