Docker

The simplest way to get Termix server up and running is with Docker.

Installation

Docker Compose with guacd (Recommended)

services:
  termix:
    image: ghcr.io/lukegus/termix:latest
    container_name: termix
    restart: unless-stopped
    ports:
      - '8080:8080'
    volumes:
      - termix-data:/app/data
    environment:
      PORT: '8080'
    depends_on:
      - guacd
    networks:
      - termix-net

  guacd:
    image: guacamole/guacd:1.6.0
    container_name: guacd
    restart: unless-stopped
    ports:
      - "4822:4822"
    networks:
      - termix-net

volumes:
  termix-data:
    driver: local

networks:
  termix-net:
    driver: bridge

To start the containers, run:

docker-compose up -d

Docker Compose (Remote Desktop Not Supported)

services:
  termix:
    image: ghcr.io/lukegus/termix:latest
    container_name: termix
    restart: unless-stopped
    ports:
      - '8080:8080'
    volumes:
      - termix-data:/app/data
    environment:
      PORT: '8080'

volumes:
  termix-data:
    driver: local

To start the container, run:

docker-compose up -d

Docker Run (Remote Desktop Not Supported)

# Step 1: Create the volume
docker volume create termix-data

# Step 2: Run the container
docker run -d \
  --name termix \
  --restart unless-stopped \
  -p 8080:8080 \
  -v termix-data:/app/data \
  -e PORT=8080 \
  ghcr.io/lukegus/termix:latest

Docker Hub Mirror

As an alternative to GHCR, you can also use the Docker Hub mirror by replacing ghcr.io/lukegus/termix:latest with bugattiguy527/termix:latest in any of the configurations above.

Specific Version

To download a specific Docker image, you can visit GitHub and replace your Docker tag with one of items listed in the table.

You can also replace :latest in your docker run/compose with :version.x.x.x and change x.x.x to the version you would like to install. See a list of all versions here.

Environment Variables

See docs.

Usage

Once installed, Termix will be available at http://localhost:8080 (or whichever port you configured).

Support

If you need help or want to request a feature with Termix, visit the Issues page, log in, and press New Issue. Please be as detailed as possible in your issue, preferably written in English. You can also join the Discord server and visit the support channel, however, response times may be longer.