You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-2Lines changed: 11 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2666,6 +2666,8 @@ security:
2666
2666
2667
2667
Confused? Read [Securing Gatus with OIDC using Auth0](https://twin.sh/articles/56/securing-gatus-with-oidc-using-auth0).
2668
2668
2669
+
The example configuration using [Dex](https://dexidp.io/) as the OIDC provider,
2670
+
can be found in [.examples/docker-compose-oidc](.examples/docker-compose-oidc).
2669
2671
2670
2672
### TLS Encryption
2671
2673
Gatus supports basic encryption with TLS. To enable this, certificate files in PEM format have to be provided.
@@ -3272,10 +3274,17 @@ clears their browser's localstorage.
3272
3274
3273
3275
3274
3276
### Exposing Gatus on a custom path
3275
-
Currently, you can expose the Gatus UI using a fully qualified domain name (FQDN) such as `status.example.org`. However, it does not support path-based routing, which means you cannot expose it through a URL like `example.org/status/`.
3277
+
Gatus always exposes its endpoints and UI under the root path ('/'), and it cannot be changed.
3278
+
However, if you find yourself in a situation where you need to expose Gatus on a custom path (e.g. `/gatus/`),
3279
+
you can achieve this by using a reverse proxy such as Nginx or Traefik or Caddy to handle the path rewriting for you.
3280
+
In order for it to work properly, you must tell Gatus to use the custom path as its `web.base-path` so that all links
3281
+
are generated correctly and redirections work as expected.
3276
3282
3277
-
For more information, see https://github.com/TwiN/gatus/issues/88.
3283
+
See [examples/docker-compose-reverse-proxy](.examples/docker-compose-reverse-proxy) for example using Caddy.
3278
3284
3285
+
Note that if you are using OIDC for authentication, your `security.oidc.redirect-url` must include the custom path as well.
3286
+
3287
+
See [examples/docker-compose-reverse-proxy-oidc](.examples/docker-compose-reverse-proxy-oidc) for an example using Caddy and OIDC.
3279
3288
3280
3289
### Exposing Gatus on a custom port
3281
3290
By default, Gatus is exposed on port `8080`, but you may specify a different port by setting the `web.port` parameter:
0 commit comments