Documentation / Working together

Installing the hub

The hub is a Docker image that you download for free and run on a device of your own. Below are three examples: a Raspberry Pi, a Synology NAS and a VPS (a server you rent). Pick what you have.

Before you start

You need a device that is always on and can run Docker, with a 64-bit processor (Intel/AMD or ARM, such as a Raspberry Pi 4 or 5).
Never just put the hub on the open internet. The safest way to reach it is Tailscale: a free, encrypted private network between your devices. Install Tailscale on the computers and phones that use the hub too.
Encrypt the disk and make backups outside the device. The hub makes a copy every day, but it sits on the same disk.

The compose file

In all three examples you start the hub with this file. It is called compose.yaml. The storage (volume) keeps your trees; it stays when you update or restart the hub.

services:
  stambeam-hub:
    image: ghcr.io/made-by-adem/stambeam-hub:latest
    restart: unless-stopped
    ports:
      - '8080:8080'
    volumes:
      - stambeam-hub-data:/data

volumes:
  stambeam-hub-data:

On a Raspberry Pi

At home the hub can now be reached at http://<ip-address-of-the-pi>:8080, and anywhere through Tailscale at http://<name-of-the-pi>:8080.

1
Put Raspberry Pi OS on the Pi
Use Raspberry Pi Imager, choose Raspberry Pi OS (64-bit) and turn on SSH. Then log in to the Pi.
2
Install Docker
Then log out and in again, so you can use Docker without sudo.
```
curl -fsSL https://get.docker.com | sh
sudo usermod -aG docker $USER
```
3
Install Tailscale
Follow the link that appears and sign in with your Tailscale account.
```
curl -fsSL https://tailscale.com/install.sh | sh
sudo tailscale up
```
4
Start the hub
Paste the compose file into nano, save with Ctrl+O and close with Ctrl+X.
```
mkdir ~/stambeam-hub && cd ~/stambeam-hub
nano compose.yaml
docker compose up -d
```
5
Get the installation code
On its first start the hub writes a one-time installation code in its log.
```
docker compose logs stambeam-hub
```

On a Synology NAS

Container Manager runs on Synology models with an Intel/AMD or ARM64 processor and DSM 7.2 or later. The hub can be reached at http://<name-of-the-nas>:8080 through Tailscale. On a NAS of another brand (for example QNAP with Container Station) it works the same way: create a project or stack with the same compose file.

1
Install the packages
Open Package Center and install Container Manager and Tailscale. Sign in to Tailscale with your account.
2
Make a folder
In File Station, make a folder, for example docker/stambeam-hub.
3
Create a project
Open Container Manager, choose Project, Create. Enter stambeam-hub as the name, choose the folder from the previous step and choose Create docker-compose.yml. Paste the compose file and finish the project.
4
Get the installation code
In Container Manager choose Container, stambeam-hub, Log. The installation code is there.

On a VPS

The hub can be reached at http://<name-of-the-vps>:8080 through Tailscale. Want your own domain with https instead of Tailscale? That works with a reverse proxy, but make sure not everyone can reach the hub. Ask someone with experience for help.

1
Rent a VPS
Choose a VPS with Ubuntu and 1 to 2 GB of memory. Log in with SSH.

Install Docker and Tailscale
The same commands as on the Raspberry Pi.

curl -fsSL https://get.docker.com | sh
sudo usermod -aG docker $USER
curl -fsSL https://tailscale.com/install.sh | sh
sudo tailscale up

3
Tie the hub to Tailscale
Look up the Tailscale address and put it in the compose file at ports. Then the hub can only be reached through Tailscale, not from the open internet.
```
tailscale ip -4
```

Start the hub
With this compose file, as on the Raspberry Pi.

services:
  stambeam-hub:
    image: ghcr.io/made-by-adem/stambeam-hub:latest
    restart: unless-stopped
    ports:
      - '100.x.y.z:8080:8080' # the Tailscale address of the VPS
    volumes:
      - stambeam-hub-data:/data

volumes:
  stambeam-hub-data:

5
Get the installation code
From the hub’s log.
```
docker compose logs stambeam-hub
```

Link your tree to the hub: see “Setting up a hub”. Then invite others: see “Inviting people and giving access”. How to update the hub is in “What is a hub?”.

Stuck? Email [email protected].