#112 Improve og:image base URL function

This commit is contained in:
Alan Grainger
2025-07-21 12:25:21 +02:00
parent d9bd631d16
commit 96fbbb5714
4 changed files with 11 additions and 4 deletions
+9 -2
View File
@@ -68,7 +68,9 @@ Here is an example setup for [securing Immich behind mTLS](./docs/securing-immic
2. Update the value for `IMMICH_URL` in your docker-compose file to point to your local URL for Immich. This should not be a public URL. 2. Update the value for `IMMICH_URL` in your docker-compose file to point to your local URL for Immich. This should not be a public URL.
3. Start the docker container. You can test that it is working by visiting `https://your-proxy-url.com/share/healthcheck`. 3. Update the value for `PUBLIC_BASE_URL` to be the public base URL for IPP, without a trailing slash (example `https://your-proxy-url.com`).
4. Start the docker container. You can test that it is working by visiting `https://your-proxy-url.com/share/healthcheck`.
Check the container console output for any error messages. Check the container console output for any error messages.
```bash ```bash
@@ -142,7 +144,6 @@ There are some additional configuration options you can change, for example the
| Option | Type | Description | | Option | Type | Description |
|-------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `publicBaseUrl` | `string` | Set this to be the base public URL of your IPP instance. This is used for generating the `og:image` URL. If you want to use multiple public URLs, you can instead set this value to `null` and send a `publicBaseUrl` header on the request from your reverse proxy to IPP. |
| `responseHeaders` | `object` | Change the headers sent with your web responses. By default there is `cache-control` and CORS added. | | `responseHeaders` | `object` | Change the headers sent with your web responses. By default there is `cache-control` and CORS added. |
| `singleImageGallery` | `bool` | By default a link to a single image will directly open the image file. Set to `true` if you want to show a gallery page instead for a single item. | | `singleImageGallery` | `bool` | By default a link to a single image will directly open the image file. Set to `true` if you want to show a gallery page instead for a single item. |
| `downloadOriginalPhoto` | `bool` | Set to `false` if you only want people to be able to download the 'preview' quality photo, rather than your original photo. | | `downloadOriginalPhoto` | `bool` | Set to `false` if you only want people to be able to download the 'preview' quality photo, rather than your original photo. |
@@ -203,6 +204,12 @@ You can customise the responses that IPP sends for invalid requests. For example
See [Custom responses](docs/custom-responses.md) for more details. See [Custom responses](docs/custom-responses.md) for more details.
### Serving from multiple domains
If you're serving the same IPP from multiple domains, instead of setting the public URL in your docker-compose file, you can set it dynamically via a HTTP header in the request from your reverse proxy to IPP.
Set a custom `publicBaseUrl` header on each request with the value of your public base URL (example `https://your-proxy-url.com`).
## Troubleshooting ## Troubleshooting
### Video playback ### Video playback
-1
View File
@@ -1,6 +1,5 @@
{ {
"ipp": { "ipp": {
"publicBaseUrl": "https://your-proxy-url.com",
"responseHeaders": { "responseHeaders": {
"Cache-Control": "public, max-age=2592000", "Cache-Control": "public, max-age=2592000",
"Access-Control-Allow-Origin": "*" "Access-Control-Allow-Origin": "*"
+1 -1
View File
@@ -91,7 +91,7 @@ class Render {
// publicBaseUrl is used for the og:image, which requires a fully qualified URL. // publicBaseUrl is used for the og:image, which requires a fully qualified URL.
// You can specify this in your config.json file, or send it dynamically as a `host` header // You can specify this in your config.json file, or send it dynamically as a `host` header
const publicBaseUrl = getConfigOption('ipp.publicBaseUrl', null) || res.req.headers.publicBaseUrl || '' const publicBaseUrl = process.env.PUBLIC_BASE_URL || res.req.headers.publicBaseUrl || (res.req.protocol + '://' + res.req.headers.host)
for (const asset of share.assets) { for (const asset of share.assets) {
let video, downloadUrl let video, downloadUrl
+1
View File
@@ -6,6 +6,7 @@ services:
ports: ports:
- "3000:3000" - "3000:3000"
environment: environment:
- PUBLIC_BASE_URL=https://your-proxy-url.com
- IMMICH_URL=http://your-internal-immich-server:2283 - IMMICH_URL=http://your-internal-immich-server:2283
healthcheck: healthcheck:
test: curl -s http://localhost:3000/share/healthcheck -o /dev/null || exit 1 test: curl -s http://localhost:3000/share/healthcheck -o /dev/null || exit 1