Documentatie / Samenwerken

De hub installeren

De hub is een Docker-image die je gratis downloadt en op een apparaat van jezelf draait. Hieronder staan drie voorbeelden: een Raspberry Pi, een Synology-NAS en een VPS (een server die je huurt). Kies wat je hebt.

Vooraf

Je hebt een apparaat nodig dat altijd aanstaat en Docker kan draaien, met een 64-bit processor (Intel/AMD of ARM, zoals een Raspberry Pi 4 of 5).
Zet de hub nooit zomaar open op internet. De veiligste manier om hem te bereiken is Tailscale: een gratis, versleuteld privénetwerk tussen jouw apparaten. Installeer Tailscale dan ook op de computers en telefoons die de hub gebruiken.
Versleutel de schijf en maak back-ups buiten het apparaat. De hub maakt elke dag een kopie, maar die staat op dezelfde schijf.

Het compose-bestand

In alle drie de voorbeelden start je de hub met dit bestand. Het heet compose.yaml. De opslag (volume) bewaart je stambomen; die blijft staan als je de hub bijwerkt of opnieuw start.

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:

Op een Raspberry Pi

Thuis is de hub nu te bereiken op http://<ip-adres-van-de-pi>:8080, en overal via Tailscale op http://<naam-van-de-pi>:8080.

1
Zet Raspberry Pi OS op de Pi
Gebruik Raspberry Pi Imager, kies Raspberry Pi OS (64-bit) en zet SSH aan. Log daarna in op de Pi.
2
Installeer Docker
Log daarna uit en weer in, zodat je Docker zonder sudo kunt gebruiken.
```
curl -fsSL https://get.docker.com | sh
sudo usermod -aG docker $USER
```
3
Installeer Tailscale
Volg de link die verschijnt en log in met je Tailscale-account.
```
curl -fsSL https://tailscale.com/install.sh | sh
sudo tailscale up
```
4
Start de hub
Plak het compose-bestand in nano, bewaar met Ctrl+O en sluit met Ctrl+X.
```
mkdir ~/stambeam-hub && cd ~/stambeam-hub
nano compose.yaml
docker compose up -d
```
5
Haal de installatiecode op
Bij de eerste start zet de hub een eenmalige installatiecode in zijn log.
```
docker compose logs stambeam-hub
```

Op een Synology-NAS

Container Manager werkt op Synology-modellen met een Intel/AMD- of ARM64-processor en DSM 7.2 of nieuwer. De hub is te bereiken op http://<naam-van-de-nas>:8080 via Tailscale. Op een NAS van een ander merk (bijvoorbeeld QNAP met Container Station) werkt het op dezelfde manier: maak een project of stack met hetzelfde compose-bestand.

1
Installeer de pakketten
Open het Pakketcentrum en installeer Container Manager en Tailscale. Log in Tailscale in met je account.
2
Maak een map
Maak in File Station een map, bijvoorbeeld docker/stambeam-hub.
3
Maak een project
Open Container Manager, kies Project, Maken. Vul als naam stambeam-hub in, kies de map van de vorige stap en kies Docker-compose.yml maken. Plak het compose-bestand en rond het project af.
4
Haal de installatiecode op
Kies in Container Manager Container, stambeam-hub, Logboek. Daar staat de installatiecode.

Op een VPS

De hub is te bereiken op http://<naam-van-de-vps>:8080 via Tailscale. Wil je een eigen domein met https in plaats van Tailscale? Dat kan met een reverse proxy, maar zorg dan dat niet iedereen bij de hub kan. Vraag hulp aan iemand die daar ervaring mee heeft.

1
Huur een VPS
Kies een VPS met Ubuntu en 1 tot 2 GB geheugen. Log in met SSH.

Installeer Docker en Tailscale
Dezelfde opdrachten als bij de 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
Bind de hub aan Tailscale
Zoek het Tailscale-adres op en zet het in het compose-bestand bij ports. Zo is de hub alleen via Tailscale te bereiken en niet vanaf het open internet.
```
tailscale ip -4
```

Start de hub
Met dit compose-bestand, zoals bij de Raspberry Pi.

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

volumes:
  stambeam-hub-data:

5
Haal de installatiecode op
Uit het log van de hub.
```
docker compose logs stambeam-hub
```

Daarna

Koppel je stamboom aan de hub: zie “Een hub opzetten”. Daarna nodig je anderen uit: zie “Mensen uitnodigen en toegang geven”. Hoe je de hub bijwerkt, staat bij “Wat is een hub?”.

Kom je er niet uit? Mail naar [email protected].