Skip to content

Commit 40b1576

Browse files
PythonGermanyTwiN
PythonGermany
and
TwiN
authored
docs: Separate web and ui config into sections (#1439)
Co-authored-by: TwiN <[email protected]>
1 parent 64c3b12 commit 40b1576

File tree

1 file changed

+49
-34
lines changed

1 file changed

+49
-34
lines changed

‎README.md‎

Lines changed: 49 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ Have any feedback or questions? [Create a discussion](https://github.com/TwiN/ga
5050
- [Conditions](#conditions)
5151
- [Placeholders](#placeholders)
5252
- [Functions](#functions)
53+
- [Web](#web)
54+
- [UI](#ui)
5355
- [Announcements](#announcements)
5456
- [Storage](#storage)
5557
- [Client configuration](#client-configuration)
@@ -242,40 +244,21 @@ If you want to test it locally, see [Docker](#docker).
242244

243245

244246
## Configuration
245-
| Parameter | Description | Default |
246-
|:-----------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:---------------------------|
247-
| `metrics` | Whether to expose metrics at `/metrics`. | `false` |
248-
| `storage` | [Storage configuration](#storage). | `{}` |
249-
| `alerting` | [Alerting configuration](#alerting). | `{}` |
250-
| `announcements` | [Announcements configuration](#announcements). | `[]` |
251-
| `endpoints` | [Endpoints configuration](#endpoints). | Required `[]` |
252-
| `external-endpoints` | [External Endpoints configuration](#external-endpoints). | `[]` |
253-
| `security` | [Security configuration](#security). | `{}` |
254-
| `concurrency` | Maximum number of endpoints/suites to monitor concurrently. Set to `0` for unlimited. See [Concurrency](#concurrency). | `3` |
255-
| `disable-monitoring-lock` | Whether to [disable the monitoring lock](#disable-monitoring-lock). **Deprecated**: Use `concurrency: 0` instead. | `false` |
256-
| `skip-invalid-config-update` | Whether to ignore invalid configuration update. <br />See [Reloading configuration on the fly](#reloading-configuration-on-the-fly). | `false` |
257-
| `web` | Web configuration. | `{}` |
258-
| `web.address` | Address to listen on. | `0.0.0.0` |
259-
| `web.port` | Port to listen on. | `8080` |
260-
| `web.read-buffer-size` | Buffer size for reading requests from a connection. Also limit for the maximum header size. | `8192` |
261-
| `web.tls.certificate-file` | Optional public certificate file for TLS in PEM format. | `""` |
262-
| `web.tls.private-key-file` | Optional private key file for TLS in PEM format. | `""` |
263-
| `ui` | UI configuration. | `{}` |
264-
| `ui.title` | [Title of the document](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/title). | `Health Dashboard ǀ Gatus` |
265-
| `ui.description` | Meta description for the page. | `Gatus is an advanced...`. |
266-
| `ui.dashboard-heading` | Dashboard title between header and endpoints | `Health Dashboard` |
267-
| `ui.dashboard-subheading` | Dashboard description between header and endpoints | `Monitor the health of your endpoints in real-time` |
268-
| `ui.header` | Header at the top of the dashboard. | `Gatus` |
269-
| `ui.logo` | URL to the logo to display. | `""` |
270-
| `ui.link` | Link to open when the logo is clicked. | `""` |
271-
| `ui.buttons` | List of buttons to display below the header. | `[]` |
272-
| `ui.buttons[].name` | Text to display on the button. | Required `""` |
273-
| `ui.buttons[].link` | Link to open when the button is clicked. | Required `""` |
274-
| `ui.custom-css` | Custom CSS | `""` |
275-
| `ui.dark-mode` | Whether to enable dark mode by default. Note that this is superseded by the user's operating system theme preferences. | `true` |
276-
| `ui.default-sort-by` | Default sorting option for endpoints in the dashboard. Can be `name`, `group`, or `health`. Note that user preferences override this. | `name` |
277-
| `ui.default-filter-by` | Default filter option for endpoints in the dashboard. Can be `none`, `failing`, or `unstable`. Note that user preferences override this. | `none` |
278-
| `maintenance` | [Maintenance configuration](#maintenance). | `{}` |
247+
| Parameter | Description | Default |
248+
|:-----------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:--------------|
249+
| `metrics` | Whether to expose metrics at `/metrics`. | `false` |
250+
| `storage` | [Storage configuration](#storage). | `{}` |
251+
| `alerting` | [Alerting configuration](#alerting). | `{}` |
252+
| `announcements` | [Announcements configuration](#announcements). | `[]` |
253+
| `endpoints` | [Endpoints configuration](#endpoints). | Required `[]` |
254+
| `external-endpoints` | [External Endpoints configuration](#external-endpoints). | `[]` |
255+
| `security` | [Security configuration](#security). | `{}` |
256+
| `concurrency` | Maximum number of endpoints/suites to monitor concurrently. Set to `0` for unlimited. See [Concurrency](#concurrency). | `3` |
257+
| `disable-monitoring-lock` | Whether to [disable the monitoring lock](#disable-monitoring-lock). **Deprecated**: Use `concurrency: 0` instead. | `false` |
258+
| `skip-invalid-config-update` | Whether to ignore invalid configuration update. <br />See [Reloading configuration on the fly](#reloading-configuration-on-the-fly). | `false` |
259+
| `web` | [Web configuration](#web). | `{}` |
260+
| `ui` | [UI configuration](#ui). | `{}` |
261+
| `maintenance` | [Maintenance configuration](#maintenance). | `{}` |
279262

280263
If you want more verbose logging, you may set the `GATUS_LOG_LEVEL` environment variable to `DEBUG`.
281264
Conversely, if you want less verbose logging, you can set the aforementioned environment variable to `WARN`, `ERROR` or `FATAL`.
@@ -525,6 +508,38 @@ Here are some examples of conditions you can use:
525508

526509
> 💡 Use `pat` only when you need to. `[STATUS] == pat(2*)` is a lot more expensive than `[STATUS] < 300`.
527510

511+
### Web
512+
Allows you to configure how and where the dashboard is being served.
513+
514+
| Parameter | Description | Default |
515+
|:---------------------------|:--------------------------------------------------------------------------------------------|:----------|
516+
| `web` | Web configuration | `{}` |
517+
| `web.address` | Address to listen on. | `0.0.0.0` |
518+
| `web.port` | Port to listen on. | `8080` |
519+
| `web.read-buffer-size` | Buffer size for reading requests from a connection. Also limit for the maximum header size. | `8192` |
520+
| `web.tls.certificate-file` | Optional public certificate file for TLS in PEM format. | `""` |
521+
| `web.tls.private-key-file` | Optional private key file for TLS in PEM format. | `""` |
522+
523+
### UI
524+
Allows you to configure the application wide defaults for the dashboard's UI. Some of these parameters can be overridden locally by users using the local storage of their browser.
525+
526+
| Parameter | Description | Default |
527+
|:--------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------|
528+
| `ui` | UI configuration | `{}` |
529+
| `ui.title` | [Title of the document](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/title). | `Health Dashboard ǀ Gatus` |
530+
| `ui.description` | Meta description for the page. | `Gatus is an advanced...`. |
531+
| `ui.dashboard-heading` | Dashboard title between header and endpoints | `Health Dashboard` |
532+
| `ui.dashboard-subheading` | Dashboard description between header and endpoints | `Monitor the health of your endpoints in real-time` |
533+
| `ui.header` | Header at the top of the dashboard. | `Gatus` |
534+
| `ui.logo` | URL to the logo to display. | `""` |
535+
| `ui.link` | Link to open when the logo is clicked. | `""` |
536+
| `ui.buttons` | List of buttons to display below the header. | `[]` |
537+
| `ui.buttons[].name` | Text to display on the button. | Required `""` |
538+
| `ui.buttons[].link` | Link to open when the button is clicked. | Required `""` |
539+
| `ui.custom-css` | Custom CSS | `""` |
540+
| `ui.dark-mode` | Whether to enable dark mode by default. Note that this is superseded by the user's operating system theme preferences. | `true` |
541+
| `ui.default-sort-by` | Default sorting option for endpoints in the dashboard. Can be `name`, `group`, or `health`. Note that user preferences override this. | `name` |
542+
| `ui.default-filter-by` | Default filter option for endpoints in the dashboard. Can be `none`, `failing`, or `unstable`. Note that user preferences override this. | `none` |
528543

529544
### Announcements
530545
System-wide announcements allow you to display important messages at the top of the status page. These can be used to inform users about planned maintenance, ongoing issues, or general information. You can use markdown to format your announcements.

0 commit comments

Comments
 (0)