Update kubernetes.md to provide updated documentation

Instead of using an Umbrella Chart, we can simply hook into the common chart immich already uses, and just extend the server part of it.

The old guide was based on immich chart version 0.9, we are at 0.13.1 now. It also references bjw-s common version 1.4, where immich now uses version 5.0.1
This commit is contained in:
Thies
2026-08-06 17:12:50 +02:00
committed by GitHub
parent 28c84fe77b
commit ef1b05e88e
+71 -43
View File
@@ -1,62 +1,90 @@
# Install with Kubernetes # Install with Kubernetes
Thanks to [@vanchaxy](https://github.com/vanchaxy) for providing these docs in [#42](https://github.com/alangrainger/immich-public-proxy/issues/42). See the [official Immich docs](https://immich.app/docs/install/kubernetes/) for additional information. This deployment uses the common chart Immich depends on ([bjw-s common library chart](https://github.com/bjw-s-labs/helm-charts/tree/common-5.0.1/charts/library/common)) to extend the deployment as described in the [Immich docs](https://github.com/immich-app/immich-charts/blob/main/README.md)
See the [official Immich docs](https://immich.app/docs/install/kubernetes/) for additional information. 1. Simply modify the values of your immich deployment in the server section. The next example shows using the new Gateway API HTTPRoute, below you can also find the old Ingress version. This uses
1. Add `app-template` chart to the dependencies. It's important to use the same `app-template` version as immich (1.4.0) if installing under the same umbrella chart.
``` ```
apiVersion: v2 server:
name: immich enabled: true
version: 0.0.0
dependencies:
- name: immich
repository: https://immich-app.github.io/immich-charts
version: 0.9.0
- name: app-template
repository: https://bjw-s.github.io/helm-charts
version: 1.4.0
alias: immich-public-proxy
```
2. Add deployment and service to values.
```
immich:
# immich values
...
immich-public-proxy: route:
global:
nameOverride: public-proxy
env:
IMMICH_URL: http://immich-server:2283
image:
repository: alangrainger/immich-public-proxy
tag: 1.5.4
pullPolicy: IfNotPresent
service:
main: main:
enabled: true enabled: true
primary: true kind: HTTPRoute
parentRefs:
- name: gateway
namespace: kube-system
hostnames:
- your-immich-url.com
rules:
- backendRefs:
- name: immich-server-main
port: 2283
immich-public-proxy:
enabled: true
kind: HTTPRoute
parentRefs:
- name: gateway
namespace: kube-system
hostnames:
- your-proxy-url.com
rules:
- backendRefs:
- name: immich-server-immich-public-proxy
port: 3000
controllers:
immich-public-proxy:
containers:
main:
image:
repository: alangrainger/immich-public-proxy
tag: 3.2.0
pullPolicy: IfNotPresent
env:
IMMICH_URL: https://your-immich-url.com // You could also reference the service here
PUBLIC_BASE_URL: https://your-proxy-url.com
service:
immich-public-proxy:
controller: immich-public-proxy
type: ClusterIP type: ClusterIP
ports: ports:
http: http:
enabled: true
primary: true
port: 3000 port: 3000
protocol: HTTP
serviceMonitor: // We modify the ServiceMonitor here, as the bjw-s common chart can get confused with more than 1 service (main and immich-public-proxy)
main:
enabled: false // Set to true if you need metrics
service:
identifier: main
```
Or with Ingress
```
server:
enabled: true
ingress: ingress:
main: main:
enabled: true enabled: true
hosts: hosts:
- host: &host-share immich-share.local - host: your-immich-url.com
paths: paths:
- path: "/" - path: /
tls: pathType: Prefix
- secretName: immich-share-tls service:
identifier: main
immich-public-proxy:
enabled: true
hosts: hosts:
- *host-share - host: your-proxy-url.com
paths:
- path: /
pathType: Prefix
service:
identifier: immich-public-proxy
...
``` ```