diff --git a/docs/configuration/https.md b/docs/configuration/https.md index bc95e9be2..b1e078cdd 100644 --- a/docs/configuration/https.md +++ b/docs/configuration/https.md @@ -25,6 +25,8 @@ Generic placeholders are defined as follows: * ``: a regular string that is a secret, such as a password * ``: a regular string +A valid example file can be found [here](/documentation/examples/web-config.yml). + ``` tls_server_config: # Certificate and key files for server to use to authenticate to client. diff --git a/documentation/examples/web-config.yml b/documentation/examples/web-config.yml new file mode 100644 index 000000000..84e507061 --- /dev/null +++ b/documentation/examples/web-config.yml @@ -0,0 +1,12 @@ +# TLS and basic authentication configuration example. +# +# Additionally, a certificate and a key file are needed. +tls_server_config: + cert_file: server.crt + key_file: server.key + +# Usernames and passwords required to connect to Prometheus. +# Passwords are hashed with bcrypt: https://github.com/prometheus/exporter-toolkit/blob/master/https/README.md#about-bcrypt +basic_auth_users: + alice: $2y$10$mDwo.lAisC94iLAyP81MCesa29IzH37oigHC/42V2pdJlUprsJPze + bob: $2y$10$hLqFl9jSjoAAy95Z/zw8Ye8wkdMBM8c5Bn1ptYqP/AXyV0.oy0S8m