From 2aef4fb9bb80aad23004d3a2fefe6d7450ec2fc8 Mon Sep 17 00:00:00 2001 From: BluemediaGER Date: Tue, 18 Jan 2022 17:04:16 +0100 Subject: [PATCH] Document defaultRefreshInterval option --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2854af9..b467512 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,14 @@ You can see it in action here: https://status.bluemedia.dev The frontend tries to retrieve a configuration file named `config.json` from the webroot during page load. If the configuration is loaded successfully, it will be used to make advanced adjustments to the frontend. The possible options are listed below. -| Parameter | Description | Default | -|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------| -| `title` | Title of the page. Both in the tab and next to the logo. | `Infrastructure Status` | -| `gatusBaseUrl` | Alternative base URL (without trailing slash) of the Gatus instance, if the API is not available relative to the frontend. | `""` | -| `hiddenGroups` | Array containing names of groups that should be hidden. These groups are still visible in the API response! | `[]` | -| `hiddenEndpoints` | Array containing names of endpoints that should be hidden. These endpoints are still visible in the API response! | `[]` | -| `groupOrder` | Array containing names of groups. The groups are sorted in the frontend according to the order in the array (different from alphabetical sorting by default). If groups are not included in the array, they will be added alphabetically sorted below the sorted groups. | `[]` | +| Parameter | Description | Default | +|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------| +| `title` | Title of the page. Both in the tab and next to the logo. | `Infrastructure Status` | +| `gatusBaseUrl` | Alternative base URL (without trailing slash) of the Gatus instance, if the API is not available relative to the frontend. | `none` | +| `hiddenGroups` | Array containing names of groups that should be hidden. These groups are still visible in the API response! | `[]` | +| `hiddenEndpoints` | Array containing names of endpoints that should be hidden. These endpoints are still visible in the API response! | `[]` | +| `groupOrder` | Array containing names of groups. The groups are sorted in the frontend according to the order in the array (different from alphabetical sorting by default). If groups are not included in the array, they will be added alphabetically sorted below the sorted groups. | `[]` | +| `defaultRefreshInterval` | Interval in seconds after which the API data is refreshed in the background by default. Can be changed by the user by selecting a value in the lower left corner of the page. Possible values: `10`, `30`, `60`, `120`, `300`, `600` | `60` | ## Deployment