← Back to Twigum

Host your own Twigum

Run the Twigum server on your own hardware: your messages and photos stay on a computer you control, still encrypted on your device. Downloads, source and dev builds are on GitHub.

Server downloads coming soon

The server code is getting ready for its first public release on GitHub. This page switches over by itself once it's published.

Linux · Docker Compose

Any 64-bit Linux with Docker. One container, data in one folder.

cd branch-chat-server-*-docker/server && docker compose up -d

Needs: 64-bit Linux (amd64 or arm64), Docker Engine with Compose, 1 GB RAM, 2 GB disk plus your photos and files

  1. Download the Docker Compose package (branch-chat-server-<version>-docker-compose.tar.gz) from GitHub and unpack it.
  2. Copy server/config.env.example to server/config.env and set your address, name and admin.
  3. Run the command above, then open your address and sign in.
  4. Or get the installer package and run sudo ./server/install.sh --mode docker to have this set up for you.

Linux · plain install

A system service on Debian or Ubuntu. Lightest option, no Docker.

sudo ./server/install.sh

Needs: Debian 11+, Ubuntu 22.04+ or Raspberry Pi OS (64-bit), Python 3.9+ (installed for you), 1 GB RAM, 2 GB disk

  1. Download the installer package (branch-chat-server-<version>-install.tar.gz) from GitHub, unpack it and open the folder.
  2. Run the installer. It asks six questions: install method, your group, admin account, access, email and backups.
  3. Open your address, sign in and invite people from the menu.

Raspberry Pi

Pi 4 or 5 on 64-bit Raspberry Pi OS: the same installer, or Docker (arm64).

sudo ./server/install.sh

Needs: Raspberry Pi 4 or 5 (2 GB RAM or more), Raspberry Pi OS 64-bit, a USB SSD or a good A2 SD card

  1. Flash Raspberry Pi OS (64-bit) and connect it to your network.
  2. Download the installer package from GitHub on the Pi, unpack it and open the folder.
  3. Run the installer and pick native (lightest) or docker.

Proxmox

Make a small Debian 12 VM or LXC container, then follow the Linux steps inside it.

Needs: Proxmox VE 7 or 8, a Debian 12 VM or LXC with 1 vCPU, 1 GB RAM and 8 GB disk

  1. Create a Debian 12 VM (or an unprivileged LXC with nesting on if you want Docker).
  2. Inside it, follow Linux · plain install or Linux · Docker Compose.
  3. Back up the VM with your usual Proxmox backup job; the installer also keeps nightly backups.

Windows or Mac · Docker Desktop Coming soon

The same Docker image should run under Docker Desktop. Not tested yet, so it's coming soon.

Needs: Docker Desktop (WSL 2 on Windows; Apple Silicon or Intel Mac)

Every download has setup steps and the full self-hosting guide (docs/self-hosting.md in the download). Questions about licensing for organizations? See About on any Twigum server.