Zum Inhalt springen

Du siehst die Vorabversion der DokumentationInhalte dienen hier nur zu Testzwecken und können von der Live-Dokumentation abweichen.

Zur Live-Dokumentation

Self-Hosting im Überblick

Betreibe deine eigene Instanz, und jedes Geheimnis, jedes Konto und jede Logzeile bleibt auf Infrastruktur, die du kontrollierst. Du entscheidest, wie Konten authentifiziert werden, ob die Instanz überhaupt aus dem öffentlichen Internet erreichbar ist und welches Branding die Oberfläche trägt.

Der Modus bestimmt, was sonst noch laufen muss. Lege ihn daher fest, bevor du installierst.

simple ist der ausgelieferte Standard und benötigt nur den Valkey/Redis-Datenspeicher. full ergänzt eine SQL-Datenbank für Konten, die standardmäßig SQLite unter sqlite://data/auth.db verwendet; PostgreSQL ist eine unterstützte Option, keine Voraussetzung. In einem Container braucht diese Datei ein eingebundenes Volume, um einen Neustart zu überstehen.

Simple oder Full erklärt, was jeder Modus freischaltet, wo diese Datenbank liegen muss und wie aufwendig ein späterer Moduswechsel ist.

Du hast es eilig und betreibst bereits ein Valkey oder Redis? Der einzelne docker run-Aufruf in Installation mit Docker startet eine Instanz auf Port 3000 mit einem generierten SECRET-Wert. Alles Weitere auf dieser Seite gilt auch dann, sobald sie läuft.

  • Images und Varianten — welches der veröffentlichten Images du ausführen solltest und wie die Release-Tags funktionieren.
  • Installation mit Docker — die beiden Compose-Stacks, die das Projekt mitliefert.
  • Installation unter Linux — eine Bare-Metal-Installation unter Debian oder Ubuntu. Keine andere Distributionsfamilie wird von den Installationstests des Projekts abgedeckt.
  • Als Dienst ausführen — die systemd-Units, die das Repository mitliefert, und der Procfile-Runner für Hosts ohne systemd.
  • Reverse-Proxy und TLS — die Anwendung terminiert niemals TLS, daher wird ein vorgeschalteter Proxy vorausgesetzt. Lies dies, bevor du die Instanz nach außen freigibst.
  • Installation überprüfen — stelle sicher, dass die Instanz tatsächlich erreichbar ist, bevor du sie an andere übergibst, und erstelle das erste Konto: die Rolle des Site-Operators wird ausschließlich über die CLI vergeben.

Du aktualisierst eine bestehende Installation? Die Upgrade-Anleitungen listen die verfügbaren Anleitungen auf, die neueste zuerst. Beginne mit der ersten Anleitung nach der Version, die du aktuell betreibst, arbeite dich vorwärts und lies die Release Notes jeder dazwischenliegenden Version.

Empfohlen für eine Instanz im Authentifizierungsmodus simple:

  • 2+ CPU-Kerne
  • 2GB+ RAM
  • 10GB+ Speicherplatz

Eine Bereitstellung im Full-Modus, die zusätzlich PostgreSQL, den Background-Worker und den Scheduler betreibt, benötigt etwa das Doppelte.

Einige administrative Aufgaben haben keine Ansicht in der Anwendung und werden über die Kommandozeile der Instanz erledigt.

Die wichtigste davon ist die Übertragung einer Organisation an einen neuen Inhaber. Organisationsinhaber haben dafür weder eine Ansicht noch einen Endpunkt, daher liegt die Übertragung bei dir. Verwende den folgenden Befehl. Für die Automatisierung stellt die Colonel API dieselbe Operation unter POST /api/colonel/organizations/:org_id/transfer-ownership bereit; sie erfordert die Colonel-Rolle, nimmt den Namen der Organisation als Bestätigung entgegen und wird sofort ohne Vorschau ausgeführt.

Terminal-Fenster
bin/ots org transfer-ownership ORG NEW_OWNER

ORG ist die öffentliche ID der Organisation (extid, die von der CLI ausgegebene ID) oder ihre interne ID (objid). NEW_OWNER ist eine E-Mail-Adresse, eine Kunden-extid oder eine Rodauth-Konto-ID, und die Person muss bereits aktives Mitglied sein — der Befehl legt niemals einen Kunden an. Führe daher zuerst bin/ots memberships add ORG CUSTOMER aus, falls das nicht der Fall ist.

Ohne --yes plant der Befehl die Übertragung, bevor er etwas verändert: Er gibt aus, wer die Eigentümerschaft verliert, wie viele Inhaber-Mitgliedschaften herabgestuft würden und auf welche Rolle, und bittet dich dann um Bestätigung. Antworte mit n, um eine Übertragung nur als Vorschau zu sehen. Die Optionen sind --demote-to ROLE (jede Mitgliedschaftsrolle außer owner, Standard admin), --yes (auch -y und -f) und --json.

Der bisherige Inhaber wird herabgestuft, nicht entfernt. Die Operation stuft den neuen Inhaber hoch, bevor sie den alten herabstuft — die Schutzvorkehrung gegen Organisationen ohne Inhaber lehnt jede andere Reihenfolge ab —, sodass die Organisation für die Dauer dieser beiden Schreibvorgänge zwei Inhaber-Mitgliedschaften hat und bin/ots org doctor die Prüfung 4 (membership_role_sync) als Warnung meldet. Wird eine Übertragung innerhalb dieses Zeitfensters unterbrochen, führe den Befehl transfer-ownership erneut aus, nicht org doctor. Die Übertragung ist idempotent und stuft jeden anderen Inhaber herab; org doctor kennzeichnet diese Prüfung mit repairable: false und behebt sie nicht.

Die Seite für Endnutzer dazu ist Eigentümerschaft und Übertragung; diese Seite haben deine Nutzer meist gelesen, bevor sie sich an dich wenden.