diff --git a/README.md b/README.md
index 1e169836..deb265fe 100644
--- a/README.md
+++ b/README.md
@@ -157,54 +157,54 @@ If you want to test it locally, see [Docker](#docker).
## Configuration
-| Parameter | Description | Default |
-|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------|
-| `debug` | Whether to enable debug logs. | `false` |
-| `metrics` | Whether to expose metrics at /metrics. | `false` |
-| `storage` | [Storage configuration](#storage) | `{}` |
-| `endpoints` | List of endpoints to monitor. | Required `[]` |
-| `endpoints[].enabled` | Whether to monitor the endpoint. | `true` |
-| `endpoints[].name` | Name of the endpoint. Can be anything. | Required `""` |
-| `endpoints[].group` | Group name. Used to group multiple endpoints together on the dashboard. See [Endpoint groups](#endpoint-groups). | `""` |
-| `endpoints[].url` | URL to send the request to. | Required `""` |
-| `endpoints[].method` | Request method. | `GET` |
-| `endpoints[].conditions` | Conditions used to determine the health of the endpoint. See [Conditions](#conditions). | `[]` |
-| `endpoints[].interval` | Duration to wait between every status check. | `60s` |
-| `endpoints[].graphql` | Whether to wrap the body in a query param (`{"query":"$body"}`). | `false` |
-| `endpoints[].body` | Request body. | `""` |
-| `endpoints[].headers` | Request headers. | `{}` |
-| `endpoints[].dns` | Configuration for an endpoint of type DNS. See [Monitoring an endpoint using DNS queries](#monitoring-an-endpoint-using-dns-queries). | `""` |
-| `endpoints[].dns.query-type` | Query type (e.g. MX) | `""` |
-| `endpoints[].dns.query-name` | Query name (e.g. example.com) | `""` |
-| `endpoints[].alerts[].type` | Type of alert. Valid types: `slack`, `discord`, `email`, `googlechat`, `pagerduty`, `twilio`, `mattermost`, `messagebird`, `teams` `custom`. | Required `""` |
-| `endpoints[].alerts[].enabled` | Whether to enable the alert. | `false` |
-| `endpoints[].alerts[].failure-threshold` | Number of failures in a row needed before triggering the alert. | `3` |
-| `endpoints[].alerts[].success-threshold` | Number of successes in a row before an ongoing incident is marked as resolved. | `2` |
-| `endpoints[].alerts[].send-on-resolved` | Whether to send a notification once a triggered alert is marked as resolved. | `false` |
-| `endpoints[].alerts[].description` | Description of the alert. Will be included in the alert sent. | `""` |
-| `endpoints[].client` | [Client configuration](#client-configuration). | `{}` |
-| `endpoints[].ui` | UI configuration at the endpoint level. | `{}` |
-| `endpoints[].ui.hide-hostname` | Whether to hide the hostname in the result. | `false` |
-| `endpoints[].ui.hide-url` | Whether to ensure the URL is not displayed in the results. Useful if the URL contains a token. | `false` |
-| `endpoints[].ui.dont-resolve-failed-conditions` | Whether to resolve failed conditions for the UI. | `false` |
-| `endpoints[].ui.badge.reponse-time` | List of response time thresholds. Each time a threshold is reached, the badge has a different color. | `[50, 200, 300, 500, 750]` |
-| `alerting` | [Alerting configuration](#alerting). | `{}` |
-| `security` | [Security configuration](#security). | `{}` |
-| `disable-monitoring-lock` | Whether to [disable the monitoring lock](#disable-monitoring-lock). | `false` |
-| `skip-invalid-config-update` | Whether to ignore invalid configuration update. See [Reloading configuration on the fly](#reloading-configuration-on-the-fly). | `false` |
-| `web` | Web configuration. | `{}` |
-| `web.address` | Address to listen on. | `0.0.0.0` |
-| `web.port` | Port to listen on. | `8080` |
-| `ui` | UI configuration. | `{}` |
-| `ui.title` | [Title of the document](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/title). | `Health Dashboard ǀ Gatus` |
-| `ui.header` | Header at the top of the dashboard. | `Health Status` |
-| `ui.logo` | URL to the logo to display. | `""` |
-| `ui.link` | Link to open when the logo is clicked. | `""` |
-| `ui.buttons` | List of buttons to display below the header. | `[]` |
-| `ui.buttons[].name` | Text to display on the button. | Required `""` |
-| `ui.buttons[].link` | Link to open when the button is clicked. | Required `""` |
-| `maintenance` | [Maintenance configuration](#maintenance). | `{}` |
-
+| Parameter | Description | Default |
+| :---------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------- |
+| `debug` | Whether to enable debug logs. | `false` |
+| `metrics` | Whether to expose metrics at /metrics. | `false` |
+| `storage` | [Storage configuration](#storage) | `{}` |
+| `endpoints` | List of endpoints to monitor. | Required `[]` |
+| `endpoints[].enabled` | Whether to monitor the endpoint. | `true` |
+| `endpoints[].name` | Name of the endpoint. Can be anything. | Required `""` |
+| `endpoints[].group` | Group name. Used to group multiple endpoints together on the dashboard. See [Endpoint groups](#endpoint-groups). | `""` |
+| `endpoints[].url` | URL to send the request to. | Required `""` |
+| `endpoints[].method` | Request method. | `GET` |
+| `endpoints[].conditions` | Conditions used to determine the health of the endpoint. See [Conditions](#conditions). | `[]` |
+| `endpoints[].interval` | Duration to wait between every status check. | `60s` |
+| `endpoints[].graphql` | Whether to wrap the body in a query param (`{"query":"$body"}`). | `false` |
+| `endpoints[].body` | Request body. | `""` |
+| `endpoints[].headers` | Request headers. | `{}` |
+| `endpoints[].dns` | Configuration for an endpoint of type DNS. See [Monitoring an endpoint using DNS queries](#monitoring-an-endpoint-using-dns-queries). | `""` |
+| `endpoints[].dns.query-type` | Query type (e.g. MX) | `""` |
+| `endpoints[].dns.query-name` | Query name (e.g. example.com) | `""` |
+| `endpoints[].alerts[].type` | Type of alert. Valid types: `slack`, `discord`, `email`, `googlechat`, `pagerduty`, `twilio`, `mattermost`, `messagebird`, `teams` `custom`. | Required `""` |
+| `endpoints[].alerts[].enabled` | Whether to enable the alert. | `false` |
+| `endpoints[].alerts[].failure-threshold` | Number of failures in a row needed before triggering the alert. | `3` |
+| `endpoints[].alerts[].success-threshold` | Number of successes in a row before an ongoing incident is marked as resolved. | `2` |
+| `endpoints[].alerts[].send-on-resolved` | Whether to send a notification once a triggered alert is marked as resolved. | `false` |
+| `endpoints[].alerts[].description` | Description of the alert. Will be included in the alert sent. | `""` |
+| `endpoints[].client` | [Client configuration](#client-configuration). | `{}` |
+| `endpoints[].ui` | UI configuration at the endpoint level. | `{}` |
+| `endpoints[].ui.hide-hostname` | Whether to hide the hostname in the result. | `false` |
+| `endpoints[].ui.hide-url` | Whether to ensure the URL is not displayed in the results. Useful if the URL contains a token. | `false` |
+| `endpoints[].ui.dont-resolve-failed-conditions` | Whether to resolve failed conditions for the UI. | `false` |
+| `endpoints[].ui.badge.reponse-time` | List of response time thresholds. Each time a threshold is reached, the badge has a different color. | `[50, 200, 300, 500, 750]` |
+| `alerting` | [Alerting configuration](#alerting). | `{}` |
+| `security` | [Security configuration](#security). | `{}` |
+| `disable-monitoring-lock` | Whether to [disable the monitoring lock](#disable-monitoring-lock). | `false` |
+| `skip-invalid-config-update` | Whether to ignore invalid configuration update. See [Reloading configuration on the fly](#reloading-configuration-on-the-fly). | `false` |
+| `web` | Web configuration. | `{}` |
+| `web.address` | Address to listen on. | `0.0.0.0` |
+| `web.port` | Port to listen on. | `8080` |
+| `ui` | UI configuration. | `{}` |
+| `ui.title` | [Title of the document](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/title). | `Health Dashboard ǀ Gatus` |
+| `ui.description` | Meta description for the page. | `Gatus is an advanced...`. |
+| `ui.header` | Header at the top of the dashboard. | `Health Status` |
+| `ui.logo` | URL to the logo to display. | `""` |
+| `ui.link` | Link to open when the logo is clicked. | `""` |
+| `ui.buttons` | List of buttons to display below the header. | `[]` |
+| `ui.buttons[].name` | Text to display on the button. | Required `""` |
+| `ui.buttons[].link` | Link to open when the button is clicked. | Required `""` |
+| `maintenance` | [Maintenance configuration](#maintenance). | `{}` |
### Conditions
Here are some examples of conditions you can use:
diff --git a/config/ui/ui.go b/config/ui/ui.go
index 5a337180..efdf60ef 100644
--- a/config/ui/ui.go
+++ b/config/ui/ui.go
@@ -9,10 +9,11 @@ import (
)
const (
- defaultTitle = "Health Dashboard | Gatus"
- defaultHeader = "Health Status"
- defaultLogo = ""
- defaultLink = ""
+ defaultTitle = "Health Dashboard | Gatus"
+ defaultDescription = "Gatus is an advanced automated status page that lets you monitor your applications and configure alerts to notify you if there's an issue"
+ defaultHeader = "Health Status"
+ defaultLogo = ""
+ defaultLink = ""
)
var (
@@ -21,11 +22,12 @@ var (
// Config is the configuration for the UI of Gatus
type Config struct {
- Title string `yaml:"title,omitempty"` // Title of the page
- Header string `yaml:"header,omitempty"` // Header is the text at the top of the page
- Logo string `yaml:"logo,omitempty"` // Logo to display on the page
- Link string `yaml:"link,omitempty"` // Link to open when clicking on the logo
- Buttons []Button `yaml:"buttons,omitempty"` // Buttons to display below the header
+ Title string `yaml:"title,omitempty"` // Title of the page
+ Description string `yaml:"description,omitempty"` // Meta description of the page
+ Header string `yaml:"header,omitempty"` // Header is the text at the top of the page
+ Logo string `yaml:"logo,omitempty"` // Logo to display on the page
+ Link string `yaml:"link,omitempty"` // Link to open when clicking on the logo
+ Buttons []Button `yaml:"buttons,omitempty"` // Buttons to display below the header
}
// Button is the configuration for a button on the UI
@@ -45,10 +47,11 @@ func (btn *Button) Validate() error {
// GetDefaultConfig returns a Config struct with the default values
func GetDefaultConfig() *Config {
return &Config{
- Title: defaultTitle,
- Header: defaultHeader,
- Logo: defaultLogo,
- Link: defaultLink,
+ Title: defaultTitle,
+ Description: defaultDescription,
+ Header: defaultHeader,
+ Logo: defaultLogo,
+ Link: defaultLink,
}
}
@@ -57,6 +60,9 @@ func (cfg *Config) ValidateAndSetDefaults() error {
if len(cfg.Title) == 0 {
cfg.Title = defaultTitle
}
+ if len(cfg.Description) == 0 {
+ cfg.Description = defaultDescription
+ }
if len(cfg.Header) == 0 {
cfg.Header = defaultHeader
}
diff --git a/config/ui/ui_test.go b/config/ui/ui_test.go
index 885081f3..2811157c 100644
--- a/config/ui/ui_test.go
+++ b/config/ui/ui_test.go
@@ -7,10 +7,11 @@ import (
func TestConfig_ValidateAndSetDefaults(t *testing.T) {
cfg := &Config{
- Title: "",
- Header: "",
- Logo: "",
- Link: "",
+ Title: "",
+ Description: "",
+ Header: "",
+ Logo: "",
+ Link: "",
}
if err := cfg.ValidateAndSetDefaults(); err != nil {
t.Error("expected no error, got", err.Error())
@@ -18,6 +19,9 @@ func TestConfig_ValidateAndSetDefaults(t *testing.T) {
if cfg.Title != defaultTitle {
t.Errorf("expected title to be %s, got %s", defaultTitle, cfg.Title)
}
+ if cfg.Description != defaultDescription {
+ t.Errorf("expected description to be %s, got %s", defaultDescription, cfg.Description)
+ }
if cfg.Header != defaultHeader {
t.Errorf("expected header to be %s, got %s", defaultHeader, cfg.Header)
}
diff --git a/web/app/public/index.html b/web/app/public/index.html
index e6d492df..9418a3d5 100644
--- a/web/app/public/index.html
+++ b/web/app/public/index.html
@@ -11,7 +11,7 @@
-
+