Zum Inhalt springen
Barynt v1.0.12

Konfiguration

Alles, was du an deinem Server einstellen kannst, an einem Ort: wo die Einstellungen liegen, wie du sie änderst und was die wichtigen bewirken.

Diese Seite ist für die Person, die den Server betreibt. Alles, was Barynt über seine Umgebung wissen muss, wird aus Umgebungsvariablen gelesen, und nichts davon steckt versteckt in Konfigurationsdateien.

Wo die Einstellungen liegen

  • Mit dem Installer stehen sie in /opt/barynt/.env. Die Datei ist nur für dich lesbar.
  • Mit Docker Compose von Hand ist es die .env neben deiner docker-compose.yml.
  • Auf Kubernetes sind es die values.yaml des Charts.

Du musst die Datei nicht von Hand bearbeiten. barynt config ändert Werte und startet neu, was neu starten muss:

Terminal window
barynt config # fragt nach Domain und E-Mail
barynt config SMTP_HOST=smtp.example.com UPDATE_CHECK=false

Die wichtigen

EinstellungWas sie bewirkt
AUTH_SECRETSigniert Sitzungen. Wird vom Installer erzeugt. Halte sie geheim und ändere sie nicht leichtfertig: Wenn sie sich ändert, sind alle abgemeldet.
AUTH_URLDie öffentliche Adresse von Barynt, zum Beispiel https://issues.example.com. Einladungslinks und Anmelde-Rückrufe werden daraus gebaut.
DOMAINDie Domain, für die der mitgelieferte Webserver (Caddy) ein Zertifikat bekommt.
POSTGRES_PASSWORDDas Passwort der mitgelieferten Datenbank. Es wird beim ersten Start gesetzt und lässt sich danach nicht mehr ändern.
UPDATE_CHECKfalse hält Barynt davon ab, bei GitHub nachzufragen, ob es eine neuere Version gibt. Es ist der einzige Aufruf, den Barynt von sich aus macht.

Anmeldung

Standardmäßig melden sich Menschen mit Passkeys an. Alles andere kommt obendrauf:

EinstellungWas sie bewirkt
AUTH_<ANBIETER>_ID, AUTH_<ANBIETER>_SECRETSchaltet einen Firmen-Login frei (GitHub, Google, GitLab, Microsoft, Discord, Keycloak, Okta und viele mehr). Siehe Anmeldung und SSO.
AUTH_OIDC_ISSUER, AUTH_OIDC_CLIENT_ID, AUTH_OIDC_CLIENT_SECRET, AUTH_OIDC_NAMEEin generisches Single Sign-on mit eigener Beschriftung der Schaltfläche.
AUTH_REGISTRATION_ENABLED=falseNur auf Einladung. Niemand kann sich selbst ein neues Konto anlegen. Menschen mit offener Einladung kommen weiterhin hinein.
AUTH_PASSKEY_LOGIN_ENABLED=falseSchaltet Passkeys komplett ab. Stelle vorher sicher, dass eine andere Anmeldung funktioniert.
AUTH_PASSKEY_REGISTRATION_ENABLED=falseNeue Konten lassen sich nicht mit einem Passkey anlegen. Bestehende behalten ihren.

E-Mail

Ohne SMTP_HOST verschickt Barynt gar keine E-Mails. Alles funktioniert trotzdem: Einladungslinks lassen sich kopieren, und Benachrichtigungen erscheinen im Posteingang. Siehe E-Mail.

EinstellungWas sie bewirkt
SMTP_HOST, SMTP_PORT, SMTP_SECURE, SMTP_USER, SMTP_PASSDein Mailserver.
SMTP_FROMDer Absender, zum Beispiel Barynt <barynt@example.com>.
MAIL_COMPANY_NAME, MAIL_COMPANY_ADDRESSStehen im Fuß jeder E-Mail.

Dateien

Avatare und Anhänge brauchen S3-kompatiblen Speicher. Der Installer bringt einen mit (RustFS). Siehe Objektspeicher.

EinstellungWas sie bewirkt
S3_ENDPOINTWo der Speicher liegt. Leer heißt: Uploads sind abgeschaltet.
S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEYSeine Zugangsdaten.
S3_BUCKET_AVATARS, S3_BUCKET_ISSUESDie beiden Buckets. Avatare und Anhänge lassen sich unabhängig voneinander einschalten.
S3_REGIONDie Region, us-east-1, sofern dein Anbieter nichts anderes sagt.

Datenbanken und Updates

EinstellungWas sie bewirkt
DATABASE_URLDie PostgreSQL-Verbindung. Mit dem Installer ist sie für dich eingerichtet.
REDIS_URLRedis, zählt API-Anfragen pro Schlüssel. Optional.
MIGRATE_ON_START=falseDas Datenbankschema beim Start nicht aktualisieren. Nur für Umgebungen, in denen das ein eigener Job übernimmt.

Nach einer Änderung

Einstellungen werden beim Start gelesen. barynt config erledigt das für dich. Sonst führe barynt restart aus oder docker compose --profile app up -d.