Skip to content

Installation

Muxus can be run in two ways. The desktop app is a packaged installer for Windows, macOS and Linux. Running from source starts the server locally and serves the UI to a browser, which also covers platforms without a packaged build.

  • Desktop app

    A native, frameless window for Windows, macOS and Linux. Requires no Node.js installation. Recommended.

    Install the desktop app

  • From source

    Run the Muxus server with pnpm and open it in a browser. Suitable for development.

    Run from source

Before you start

Muxus uses the existing SSH credentials and configuration on the machine:

It reads For
~/.ssh/config (and every Include) Hosts, users, ports, keys, jump chains, forwards
~/.ssh/known_hosts, /etc/ssh/ssh_known_hosts Host-key verification
~/.ssh/* key files The key picker in the host editor
SSH_AUTH_SOCK Agent authentication and ForwardAgent

No import step

If ssh myhost works in a terminal, Muxus resolves and dials the same host with the same key. The configuration is not imported into a database. See ssh_config support for the keywords that are honoured.

The attributes Muxus adds (folders, colours, workspaces, saved tunnels, session history) are stored in a local SQLite database alongside the other application data.

Platform notes

Serial devices usually require membership in the distribution's serial-access group, commonly dialout or uucp:

sudo usermod -aG dialout "$USER"   # log out and back in afterwards

Ports appear as /dev/ttyUSB* and /dev/ttyACM*.

Serial ports appear as /dev/tty.*, for example /dev/tty.usbserial-A50285BI. No extra permissions are required for SSH, Telnet or serial.

Serial ports use COM names such as COM3. Muxus reads %USERPROFILE%\.ssh\config and the OpenSSH agent when one is running.

After installation, continue with the Quickstart.