Add important details about the server.base-url property

This commit is contained in:
Veronika Bušová 2024-09-15 00:29:46 +02:00
parent db1ed9e257
commit bae95a5e07
No known key found for this signature in database
GPG Key ID: 397CC1FDD8C9C046

View File

@ -138,6 +138,10 @@ A number between 1 and 65,535, so long as that port isn't already used by anythi
#### `base-url`
The base URL that Glance is hosted under. No need to specify this unless you're using a reverse proxy and are hosting Glance under a directory. If that's the case then you can set this value to `/glance` or whatever the directory is called. Note that the forward slash (`/`) in the beginning is required unless you specify the full domain and path.
> [!IMPORTANT]
> You need to strip the `base-url` prefix before forwarding the request to the Glance server.
> In Caddy you can do this using [`handle_path`](https://caddyserver.com/docs/caddyfile/directives/handle_path) or [`uri strip_prefix`](https://caddyserver.com/docs/caddyfile/directives/uri).
#### `assets-path`
The path to a directory that will be served by the server under the `/assets/` path. This is handy for widgets like the Monitor where you have to specify an icon URL and you want to self host all the icons rather than pointing to an external source.