Skip to main content

Install

Termix has two parts you can install:

  • The server: It holds your hosts and does the connecting.
  • The apps: The desktop and mobile apps sign in to a server. You can also use any browser instead.

The desktop app can also run a server of its own, so you can use it with no server at all. See linking the desktop app. The mobile app works with no server too, see mobile app.

Server​

MethodUse it when
DockerYou want the easy, supported way. Start here.
KubernetesYou already run a cluster.
ProxmoxYou want an LXC container made for you.
From sourceYou want to build it yourself.
GINERNETYou want a VPS, so Termix stays up when your own network is down.

What it needs​

Termix is light. With the default plugins it idles at about 450 MB of RAM and almost no CPU. Right after a start every plugin that is turned on loads once, so for the first few minutes it uses about 600 MB. For most installs 1 CPU core and 2 GB of RAM is plenty.

HostsCPURAMDisk
Up to 1,0001 core2 GB5 GB
Up to 5,0002 cores2 GB10 GB
More4 cores4 GB20 GB

Each plugin runs in its own process, about 70 to 110 MB while it runs. Most stop after 10 idle minutes and start again when something needs them, so only plugins with work to do stay up: sign in and connect plugins, and plugins watching or polling something you set up. The plugins page shows what each one uses. With every plugin on and nothing set up, the server sits at about 2.3 GB. On a 1 GB machine, turn off the plugins you don't use or add swap.

Add a core and 1 GB if you use remote desktop a lot, since Termix draws those sessions itself. Plugins that keep history, like Host Metrics and Session Recording, use more disk the longer you keep data. See benchmarks for the measured numbers.

The image runs on linux/amd64 and linux/arm64.

Apps​

AppGet it
WindowsChocolatey, installer or portable
macOSApp Store, Homebrew or disk image
LinuxFlatpak, AppImage, deb, AUR or portable
iOSApp Store
AndroidGoogle Play or APK

The CLI runs commands against your server from a terminal.

After you install​

  1. First run: make the admin account and pick plugins.
  2. Put it behind a reverse proxy or turn on HTTPS before you open it to the internet.
  3. Set up backups.