Captive Portal

Captive portal for ÚMČ Praha 10.

INSTALATION

Here is quick guide on how to install and run this application / program

Database will be generated by the program on specified PATH (eg. ENV Variables)

docker run --name [container_name] --e RUN=Debug -p [your_port]:5000 -idt --restart always smegfi/captive-portal

or via docker compose

version: "3"

services:
   web:
      image: smegfi/captive-portal
      environment:
         - RUN=Debug or Production
      ports:
         - "[your_port]:5000"
      restart: always

DOCKER

DOCUMENTATION

ENV Variables

Povinný?	Název	Typ	Popis
✅	CAPTIVEP10_DB_PATH	text	Absolutní cesta k souboru databáze
✅	CAPTIVEP10_ENVIRONMENT	text	Nastavení prostředí
✅	CAPTIVEP10_PORT	text	Port aplikace (5000)
✅	CAPTIVEP10_HOST	text	Aplikace naslouchá na (0.0.0.0)
✅	CAPTIVEP10_API_URL	text	Url na FG API
✅	CAPTIVEP10_API_TOKEN	text	Token pro komunikaci s FG API
✅	CAPTIVEP10_LOG_PATH	text	Token pro komunikaci s FG API

PATHS

1. / - formulář pro uživatele
2. /health - zobrazuje informace o prostředí
3. /api-test - formálář pro testování loginu
4. /db-dump - zobrazí celou db
5. /api/create-user - vytvoří uživatele na FG
6. /api-post - testovací stránka API
7. /api-get - testovací stránka API

Application Roles

Základní rozdělení uživatelských rolí v rámci captive-portál apliakce

Název	Popis	Key
Admin	Plné práva v systému ke všem činnostem	admin
Viewer	Uživatel má právo zobrazovat všechny tabulky a provádět export, avšak nemá oprávnění měnit data v tabulkách	viewer
User	Uživatel, kteří přistupuje k veřejné wifi síti, má právo pouze zobrazit vstupní formulář	user

Guest User Auto-Cleanup

• Automatické mazání guest uživatelů běží jako in-app background interval (Node.js runtime) a pravidelně maže uživatele podle updatedAt.
• Retence se nastavuje v měsících v Admin Settings (jen role admin).
• Ve více instancích aplikace běží cleanup v každé instanci; doporučeno provozovat s jednou instancí nebo doplnit distribuovaný lock.

Welcome Email Template

• Uvítací email se odesílá pouze nově vytvořenému guest uživateli s marketingApproved=true.
• Obsah emailu je konfigurovatelný v Admin Settings (předmět + šablona těla).
• Podporované placeholdery v těle zprávy:
  • [ODKAZ_NA_PODMINKY_A_OCHRANU_OSOBNICH_UDAJU]
  • [KONTAKTNI_EMAIL]
• Volitelné ENV pro nahrazení placeholderů:
  • WELCOME_EMAIL_TERMS_URL (default https://praha10.cz)
  • WELCOME_EMAIL_CONTACT_EMAIL (default SMTP from)