You've already forked immich
mirror of
https://github.com/immich-app/immich.git
synced 2025-07-05 06:00:24 +02:00
94cd806675
* Update reverse-proxy.md * Update reverse-proxy.md * Update reverse-proxy.md * Update reverse-proxy.md * Update reverse-proxy.md * Update reverse-proxy.md * Update reverse-proxy.md * Update reverse-proxy.md
67 lines
2.2 KiB
Markdown
67 lines
2.2 KiB
Markdown
# Reverse Proxy
|
|
|
|
Users can deploy a custom reverse proxy that forwards requests to Immich. This way, the reverse proxy can handle TLS termination, load balancing, or other advanced features. All reverse proxies between Immich and the user must forward all headers and set the `Host`, `X-Real-IP`, `X-Forwarded-Proto` and `X-Forwarded-For` headers to their appropriate values. Additionally, your reverse proxy should allow for big enough uploads. By following these practices, you ensure that all custom reverse proxies are fully compatible with Immich.
|
|
|
|
:::note
|
|
The Repair page can take a long time to load. To avoid server timeouts or errors, we recommend specifying a timeout of at least 10 minutes on your proxy server.
|
|
:::
|
|
|
|
### Nginx example config
|
|
|
|
Below is an example config for nginx. Make sure to set `public_url` to the front-facing URL of your instance, and `backend_url` to the path of the Immich server.
|
|
|
|
```nginx
|
|
server {
|
|
server_name <public_url>;
|
|
|
|
# allow large file uploads
|
|
client_max_body_size 50000M;
|
|
|
|
# Set headers
|
|
proxy_set_header Host $http_host;
|
|
proxy_set_header X-Real-IP $remote_addr;
|
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
|
proxy_set_header X-Forwarded-Proto $scheme;
|
|
|
|
# enable websockets: http://nginx.org/en/docs/http/websocket.html
|
|
proxy_http_version 1.1;
|
|
proxy_set_header Upgrade $http_upgrade;
|
|
proxy_set_header Connection "upgrade";
|
|
proxy_redirect off;
|
|
|
|
# set timeout
|
|
proxy_read_timeout 600s;
|
|
proxy_send_timeout 600s;
|
|
send_timeout 600s;
|
|
|
|
location / {
|
|
proxy_pass http://<backend_url>:2283;
|
|
}
|
|
}
|
|
```
|
|
|
|
### Caddy example config
|
|
|
|
As an alternative to nginx, you can also use [Caddy](https://caddyserver.com/) as a reverse proxy (with automatic HTTPS configuration). Below is an example config.
|
|
|
|
```
|
|
immich.example.org {
|
|
reverse_proxy http://<snip>:2283
|
|
}
|
|
```
|
|
|
|
### Apache example config
|
|
|
|
Below is an example config for Apache2 site configuration.
|
|
|
|
```ApacheConf
|
|
<VirtualHost *:80>
|
|
ServerName <snip>
|
|
ProxyRequests Off
|
|
# set timeout in seconds
|
|
ProxyPass / http://127.0.0.1:2283/ timeout=600 upgrade=websocket
|
|
ProxyPassReverse / http://127.0.0.1:2283/
|
|
ProxyPreserveHost On
|
|
</VirtualHost>
|
|
```
|