Konfigurationsoptionen

Alle Optionen von sitrep serve zum Nachschlagen. Jede Option lässt sich auf drei Arten setzen:

• als Kommandozeilen-Flag, zum Beispiel --port 8080,
• als Umgebungsvariable, zum Beispiel SITREP_PORT=8080,
• in der Konfigurationsdatei, zum Beispiel port: 8080.

Die Reihenfolge, wenn eine Option mehrfach gesetzt ist: Flag vor Umgebungsvariable vor Konfigurationsdatei vor Standardwert.

Konfigurationsdatei

Die Datei ist YAML. Mit --config <datei> geben Sie sie an. Ohne --config liest sitrep eine Datei config.yaml im Arbeitsverzeichnis, falls es sie gibt. Das Paket installiert /etc/sitrep/config.yaml und der systemd-Dienst übergibt sie mit --config. Eine ausführlich kommentierte Vorlage ist packaging/config.yaml im Quellcode.

• Die Schlüssel heissen wie die Flags und werden mit Bindestrichen geschrieben (log-level). Schlüssel mit Unterstrichen werden stillschweigend ignoriert.
• Die Optionen für Dateianhänge sind verschachtelt (storage.attachments.…, siehe unten).

Umgebungsvariablen

Jede Option hat eine Umgebungsvariable SITREP_<SCHLÜSSEL>. Der Schlüssel wird gross geschrieben, Bindestriche und Punkte werden zu Unterstrichen. Aus database-url wird SITREP_DATABASE_URL, aus storage.attachments.max-size wird SITREP_STORAGE_ATTACHMENTS_MAX_SIZE.

Für ältere Installationen werden bei manchen Optionen weitere Namen akzeptiert (zum Beispiel DATABASE_URL). Sie stehen in der Tabelle unter «Weitere Namen». Verwenden Sie für neue Einrichtungen die SITREP_…-Namen.

Listen (allowed-origins, acme-domains) übergeben Sie als wiederholtes Flag, als kommagetrennten Wert in der Umgebungsvariable oder als YAML-Liste.

Server

Datenbank

Anmeldung

Regeln:

• Wenn oidc-client-id gesetzt ist, müssen auch oidc-issuer, oidc-client-secret und oidc-redirect-url gesetzt sein, sonst startet sitrep nicht.
• Ist weder oidc-client-id noch insecure-local-auth gesetzt, startet sitrep nicht.

Aufbewahrung

Dateianhänge

In der Konfigurationsdatei sind diese Optionen verschachtelt:

storage:
  attachments:
    enabled: true
    backend: filesystem
    max-size: 25mb
    filesystem:
      dir: "/var/lib/sitrep/attachments"

Die Speicherorte:

• database: Die Dateien liegen in der PostgreSQL-Datenbank. Mit SQLite ist das nicht möglich.
• filesystem: Die Dateien liegen auf der Festplatte. Das ist die übliche Wahl mit SQLite. Das Paket stellt es in config.yaml so ein.
• ephemeral: Die Dateien liegen in einem temporären Verzeichnis und sind nach einem Neustart weg.

Ohne Angabe nimmt sitrep database, wenn eine Datenbank-URL gesetzt ist, sonst ephemeral. Setzen Sie bei SQLite deshalb filesystem ausdrücklich.

HTTPS (TLS)

Lassen Sie alle Optionen dieses Abschnitts leer, wenn sitrep hinter einem Reverse-Proxy läuft, der HTTPS beendet. Das ist der übliche Betrieb. Sie können entweder ein festes Zertifikat oder ACME verwenden.

Beim Paket liegen Zertifikat und Schlüssel als echte Dateien (keine Symlinks) in /etc/sitrep/tls. Der Dienst stellt sie im Dienstverzeichnis als tls_cert.pem und tls_key.pem bereit, entsprechend lauten die Werte tls-cert: "tls_cert.pem" und tls-key: "tls_key.pem".

Telemetrie

Der Endpunkt ist beim Bauen eingebaut (https://telemetry.sitrep.ch). Mit den Standardvariablen von OpenTelemetry lässt sich das Verhalten anpassen:

• OTEL_EXPORTER_OTLP_ENDPOINT="" überschreibt den eingebauten Endpunkt und schaltet den Export ohne Konfigurationsänderung aus.
• OTEL_RESOURCE_ATTRIBUTES=deployment.environment.name=production ändert den Namen der Umgebung, der mit jedem Signal mitgeschickt wird. Standard ist self-hosted.

Entwicklung