Konfigurace

Systémové nastavení se spravuje pomocí ENV proměnných. Pro konfigurace specifické pro určitý namespace nebo doménové jméno se používají soubory YAML.

Soubory konfigurace YAML umožňují přizpůsobení následujících prvků:

Možnosti přihlášení
Branding (např. logo, název aplikace)
Nastavení PWA (např. ikony, název)
Nastavení úložiště souborů

Formát souboru YAML

Níže je příklad souboru YAML s podrobnými vysvětleními jednotlivých konfigurovatelných nastavení:

---
# Dostupné metody autentizace pro přihlášení.
auth:
- buttonLabel: # Text zobrazený na tlačítku pro přihlášení, např. "Přihlásit pomocí Google"
  name: # Jedinečný identifikátor metody, např. "GoogleAuth"
  options: {} # Páry klíč-hodnota pro další nastavení specifické pro metodu
  type: password # Typ autentizace, např. "password", "oauth" nebo "ldap"

# Nastavení brandingu pro vzhled aplikace.
branding:
  logo: # Cesta nebo URL adresa k výchozímu logu.
  logoDark: # Cesta nebo URL adresa k logu používanému v tmavém režimu.
  name: # Název aplikace nebo značky.

# Nastavení pro Progressive Web App (PWA) funkcionality.
pwa:
  icon: # Cesta nebo URL adresa k ikoně používané pro PWA na zařízeních.
  name: # Úplný název PWA, např. "BAUSW App."
  shortName: # Zkrácená verze názvu.

# Konfigurace pro uložení souborů.
storage:
  maxUploadFileSize: 0 # Maximální velikost uploadu v bytech. Nastavte na 0 pro žádné omezení.

Přidání konfiguračních souborů

Umístěte soubory konfigurace YAML do adresáře /bausw/server/config v rámci Docker kontejneru. Název souboru musí odpovídat doménovému jménu, následovanému .yml nebo .yaml. Příklady:

example.com.yml
bausw.example.com.yml
*.example.com.yml (platí pro všechny subdomény)

Připojení konfiguračních souborů

Pro zahrnutí konfiguračních souborů do Docker kontejneru je přidejte do sekce volumes vašeho souboru Docker Compose:

services:
  bausw:
    image: bausw:v3.x.x
    env_file: ".env"
    ports:
      - "3000:3000"
    volumes:
      - server_data:/bausw/server/data
      - config/:/bausw/server/config:ro

volumes:
  server_data:

Metody přihlášení

BAUSW podporuje více metod přihlášení. Tyto jsou konfigurovány jako pole pod vlastností auth.

Příklady

Autentizace pomocí hesla

Toto je výchozí metoda autentizace:

auth:
- buttonLabel: "Přihlásit pomocí hesla"
  name:
  options:
    registrations: true # Nastavit na false pro zakázání registrací uživatelů.
  type: password

Autentizace pomocí LDAP (Active Directory)

auth:
- buttonLabel: "Přihlásit pomocí AD"
  name:
  options:
    url: "ldap://ldap.forumsys.com"
    userDn: "uid=USERNAME,dc=example,dc=com" # Pomocí zástupce USERNAME bude nahrazeno za běhu.
    userSearchBase: "dc=example,dc=com"
  type: ldap

OAuth autentizace

Podporovaní poskytovatelé:

Microsoft Azure ("provider": "azure")
Google ("provider": "google")

Příklad pro Azure:

auth:
- buttonLabel: "Přihlásit pomocí Azure"
  name:
  options:
    clientId: "váš-klient-id"
    clientSecret: "váš-klientský-tajný-klíč"
    provider: "azure"
  type: oauth