From 60b0f3fa296928cacfc4bd6deaf9d50f541f29a3 Mon Sep 17 00:00:00 2001 From: Ansil H Date: Wed, 21 Jun 2023 08:51:55 +0530 Subject: [PATCH] docs: Specify that exposing Gatus through a subpath is not supported (#507) * Updated README.md Added Gatus UI custom path supportability to FQA * Update README.md * Update README.md * Update README.md --------- Co-authored-by: TwiN --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 555316e6..e44bce37 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,7 @@ Have any feedback or questions? [Create a discussion](https://github.com/TwiN/ga - [disable-monitoring-lock](#disable-monitoring-lock) - [Reloading configuration on the fly](#reloading-configuration-on-the-fly) - [Endpoint groups](#endpoint-groups) + - [Exposing Gatus on a custom path](#exposing-gatus-on-a-custom-path) - [Exposing Gatus on a custom port](#exposing-gatus-on-a-custom-port) - [Keeping your configuration small](#keeping-your-configuration-small) - [Badges](#badges) @@ -1699,6 +1700,12 @@ The configuration above will result in a dashboard that looks like this: ![Gatus Endpoint Groups](.github/assets/endpoint-groups.png) +### Exposing Gatus on a custom path +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/`. + +For more information, see https://github.com/TwiN/gatus/issues/88. + + ### Exposing Gatus on a custom port By default, Gatus is exposed on port `8080`, but you may specify a different port by setting the `web.port` parameter: ```yaml