diff --git a/docs/configuration.md b/docs/configuration.md index 2208891..0ede32d 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -6,6 +6,7 @@ - [Environment variables](#environment-variables) - [Other ways of providing tokens/passwords/secrets](#other-ways-of-providing-tokenspasswordssecrets) - [Including other config files](#including-other-config-files) + - [Config schema](#config-schema) - [Server](#server) - [Document](#document) - [Branding](#branding) @@ -182,6 +183,10 @@ docker run --rm -v ./glance.yml:/app/config/glance.yml glanceapp/glance config:p This assumes that the config you want to print is in your current working directory and is named `glance.yml`. +## Config schema + +For property descriptions, validation and autocompletion of the config within your IDE, @not-first has kindly created a [schema](https://github.com/not-first/glance-schema). Massive thanks to them for this, go check it out and give them a star! + ## Server Server configuration is done through a top level `server` property. Example: @@ -1657,7 +1662,7 @@ The title used to indicate the site. `url` -The public facing URL of a monitored service, the user will be redirected here. If `check-url` is not specified, this is used as the status check. +The URL of the monitored service, which must be reachable by Glance, and will be used as the link to go to when clicking on the title. If `check-url` is not specified, this is used as the status check. `check-url`