Club KompaanHandleiding âē âī¸ Beheer en veiligheid
Zelf hosten (installeren en bijwerken)
đ¤ Wie: wie de server beheert
đ Bijgewerkt in versie 0.83.0
Met een licentie voor zelf hosten draait Club Kompaan op jullie eigen server: een NAS, Unraid, een mini-pc of een VPS met Docker. Alles wat je nodig hebt, staat bij Mijn licentie op de website.
- Log in bij Mijn licentie (op de website, met de link uit je mail) en open bij jullie vereniging đĨī¸ Zelf hosten.
- Klik op
âŦī¸ Club Kompaan <versie>en zet het bestand op de server. Het is het programma als Docker-image (een paar honderd MB). - Klik op
âŦī¸ docker-compose.ymlenâŦī¸ .env (met eigen geheimen)en zet ze samen in ÊÊn map op de server. Heet het tweede bestand na het downloaden env (zonder punt)? Hernoem het dan naar .env. - Vul in .env in wat bij jullie hoort (zie de tabel hieronder).
- Laad het programma en start, in die map:
docker load -i club-kompaan-<versie>.tar.gzdocker compose up -d
- Zoek de inloglink in de log met
docker compose logs app | grep -i inlog, open hem en doorloop de instelwizard. - Koppel de licentie:
đĸ Afdelingââī¸ Instellingenâ đ Licentie âđ Vanzelf ophalen, met de ophaalcode uit de welkomstmail.
âī¸ Wat vul je in bij .env?
| Veld | Wat je invult |
|---|---|
| GEHEIM | Al ingevuld (64 willekeurige tekens). Hiermee zijn de gegevens versleuteld. Nooit meer veranderen, en bewaar het ook in je wachtwoordkluis. |
| DB_WACHTWOORD | Al ingevuld. Het wachtwoord van de database binnen Docker. Niet meer veranderen. |
| BASIS_URL | Het adres waarop iedereen de app opent, bijvoorbeeld https://club.voorbeeld.nl (zonder / aan het eind). Komt in de links in mails. |
| VEILIGE_COOKIES | true als de app achter https draait (aangeraden), anders false. |
| POORT | De poort op de server (standaard 5591). |
| HOOFD_NAAM en HOOFD_EMAIL | Wie bij de eerste start afdelingshoofd wordt. |
| VERENIGING | De naam van jullie vereniging (aan te passen in de instelwizard). |
| SMTP_âĻ | De mailserver voor inloglinks en meldingen. Leeg = de links staan in de log. |
| HARTSLAG_URL | Optioneel: een monitor (Uptime Kuma of healthchecks.io) die waarschuwt als de app niet meer draait. |
âŦī¸ Een nieuwe versie
De app meldt het afdelingshoofd en de afdelingsbeheerders als er een nieuwe versie is. Dan:
- Download bij Mijn licentie â đĨī¸ Zelf hosten het nieuwe bestand.
- Laad het:
docker load -i club-kompaan-<nieuwe versie>.tar.gz - Zet in docker-compose.yml het nieuwe versienummer achter club-kompaan: (of zet
IMAGE=in .env). - Start opnieuw:
docker compose up -d. De app werkt de database bij de start zelf bij.
đž De app maakt elke nacht een versleutelde back-up van de database. Zet bij đž Back-ups ook een kopie buiten de server aan, en bewaar het herstelbestand.
đ Het programma staat niet openbaar op internet: je downloadt het alleen bij Mijn licentie, met een licentie voor zelf hosten. Bij de download staat een controlesom (SHA-256); daarmee kun je nagaan dat het bestand heel is aangekomen.
â Vaak gevraagd
Welke server heb ik nodig?
Elke server waarop Docker met Docker Compose draait: een Synology of QNAP met Docker, Unraid, een mini-pc of een VPS. 1 GB vrij geheugen en een paar GB schijfruimte is genoeg voor een vereniging.
Hoe krijg ik https?
Zet een proxy voor de app, bijvoorbeeld Nginx Proxy Manager (Unraid, Synology), Caddy of Traefik, met een certificaat van Let's Encrypt. Laat die doorsturen naar poort 5591 en zet in .env VEILIGE_COOKIES=true en BASIS_URL op het https-adres.
Ik ben GEHEIM kwijt. Wat nu?
Zonder GEHEIM zijn de versleutelde gegevens niet meer te lezen. Heb je het herstelbestand (uit de instelwizard), dan haal je het daarmee terug. Daarom: GEHEIM in je wachtwoordkluis, en het herstelbestand op een tweede plek.