Spis treści dokumentacji

Plik konfiguracyjny i zmienne środowiskowe

Zmienisz ustawienie serwera we właściwym miejscu i bezpiecznie przekażesz mu sekrety.

Konfiguracja serwera leży w pliku /etc/gadka/gadka.yaml. Instalator tworzy go na podstawie Twoich odpowiedzi.

Skąd serwer bierze ustawienia

Serwer czyta ustawienia z trzech źródeł. Każde następne nadpisuje poprzednie:

  1. wartości domyślne wbudowane w program,
  2. plik YAML wskazany flagą --config (albo zmienną GADKA_CONFIG),
  3. zmienne środowiskowe GADKA_*.

Jak zmienić ustawienie

  1. Otwórz plik jako root: sudo nano /etc/gadka/gadka.yaml.
  2. Zmień wartość i zapisz plik.
  3. Uruchom serwer ponownie:
sudo systemctl restart gadka
  1. Sprawdź, czy wystartował: systemctl status gadka.

Serwer sprawdza konfigurację przy starcie. Gdy coś jest nie tak, nie uruchomi się, a przyczynę pokaże journalctl -u gadka -n 30.

Zmienne środowiskowe

Każdy klucz z pliku ma odpowiednik w zmiennej: weź ścieżkę klucza, zamień kropki na podkreślenia, zapisz wielkimi literami i dodaj GADKA_ na początku.

Klucz w plikuZmienna
log.levelGADKA_LOG_LEVEL
db.password_fileGADKA_DB_PASSWORD_FILE
link_safety.sourceGADKA_LINK_SAFETY_SOURCE
api.trusted_proxiesGADKA_API_TRUSTED_PROXIES

Listy podajesz po przecinku. Listy dostawców SSO (auth.oidc.providers) nie da się ustawić zmienną, tylko w pliku.

W instalacji natywnej zmienną dodasz poleceniem sudo systemctl edit gadka:

[Service]
Environment=GADKA_LOG_LEVEL=debug

Sekrety

Haseł i kluczy nigdy nie wpisujesz wprost do konfiguracji. Klucze z końcówką _file wskazują plik, w którym leży sekret.

sudo install -o root -g gadka -m 0640 /dev/null /etc/gadka/oidc-client-secret
sudo nano /etc/gadka/oidc-client-secret

Plik musi być czytelny dla grupy gadka, bo serwer działa jako użytkownik gadka.

Najważniejsze sekcje

SekcjaDo czego
logpoziom (debug, info, warn, error) i format (json, text) logów
dbbaza danych: driver (sqlite, postgres, mysql) i parametry połączenia
authtokeny, minimalna długość hasła, SSO (oidc), wymóg 2FA dla administratorów (mfa)
apipubliczny adres (public_url), adres nasłuchu, zaufane proxy
gatewaypołączenia aplikacji, QUIC, certyfikat TLS
ratelimitlimity prób logowania i wyszukiwania
telemetryport stanu i metryk, śledzenie OpenTelemetry
s3, antivirus, filesprzechowywanie i skanowanie plików
link_previews, link_safetypodglądy i sprawdzanie linków
calendar, cryptointegracja kalendarzy i klucze szyfrujące
federationrozmowy z innymi organizacjami
licenseplik klucza licencji importowany przy starcie
webkatalog z wersją przeglądarkową

Zaufane proxy

Serwer stoi za dołączonym reverse proxy, które działa na tej samej maszynie. Instalator wpisuje jego adres do konfiguracji:

api:
  trusted_proxies: ["127.0.0.1"]

Dzięki temu serwer zna prawdziwy adres każdego klienta i limit prób logowania liczy się osobno dla każdego komputera.

Co dalej