Update docs

This commit is contained in:
Alan Grainger
2025-03-07 13:14:03 +08:00
parent 9e176e816a
commit ac994acde6
2 changed files with 23 additions and 20 deletions
+1 -12
View File
@@ -147,7 +147,7 @@ There are some additional configuration options you can change, for example the
| `showGalleryTitle` | Show a title on the gallery page. |
| `allowDownloadAll` | Allow visitors to download all files as a zip. |
| `showHomePage` | Set to `false` to remove the IPP shield page at `/` and at `/share` |
| `stealthMode` | Set to `true` to stop IPP from responding to malformed or unauthenticated requests. |
| `customInvalidResponse` | Send a custom response instead of the default 404 - see [Custom responses](docs/custom-responses.md) for more details. |
For example, to disable the home page at `/` and at `/share` you need to change `showHomePage` to `false`:
@@ -184,17 +184,6 @@ For example, to disable the download button for images, you would edit the `ligh
}
```
### Customising your error response pages
You can customise the responses that IPP sends using your reverse proxy. For example you could:
- Send your own custom 404 page.
- Redirect to a new website.
- Drop the connection entirely (no response).
- And so on...
See [Custom responses](docs/custom-responses.md) for more details.
## Troubleshooting
If you're using Cloudflare and having issues with videos not playing well, make sure your `/share/video/` paths are set to bypass cache.
+22 -8
View File
@@ -8,15 +8,29 @@ To avoid giving information away about your server, IPP responds with a limited
| 401 | Invalid password provided for a password-protected share link. |
| 404 | All other invalid requests, e.g. album doesn't exist, share link is expired, non-existing file. |
Instead of sending these codes, you can customise the response(s) using your reverse proxy. For example you could:
Instead of sending these codes, you can customise the response by [changing the configuration option](../README.md#immich-public-proxy-options) for `customInvalidResponse`.
- Send a different response code.
- Send your own custom 404 page.
- Redirect to a new website.
- Drop the connection entirely (no response).
- And so on...
Possible options are:
## Caddy
| Option | Data type | Example | Action |
|------------------|-----------|-------------------------|------------------------------------------|
| HTTP status code | `integer` | `404` | Sends an HTTP status code. |
| Redirect URL | `string` | `"https://example.com"` | Redirects to another website. |
| `null` | `null` | `null` | Drops the connection without responding. |
| `false` | `boolean` | `false` | Responds with the default status code. |
## Custom function
If you want to go even further, you can write your own custom function. Do this by taking a copy of the `app/dist/invalidRequestHandler.js` file,
then mounting it back as a Docker volume into the correct location for the container to use.
## Customising the response using your Reverse Proxy
You can also choose to customise these responses using your reverse proxy, which might give you more flexibility depending on your use-case.
Here are some examples:
### Caddy
```
https://ipp.example.com {
@@ -37,7 +51,7 @@ If you wanted to drop the connection completely without responding at all, you c
}
```
## Apache
### Apache
```
<VirtualHost *:80>