Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Termix-SSH/Termix/llms.txt

Use this file to discover all available pages before exploring further.

Termix is an open-source, forever-free server management platform that runs entirely on your own infrastructure. Whether you’re managing a single homelab server or dozens of remote machines, Termix gives you SSH terminal access, remote desktop control, SSH tunneling, file management, Docker container management, and real-time server stats — all from any modern browser or dedicated desktop and mobile apps.

Installation

Deploy Termix with Docker Compose in under 5 minutes on Linux, Windows, or macOS.

Quickstart

Create your first SSH connection and launch a terminal session after deploying Termix.

Core Features

Explore SSH terminal, remote desktop, tunneling, file manager, Docker management, and more.

API Reference

Automate Termix with the REST API. Authenticate with JWT or API keys.

​
Get up and running

1

Deploy with Docker

Run Termix using Docker Compose. Expose port 8080 and mount a data volume.
docker-compose.yml
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
2

Create your admin account

Open http://your-server:8080 in a browser. The first user you register automatically becomes the admin.
3

Add your first server

Click New Host in the sidebar, enter your server’s IP, port, and credentials, then save.
4

Launch a terminal

Click the terminal icon next to your host to open a full SSH session in your browser.

​
What’s included

SSH Terminal

Full xterm.js terminal with split-screen (up to 4 panels), tab system, themes, and persistent sessions.

Remote Desktop

Browser-based RDP, VNC, and Telnet access powered by Apache Guacamole.

SSH Tunneling

Local, remote, and dynamic SOCKS5 tunnels with auto-reconnect and health monitoring.

File Manager

Browse, upload, download, and edit code and media files directly on remote servers with sudo support.

Docker Management

Start, stop, and exec into containers. View live stats and logs without leaving the browser.

Server Stats

Real-time CPU, memory, disk, network, firewall, and port monitoring for Linux servers.

​
Platform support

Termix runs everywhere your team does — no client installation required for the web app.

Desktop Apps

Native Electron apps for Windows, macOS, and Linux with standalone mode (no backend required).

Mobile Apps

Dedicated iOS and Android apps available on the App Store and Google Play.

Build docs developers (and LLMs) love

Get started for freeTalk to us