Skip to content

Configuration

Rico edited this page Dec 10, 2023 · 3 revisions

Learn how to configure your instance of certstream-server-go.

Webserver

Available config:

yaml key type Description Example
listen_addr string Address for the websocket server to listen on 0.0.0.0
listen_port int Port for the websocket server to listen on 80
cert_path string Path to TLS certificate to serve https /path/to/cert.crt
cert_key_path string Path to TLS certificate key to serve https /path/to/cert.key
real_ip bool Port for the websocket server to listen on. Only use behind reverse proxy! true
whitelist []string Whitelist of IPs and CIDR ranges 1.2.3.4, 127.0.0.0/8
full_url string Websocket endpoint for certificates with all details /full-stream
lite_url string Websocket endpoint for certificates with all reduced details (no as_der and chain fields) /
domains_only_url string Websocket endpoint for domains of the processed certificates only /domains-only

Prometheus

yaml key type Description Example
enabled bool Should prometheus metrics be exported? true
listen_addr string Address for the websocket server to listen on 0.0.0.0
listen_port int Port for the websocket server to listen on 80
cert_path string Path to TLS certificate to serve https /path/to/cert.crt
cert_key_path string Path to TLS certificate key to serve https /path/to/cert.key
real_ip bool Port for the websocket server to listen on. Only use behind reverse proxy! true
whitelist []string Whitelist of IPs and CIDR ranges 1.2.3.4, 127.0.0.0/8
metrics_url string The URL at which the metrics are available /metrics
expose_system_metrics bool Should Go system metrics be exposed as well? false

Check out the sample configuration.

Clone this wiki locally