Update docs

This commit is contained in:
Alan Grainger
2026-08-26 09:31:41 +12:00
parent 8c2c2219ce
commit afe7811a6f
3 changed files with 42 additions and 4 deletions
+7 -1
View File
@@ -95,10 +95,15 @@ run into video playback issues. See [Troubleshooting](#troubleshooting) for more
#### Running alongside Immich on a single domain #### Running alongside Immich on a single domain
Because all IPP paths are under `/share/...`, you can run Immich Public Proxy and Immich on the same domain. Because all IPP paths are under `/share/...` and `/s/...`, you can run Immich Public Proxy and Immich on the same domain.
See the instructions here: [Running on a single domain](./docs/running-on-single-domain.md). See the instructions here: [Running on a single domain](./docs/running-on-single-domain.md).
#### Redirecting your root domain to a share
Want `photos.yourdomain.net` to open a specific album instead of the IPP landing page? You can do this with your
reverse proxy - see [Redirecting your root domain to a share](./docs/redirect-root-to-share.md).
### Install with Kubernetes ### Install with Kubernetes
[See the docs here](docs/kubernetes.md). [See the docs here](docs/kubernetes.md).
@@ -121,6 +126,7 @@ https://your-proxy-url.com/share/ffSw63qnIYMtpmg0RNvOui0Dpio7BbxsObjvH8YZaobIjIA
``` ```
The part after `/share/` is Immich's shared link public ID (called the `key` [in the docs](https://immich.app/docs/api/get-my-shared-link)). The part after `/share/` is Immich's shared link public ID (called the `key` [in the docs](https://immich.app/docs/api/get-my-shared-link)).
For shared links with a named slug, the link will use the slug instead, e.g. `https://your-proxy-url.com/s/my-album`.
**Immich Public Proxy** takes that key and makes an API call to your Immich instance over your local network, to ask what **Immich Public Proxy** takes that key and makes an API call to your Immich instance over your local network, to ask what
photos or videos are shared in that share URL. photos or videos are shared in that share URL.
+32
View File
@@ -0,0 +1,32 @@
# Redirecting your root domain to a share
If you have a dedicated domain for your photos, you might want the root of that domain
to open a specific share, rather than showing the default IPP landing page. For example:
```
photos.yourdomain.net → your photo album
```
IPP deliberately doesn't do this itself - storing a share path would mean storing a key,
which goes against the design goal of being stateless and knowing nothing about your
Immich instance. Instead, handle it at the reverse proxy level.
## Examples
### Caddy
```
photos.yourdomain.net {
# Redirect the root to your share
redir / /s/example-share 302
# Alternatively you could rewrite, so the gallery appears at the root:
#rewrite / /s/example-share
reverse_proxy immich-public-proxy:3000
}
```
Use `redir` to send visitors to the share URL, or `rewrite` if you want the gallery
to appear at the root of your domain without changing the URL in the browser.
The example above uses a named slug link (`/s/example-share`). This works the same
with a standard share link, e.g. `/share/ffSw63qnIYMtpmg0RNvO...`.
+3 -3
View File
@@ -1,8 +1,8 @@
# Running IPP on a single domain with Immich # Running IPP on a single domain with Immich
Because everything related to IPP happens within the `/share` path, Because everything related to IPP happens within the `/share` and `/s` paths,
you can serve Immich and IPP on the same domain by configuring your reverse you can serve Immich and IPP on the same domain by configuring your reverse
proxy to send all `/share/*` requests to IPP. proxy to send all `/share/*` and `/s/*` requests to IPP.
## Caddy ## Caddy
@@ -11,7 +11,7 @@ proxy to send all `/share/*` requests to IPP.
``` ```
https://your-domain.com { https://your-domain.com {
# Immich Public Proxy paths # Immich Public Proxy paths
@public path /share /share/* @public path /share /share/* /s/*
handle @public { handle @public {
# Your IPP server and port # Your IPP server and port
reverse_proxy YOUR_SERVER:3000 reverse_proxy YOUR_SERVER:3000