2
[Feature] Improve installation documentation
Source: immich-app/immich#2537 · opened by @uhthomas
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.
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.
No pledges yet. Be the first to back this.
Comments
Similar requests
[Feature] Adding a README file in a new installation
1 vote · 0 comments
[Feature] Block Google Cast installation-wide
1 vote · 0 comments
[Feature] Update on documentation change
2 votes · 0 comments
[Feature] Add HAProxy with SSL Offload to the documentation on [Administration > Reverse Proxy] section
2 votes · 0 comments
[Feature] Add Synology NAS documentation
5 votes · 0 comments
No comments yet.