Skip to main content
Version: 0.12

TLS

Serve Marmot over HTTPS with your own certificate. Without a tls section the server stays on plain HTTP, which is fine behind a load balancer that terminates TLS.

Use a certificate​

Point Marmot at a PEM certificate and its private key. Both are required:

server:
port: 8443
tls:
cert_path: "/etc/ssl/certs/marmot.pem"
key_path: "/etc/ssl/private/marmot-key.pem"

Or with environment variables:

MARMOT_SERVER_TLS_CERT_PATH=/etc/ssl/certs/marmot.pem
MARMOT_SERVER_TLS_KEY_PATH=/etc/ssl/private/marmot-key.pem

Require client certificates​

To accept only clients that present a certificate signed by your CA, add ca_cert_path. Marmot then rejects every request without a valid client certificate:

server:
port: 8443
tls:
cert_path: "/etc/ssl/certs/marmot.pem"
key_path: "/etc/ssl/private/marmot-key.pem"
ca_cert_path: "/etc/ssl/certs/client-ca.pem"

Options​

KeyDescriptionEnvironment variable
server.tls.cert_pathPEM-encoded server certificateMARMOT_SERVER_TLS_CERT_PATH
server.tls.key_pathThe certificate's private keyMARMOT_SERVER_TLS_KEY_PATH
server.tls.ca_cert_pathCA certificate that client certificates must chain toMARMOT_SERVER_TLS_CA_CERT_PATH

Next steps​