--- title: Charmhub | Deploy Gatus Health Check and Monitoring Charm using Charmhub - The Open Operator Collection description: Deploy the latest version of Gatus Health Check and Monitoring Charm as a Kubernetes Operator on any cloud. url: https://charmhub.io/gatus-k8s/configurations --- # Gatus Health Check and Monitoring Charm [Business Data](https://charmhub.io/publisher/businessdata "View all packages from Business Data") * [Business Data](https://charmhub.io/publisher/businessdata "View all packages from Business Data") Platform: stable 14 ``` juju deploy gatus-k8s ``` [Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications) * [announcements](https://charmhub.io/gatus-k8s/configurations#announcements) * [app-port](https://charmhub.io/gatus-k8s/configurations#app-port) * [app-secret-key](https://charmhub.io/gatus-k8s/configurations#app-secret-key) * [app-secret-key-id](https://charmhub.io/gatus-k8s/configurations#app-secret-key-id) * [endpoints](https://charmhub.io/gatus-k8s/configurations#endpoints) * [log-level](https://charmhub.io/gatus-k8s/configurations#log-level) * [mattermost-alerting](https://charmhub.io/gatus-k8s/configurations#mattermost-alerting) * [mattermost-insecure](https://charmhub.io/gatus-k8s/configurations#mattermost-insecure) * [metrics-path](https://charmhub.io/gatus-k8s/configurations#metrics-path) * [metrics-port](https://charmhub.io/gatus-k8s/configurations#metrics-port) * [oidc-allowed-subjects](https://charmhub.io/gatus-k8s/configurations#oidc-allowed-subjects) * [oidc-redirect-path](https://charmhub.io/gatus-k8s/configurations#oidc-redirect-path) * [oidc-scopes](https://charmhub.io/gatus-k8s/configurations#oidc-scopes) * [ui-dark-mode](https://charmhub.io/gatus-k8s/configurations#ui-dark-mode) * [ui-dashboard-heading](https://charmhub.io/gatus-k8s/configurations#ui-dashboard-heading) * [ui-dashboard-subheading](https://charmhub.io/gatus-k8s/configurations#ui-dashboard-subheading) * [ui-default-filter-by](https://charmhub.io/gatus-k8s/configurations#ui-default-filter-by) * [ui-default-sort-by](https://charmhub.io/gatus-k8s/configurations#ui-default-sort-by) * [ui-header](https://charmhub.io/gatus-k8s/configurations#ui-header) * [ui-logo](https://charmhub.io/gatus-k8s/configurations#ui-logo) [Learn about configurations >](https://juju.is/docs/juju/configuration#heading--application-configuration) * announcements | string List of announcements to send. YAML structured with an `announcements` top-level key, same as the standard Gatus configuration file. See https://github.com/TwiN/gatus?tab=readme-ov-file#announcements. * app-port | int Default: 8080 Default port where the application will listen on. * app-secret-key | string Long secret you can use for sessions, csrf or any other thing where you need a random secret shared by all units * app-secret-key-id | secret This configuration is similar to `app-secret-key`, but instead accepts a Juju user secret ID. The secret should contain a single key, "value", which maps to the actual application secret key. To create the secret, run the following command: `juju add-secret my-app-secret-key value= && juju grant-secret my-app-secret-key my-app`, and use the output secret ID to configure this option. * endpoints | string List of endpoints to monitor. YAML structured with an `endpoints` top-level key, same as the standard Gatus configuration file. See https://github.com/TwiN/gatus?tab=readme-ov-file#endpoints. * log-level | string Default: info Configures the log level of Gatus. Acceptable values are: "info", "debug", "warn", "error" and "fatal" * mattermost-alerting | string Juju Secret ID including secrets used for Mattermost alerting. The secret may contain the following keys: + default: The default webhook URL for Mattermost alerts. Required for any Mattermost alerting. + : Optional additional per-channel webhook URLs, e.g. team-name or alerts-channel. These can be referenced in the endpoints config using the [webhook-url:] placeholder syntax to specify per-endpoint webhook overrides. * mattermost-insecure | boolean Whether to use an insecure connection to Mattermost. * metrics-path | string Default: /metrics Path where the prometheus metrics will be scraped. * metrics-port | int Default: 8080 Port where the prometheus metrics will be scraped. * oidc-allowed-subjects | string Optional comma-separated list of subject identifiers (e.g. email addresses) that are allowed to access the Gatus dashboard after authenticating via the oauth relation. If empty, all authenticated users are allowed. * oidc-redirect-path | string Default: /authorization-code/callback The callback path that Gatus listens on for the OAuth/OIDC redirect. This must match the path registered with your identity provider. Gatus uses /authorization-code/callback by default. Generally, you should not need to change this. * oidc-scopes | string Default: openid Space-separated list of OIDC scopes to request from the identity provider. The openid scope is mandatory and must always be included. Generally, you should not need to change this. * ui-dark-mode | boolean Default: True Whether to enable dark mode by default. Note that this is superseded by the user's operating system theme preferences. * ui-dashboard-heading | string Default: Health Dashboard Dashboard title between header and endpoints. * ui-dashboard-subheading | string Default: Monitor the health of your endpoints in real-time Dashboard description between header and endpoints. * ui-default-filter-by | string Default: none Default filter option for endpoints in the dashboard. Can be "none", "failing", or "unstable". Note that user preferences override this. * ui-default-sort-by | string Default: name Default sorting option for endpoints in the dashboard. Can be "name", "group", or "health". Note that user preferences override this. * ui-header | string Default: Gatus The header text to display in the Gatus UI. * ui-logo | string The logo to display in the Gatus UI. Defaults to the Gatus logo.