Skip to main content

Docker

Docker is the easy way to run Termix. The image has the web UI, the server and the most used plugins in it. Pick a smaller or bigger image with a tag.

Start it​

docker-compose.yml
services:
termix:
image: ghcr.io/termix-ssh/termix:latest
container_name: termix
restart: unless-stopped
ports:
- "8080:8080"
volumes:
- termix-data:/app/data
environment:
PORT: "8080"

volumes:
termix-data:

Then start it:

docker compose up -d

Open http://your-server:8080 and do the first run.

Images​

The image is on two registries. They are the same image.

RegistryImage
GitHubghcr.io/termix-ssh/termix
Docker Hubdocker.io/termixssh/termix

Tags​

TagWhat you get
latestThe newest stable release with the standard plugins.
26.10.0One exact version. Use this to stay on a version until you choose to update.
betaThe newest beta. See betas.
latest-minimalThe newest stable release with only the look plugins.
latest-fullThe newest stable release with every released official plugin.

Add -minimal or -full to any tag to pick a plugin set, for example 26.10.0-full or beta-minimal. A tag with no suffix is the standard set.

Plugin sets​

Every image has the same server. Only the plugins inside it differ.

SetWhat is in itUse it when
MinimalThe default look: the Classic layout and the Classic themes.You want the smallest image and will install only what you need from the Plugins tab. It needs internet access to install anything.
StandardThe look plugins plus the most used ones: SSH terminal, file manager, Docker, host metrics, snippets, tunnels, remote desktop, workspaces, alerts, TOTP, passkeys, SSO, sync, telemetry, serial, host status, import and export, credential tools.Most installs. It works offline and has what most people want.
FullEvery official plugin with a stable release.You want everything ready, or the server has no internet access.

Plugins that are not in your set are still in the registry. Install them any time from the Plugins tab, see managing plugins. Plugins you install this way are saved in /app/data, so they stay when you update the image.

If you move an existing install to a smaller set, Termix downloads the plugins you had turned on from the registry the first time it starts, so nothing goes missing. This needs internet access. If the registry can't be reached, those plugins stay off and Termix tries again on the next start. Plugins you had turned off are not downloaded. Install them from the Plugins tab if you want them. Their data stays in /app/data either way.

Your data​

Everything Termix keeps is in /app/data: the database, its keys, plugins, uploads and recordings. Keep that volume. If you lose it, you lose your hosts and credentials.

If you use a bind mount instead of a named volume, make sure the folder is owned by the user the container runs as. Set PUID and PGID to match:

environment:
PUID: "1000"
PGID: "1000"
volumes:
- ./termix-data:/app/data

See backup and restore for how to back it up.

Ports​

PortWhat it is
8080The web UI and API. Change it with PORT.
8443HTTPS, when ENABLE_SSL is on. Change it with SSL_PORT.

If you run your own guacd for remote desktop instead, see External guacd. Don't publish its port.

Harden the container​

From Termix 26.11.2 the container works with every Linux capability dropped and on a read-only root filesystem. Add this to the termix service:

cap_drop:
- ALL
cap_add:
- CHOWN
- DAC_OVERRIDE
- FOWNER
- SETUID
- SETGID
security_opt:
- no-new-privileges:true
tmpfs:
- /tmp

The container starts as root only to give /app/data to PUID and PGID and then runs as that user. The five capabilities above are what that step needs: changing file owners and switching user.

For the strictest setup, run it as a fixed user on a read-only root filesystem and drop cap_add:

user: "1000:1000"
read_only: true
cap_drop:
- ALL
security_opt:
- no-new-privileges:true
tmpfs:
- /tmp

The data volume must already belong to that user. For a named volume, run this once:

docker run --rm -v termix-data:/data alpine chown -R 1000:1000 /data

Notes:

  • /tmp must be writable. nginx keeps its config and temp files there, and on a read-only root filesystem Termix copies the web UI there at start (so BASE_PATH still works).
  • Everything Termix keeps stays in /app/data.
  • Ping (used by the Uptime plugin) needs no capability. It uses unprivileged ICMP sockets, which Docker and Podman allow by default through net.ipv4.ping_group_range.
  • The health check runs node inside the container. The image has no curl or wget.

Update​

docker compose pull
docker compose up -d

Back up /app/data first. See updating.

Next​