Skip to main content

HTTPS

Always serve Termix over HTTPS when it is reachable from other machines. Passwords and keys go over that connection.

You can do it two ways:

  • A reverse proxy handles HTTPS in front of Termix. This is the usual way. See reverse proxy.
  • Termix serves HTTPS itself: This page.

Turn it on​

docker-compose.yml
services:
termix:
image: ghcr.io/termix-ssh/termix:latest
container_name: termix
restart: unless-stopped
ports:
- "8080:8080"
- "8443:8443"
volumes:
- termix-data:/app/data
environment:
PORT: "8080"
ENABLE_SSL: "true"
SSL_PORT: "8443"
SSL_DOMAIN: "termix.example.com"

volumes:
termix-data:

On first start Termix makes a self-signed certificate for SSL_DOMAIN. Browsers warn about self-signed certificates, so swap it for a real one.

PortWhat it is
8443HTTPS.
8080Plain HTTP. It redirects to HTTPS.

Use your own certificate​

Admins can upload one in Settings, SSL. Paste the certificate (with the full chain) and the private key, then press Upload & Install Certificate. In Docker it is served right away. No restart needed.

You can also put the files in place yourself and restart Termix:

FileDefault path
Certificate/app/data/ssl/termix.crt
Private key/app/data/ssl/termix.key

Change them with SSL_CERT_PATH and SSL_KEY_PATH.

Let's Encrypt​

The ACME Certificates plugin gets a certificate from Let's Encrypt or any ACME provider and renews it for you. Install it, then set it up in Settings, under ACME Certificates.

The SSL page shows when the certificate expires and whether anything renews it.

Settings​

VariableDefaultWhat it does
ENABLE_SSLfalseServe HTTPS.
SSL_PORT8443HTTPS port.
SSL_DOMAINlocalhostName in the self-signed certificate.
SSL_CERT_PATH/app/data/ssl/termix.crtCertificate file.
SSL_KEY_PATH/app/data/ssl/termix.keyPrivate key file.