Skip to content

Commit 9b96014

Browse files
PythonGermanyPythonGermany
committed
Merge remote-tracking branch 'TwiN/master' into add-build-information
2 parents 2291d8d + 40b1576 commit 9b96014

File tree

3 files changed

+53
-38
lines changed

3 files changed

+53
-38
lines changed

‎README.md‎

Lines changed: 50 additions & 35 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,41 +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-
| `ui.show-version` | Show version in footer | `false` |
279-
| `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). | `{}` |
280262

281263
If you want more verbose logging, you may set the `GATUS_LOG_LEVEL` environment variable to `DEBUG`.
282264
Conversely, if you want less verbose logging, you can set the aforementioned environment variable to `WARN`, `ERROR` or `FATAL`.
@@ -526,6 +508,39 @@ Here are some examples of conditions you can use:
526508

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

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` |
543+
| `ui.show-version` | Show version in footer | `false` |
529544

530545
### Announcements
531546
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.

‎go.mod‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ go 1.24.4
55
toolchain go1.24.7
66

77
require (
8-
code.gitea.io/sdk/gitea v0.22.0
8+
code.gitea.io/sdk/gitea v0.22.1
99
github.com/TwiN/deepmerge v0.2.2
1010
github.com/TwiN/g8/v2 v2.0.0
1111
github.com/TwiN/gocache/v2 v2.4.0

‎go.sum‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ cloud.google.com/go/auth/oauth2adapt v0.2.8 h1:keo8NaayQZ6wimpNSmW5OPc283g65QNIi
44
cloud.google.com/go/auth/oauth2adapt v0.2.8/go.mod h1:XQ9y31RkqZCcwJWNSx2Xvric3RrU88hAYYbjDWYDL+c=
55
cloud.google.com/go/compute/metadata v0.9.0 h1:pDUj4QMoPejqq20dK0Pg2N4yG9zIkYGdBtwLoEkH9Zs=
66
cloud.google.com/go/compute/metadata v0.9.0/go.mod h1:E0bWwX5wTnLPedCKqk3pJmVgCBSM6qQI1yTBdEb3C10=
7-
code.gitea.io/sdk/gitea v0.22.0 h1:HCKq7bX/HQ85Nw7c/HAhWgRye+vBp5nQOE8Md1+9Ef0=
8-
code.gitea.io/sdk/gitea v0.22.0/go.mod h1:yyF5+GhljqvA30sRDreoyHILruNiy4ASufugzYg0VHM=
7+
code.gitea.io/sdk/gitea v0.22.1 h1:7K05KjRORyTcTYULQ/AwvlVS6pawLcWyXZcTr7gHFyA=
8+
code.gitea.io/sdk/gitea v0.22.1/go.mod h1:yyF5+GhljqvA30sRDreoyHILruNiy4ASufugzYg0VHM=
99
github.com/42wim/httpsig v1.2.3 h1:xb0YyWhkYj57SPtfSttIobJUPJZB9as1nsfo7KWVcEs=
1010
github.com/42wim/httpsig v1.2.3/go.mod h1:nZq9OlYKDrUBhptd77IHx4/sZZD+IxTBADvAPI9G/EM=
1111
github.com/TwiN/deepmerge v0.2.2 h1:FUG9QMIYg/j2aQyPPhA3XTFJwXSNHI/swaR4Lbyxwg4=

0 commit comments

Comments
 (0)