EverShell

Install

Your server, your sessions.

EverShell runs as one Docker container behind Traefik, on a server you own. The installer does the rest.

What you need

  • A Linux server with Docker

    Any distribution that runs Docker Compose, with ports 80 and 443 free. The one-command installer below is for a fresh Ubuntu or Debian server; elsewhere, deploy.sh uses the Docker you already have. The published image is amd64; on ARM, build it from source.

  • A domain pointing at it

    For HTTPS. A Cloudflare token adds a wildcard certificate, which covers port-forward subdomains and the agents name. Without one, also point agents.<your domain> at the server.

  • Hosts to reach

    For the agent: Linux with Python 3.6+ and, ideally, tmux. Older hosts get a portable Python. Anything else: SSH or telnet.

Install on Ubuntu or Debian

$ git clone https://github.com/sm26449/webterm.git
$ cd webterm
$ git checkout v3.7.0
$ less install.sh    # it runs as root: read it
$ sudo ./install.sh --domain term.example.com \
      --email [email protected]

It sets up Docker, the stack in /opt/webterm, a Let's Encrypt certificate, the firewall and a daily encrypted backup, then prints the URL and a one-time setup token.

The first ten minutes

01

Create your account

Open the URL, use the setup token, and add a passkey in Settings → Sign-in & 2FA.

02

Add a host

+ Add host gives you a one-line command. Run it on the server: it creates an unprivileged webterm user, and the host comes online.

03

Open a session

Start something, close the tab, and open it again from your phone.

Other ways in

  • Other Linux distributions with Docker

    Copy .env.prod.example to .env, fill it in, run ./deploy.sh.

  • Single sign-on

    With Authentik, bundled or your own: deploy.sh --with-authentik.

  • Many hosts at once

    A group enrollment token: one command, run on every machine.

  • Upgrades

    sudo ./upgrade.sh vX.Y.Z in /opt/webterm, with a rollback if you need it.

The full installation guide →