CAUTION: This page documents an old version of Prometheus. Check out the latest stable version.

HTTPS and authentication

Prometheus supports basic authentication and TLS. This is experimental and might change in the future.

To specify which web configuration file to load, use the --web.config.file flag.

The file is written in YAML format, defined by the scheme described below. Brackets indicate that a parameter is optional. For non-list parameters the value is set to the specified default.

The file is read upon every http request, such as any change in the configuration and the certificates is picked up immediately.

Generic placeholders are defined as follows:

  • <boolean>: a boolean that can take the values true or false
  • <filename>: a valid path in the current working directory
  • <secret>: a regular string that is a secret, such as a password
  • <string>: a regular string

A valid example file can be found here.

  1. tls_server_config:
  2.   # Certificate and key files for server to use to authenticate to client.
  3.   cert_file: <filename>
  4.   key_file: <filename>
  6.   # Server policy for client authentication. Maps to ClientAuth Policies.
  7.   # For more detail on clientAuth options:
  8.   # https://golang.org/pkg/crypto/tls/#ClientAuthType
  9.   #
  10.   # NOTE: If you want to enable client authentication, you need to use
  11.   # RequireAndVerifyClientCert. Other values are insecure.
  12.   [ client_auth_type: <string> | default = "NoClientCert" ]
  14.   # CA certificate for client certificate authentication to the server.
  15.   [ client_ca_file: <filename> ]
  17.   # Minimum TLS version that is acceptable.
  18.   [ min_version: <string> | default = "TLS12" ]
  20.   # Maximum TLS version that is acceptable.
  21.   [ max_version: <string> | default = "TLS13" ]
  23.   # List of supported cipher suites for TLS versions up to TLS 1.2. If empty,
  24.   # Go default cipher suites are used. Available cipher suites are documented
  25.   # in the go documentation:
  26.   # https://golang.org/pkg/crypto/tls/#pkg-constants
  27.   #
  28.   # Note that only the cipher returned by the following function are supported:
  29.   # https://pkg.go.dev/crypto/tls#CipherSuites
  30.   [ cipher_suites:
  31.     [ - <string> ] ]
  33.   # prefer_server_cipher_suites controls whether the server selects the
  34.   # client's most preferred ciphersuite, or the server's most preferred
  35.   # ciphersuite. If true then the server's preference, as expressed in
  36.   # the order of elements in cipher_suites, is used.
  37.   [ prefer_server_cipher_suites: <bool> | default = true ]
  39.   # Elliptic curves that will be used in an ECDHE handshake, in preference
  40.   # order. Available curves are documented in the go documentation:
  41.   # https://golang.org/pkg/crypto/tls/#CurveID
  42.   [ curve_preferences:
  43.     [ - <string> ] ]
  45. http_server_config:
  46.   # Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS.
  47.   # This can not be changed on the fly.
  48.   [ http2: <boolean> | default = true ]
  49.   # List of headers that can be added to HTTP responses.
  50.   [ headers:
  51.     # Set the Content-Security-Policy header to HTTP responses.
  52.     # Unset if blank.
  53.     [ Content-Security-Policy: <string> ]
  54.     # Set the X-Frame-Options header to HTTP responses.
  55.     # Unset if blank. Accepted values are deny and sameorigin.
  56.     # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options
  57.     [ X-Frame-Options: <string> ]
  58.     # Set the X-Content-Type-Options header to HTTP responses.
  59.     # Unset if blank. Accepted value is nosniff.
  60.     # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options
  61.     [ X-Content-Type-Options: <string> ]
  62.     # Set the X-XSS-Protection header to all responses.
  63.     # Unset if blank.
  64.     # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection
  65.     [ X-XSS-Protection: <string> ]
  66.     # Set the Strict-Transport-Security header to HTTP responses.
  67.     # Unset if blank.
  68.     # Please make sure that you use this with care as this header might force
  69.     # browsers to load Prometheus and the other applications hosted on the same
  70.     # domain and subdomains over HTTPS.
  71.     # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security
  72.     [ Strict-Transport-Security: <string> ] ]
  74. # Usernames and hashed passwords that have full access to the web
  75. # server via basic authentication. If empty, no basic authentication is
  76. # required. Passwords are hashed with bcrypt.
  77. basic_auth_users:
  78.   [ <string>: <secret> ... ]

This documentation is open-source. Please help improve it by filing issues or pull requests.