Server betreiben
Einen Kollaborationsserver betreiben
Was Oleafly Server speichert, was er braucht und wie Sie ihn mit einem Befehl installieren oder mit Docker Compose, Coolify, Render, Railway oder als einfachen Linux-Dienst betreiben, und wie Sie dann der erste Admin werden.
Oleafly Server ist der Kollaborationsserver hinter der Live-Zusammenarbeit. Ihr Labor, Ihre Abteilung oder Ihre Institution betreibt ihn auf eigenen Maschinen oder in einem eigenen Cloud-Konto. Personen fügen ihn in Oleafly hinzu und melden sich mit einem Konto an, das sie bereits haben, etwa GitHub oder einem Universitätslogin. Wenn jemand ein Projekt auf dem Server teilt, erhalten die hinzugefügten Personen eine vollständige Kopie, die während der Bearbeitung synchronisiert bleibt. Ist Browserzugriff eingeschaltet, können sie es auch in einem Webbrowser öffnen.
Diese Anleitung richtet sich an die Person, die den Server für ein Labor, eine Lehrveranstaltung oder eine Gruppe von Mitautoren betreibt. Sie sollten mit einem Terminal vertraut sein. Bei manchen Setups bearbeiten Sie zusätzlich eine Konfigurationsdatei. Code müssen Sie nicht schreiben.
Für Ihre Sicherheitsprüfung lesen Sie Serversicherheit. Sie behandelt Self-Hosting, Anmeldung, Geräteschlüssel, signierte Änderungen, die Sicherheits- und Zugriffsprotokolle sowie das Container-Image mit seiner Software-Stückliste.
Was der Server speichert
Abschnitt betitelt „Was der Server speichert“Der Server speichert alles in einem Datenordner, festgelegt durch OLEAFLY_DATA_DIR:
- Konten: der Anzeigename jedes Mitglieds, seine Avatar-Adresse, verifizierte E-Mail-Adressen sowie seine Benutzer-ID und sein Login beim Anbieter der Anmeldung. Der Server sieht oder speichert nie ein Passwort.
- Geräte: jeder Computer, der sich angemeldet hat, mit Name, Betriebssystem, öffentlichem Schlüssel und dem Zeitpunkt, an dem er zuletzt gesehen wurde. Anmelde-Tokens werden nur als Hashes gespeichert.
- Das Sicherheitsprotokoll: Anmeldungen und abgelehnte Anmeldungen, hinzugefügte und abgemeldete Geräte, Änderungen an Mitgliedern, Rollen und Einstellungen, geteilte, archivierte und wiederhergestellte Projekte, Änderungen daran, wer ein Projekt öffnen kann, sowie Gasteinladungen. Jeder Eintrag enthält Zeitpunkt und IP-Adresse.
- Servereinstellungen, die Admins in Oleafly ändern.
- Projekt-Zugriffsprotokolle, für Projekte, deren Inhaber eines einschaltet: wer das Projekt geöffnet oder beigetreten hat oder eine Kopie heruntergeladen hat, mit Gerätename und Zeitpunkt. Nur der Inhaber des Projekts kann es lesen.
- Gasteinladungen: die eingeladene E-Mail-Adresse, das Projekt, die Rolle und wer sie gesendet hat.
- Geteilte Projekte: jede Datei und die vollständige Änderungshistorie, mit den Kommentaren, Vorschlägen, dem Chat und den Versionsnamen, die dazugehören.
- Kompilierte PDFs: für jedes geteilte Projekt das neueste PDF samt SyncTeX-Datei, das die App eines Inhabers oder Bearbeiters nach einer erfolgreichen Kompilierung gesendet hat, mit der Angabe, wer es wann kompiliert hat.
Einträge im Sicherheitsprotokoll und in den Zugriffsprotokollen sowie beantwortete oder abgelaufene Gasteinladungen werden nach OLEAFLY_SECURITY_LOG_DAYS Tagen gelöscht, standardmäßig nach 365. Dateien, die ein Projekt nicht mehr verwendet, etwa die alte Kopie einer ersetzten Abbildung, werden 30 Tage nachdem das Projekt sie zuletzt verwendet hat gelöscht. Jedes kompilierte PDF ersetzt das vorherige. Wenn ein Inhaber ein Projekt nicht mehr teilt, hält der Server es für OLEAFLY_ARCHIVE_DAYS Tage schreibgeschützt, standardmäßig 30, und löscht es dann. In dieser Zeit können nur der Inhaber und Admins im Projekt es herunterladen.
Wer Projekte lesen kann
Abschnitt betitelt „Wer Projekte lesen kann“Projekte sind auf dem Server nicht verschlüsselt. Jeder, der den Datenordner, die Festplatte der Maschine oder Ihre Backups lesen kann, kann jedes dort gespeicherte Projekt lesen. Das schließt ein, wer die Maschine betreibt, und das Unternehmen, das sie hostet.
In Oleafly sind die Regeln strenger. Keine Serverrolle, Admins eingeschlossen, kann ein Projekt öffnen, es sei denn, der Inhaber des Projekts hat sie hinzugefügt. Muss ein Projekt von den Personen fernbleiben, die einen Server betreiben, betreiben Sie dafür einen eigenen Server.
Außerdem hält der Computer jedes Mitglieds eine vollständige Kopie jedes Projekts, das mit ihm geteilt wurde. Bitten Sie Mitglieder, Festplattenverschlüsselung einzuschalten, etwa FileVault auf macOS, BitLocker auf Windows oder LUKS auf Linux.
Was Sie brauchen
Abschnitt betitelt „Was Sie brauchen“- Eine Maschine, die durchläuft. Jede Linux-Maschine funktioniert, oder ein Konto bei einem Hostingdienst wie Render oder Railway. Zum Anfang genügt eine kleine virtuelle Maschine. Beobachten Sie Speicher und Festplatte, wenn die Projekte wachsen. Der Server läuft auf x86-64 und ARM.
- Einen Domänennamen für den Server, etwa
collab.example.org, mit einem DNS-Eintrag, der auf die Maschine zeigt. Render und Railway geben Ihnen eine Adresse, wenn Sie keine haben. Hat die Maschine keine öffentliche Adresse, lesen Sie Ohne öffentliche Adresse. - Einen Weg für Personen, sich anzumelden: mindestens einen Anbieter für die Anmeldung, etwa eine GitHub-OAuth-App oder den Login Ihrer Institution. Ohne einen startet der Server nicht. Ein E-Mail-Konto, von dem der Server senden kann, ist optional. Damit kann ein Admin Personen auch die Anmeldung per Link per E-Mail erlauben. Lesen Sie Anmeldung und Zugriff.
Jedes Release wird als Container-Image veröffentlicht, ghcr.io/oleafly/oleafly-server. Das Installationsprogramm und seine Compose-Dateien liegen auf der Oleafly-Server-Release-Seite (öffnet in einem neuen Tab). Der Server als einzelnes Linux-Programm liegt auf der Oleafly-Release-Seite (öffnet in einem neuen Tab).
Wählen Sie, wie Sie ihn betreiben
Abschnitt betitelt „Wählen Sie, wie Sie ihn betreiben“| Option | Wann Sie sie nutzen |
|---|---|
| Ein Befehl | Eine Linux-Maschine, die Sie selbst betreuen. Das Installationsprogramm richtet Docker, Caddy und HTTPS ein und stellt ein paar Fragen. Beginnen Sie hier, wenn Sie unsicher sind. |
| Docker Compose von Hand | Sie legen und bearbeiten jede Datei lieber selbst. |
| Coolify | Sie betreiben bereits einen Coolify-Server. |
| Render oder Railway | Sie zahlen lieber für einen Hostingdienst, als eine Maschine zu betreuen. |
| Linux ohne Docker | Eine virtuelle Maschine einer Universität, auf der Sie Docker nicht nutzen können. |
Der Server liest seine Einstellungen aus Umgebungsvariablen. Speicherung, Backups & Limits listet alle auf.
Installation mit einem Befehl
Abschnitt betitelt „Installation mit einem Befehl“Auf einer Linux-Maschine, die Sie selbst betreuen, richtet das Installationsprogramm alles ein und fragt nur ab, was es wissen muss.
Bevor Sie es ausführen, prüfen Sie, dass:
- Die Maschine läuft mit Linux auf x86-64 oder ARM, etwa Ubuntu 24.04 oder Debian 13, und Sie können darauf
sudoverwenden. - Nichts anderes auf der Maschine verwendet die Ports 80 und 443. Öffnen Sie die TCP-Ports 80 und 443 und den UDP-Port 443 in jeder davorliegenden Firewall.
- Der DNS-Eintrag Ihrer Domain zeigt auf die Maschine. Tut er es noch nicht, endet die Installation dennoch, und Caddy versucht weiter, ein Zertifikat zu holen, bis der Eintrag vorhanden ist.
- Sie haben die Angaben für mindestens einen Anbieter der Anmeldung, etwa Client-ID und Secret einer GitHub-OAuth-App. Bei GitHub ist die Callback-Adresse
https://und Ihre Domain, gefolgt von/auth/callback/github.
Dann führen Sie aus:
curl -fsSL https://oleafly.com/server/install.sh | sudo shDas Installationsprogramm:
- Prüft die Maschine und, dass die Ports 80 und 443 frei sind.
- Prüft auf Docker. Fehlt es, fragt das Installationsprogramm nach, bevor es es mit Dockers eigenem Skript installiert.
- Lädt die Dateien des neuesten Releases von den Oleafly-Server-Releases (öffnet in einem neuen Tab) herunter und gleicht jede mit der
SHA256SUMSdes Releases ab. Passt eine Datei nicht, stoppt es, ohne etwas zu ändern. - Fragt nach Ihrer Domain, dem Namen des Servers und wie sich Personen anmelden. Es bietet außerdem an, E-Mail einzurichten und Dateien in einem S3-Bucket zu halten. Beides ist optional.
- Zeigt eine Zusammenfassung und fragt nach, bevor es etwas ändert. Dann schreibt es seine Dateien nach
/opt/oleafly-server, mit Ihren Einstellungen in.env, die nur root lesen kann. - Startet den Server mit Caddy davor, wartet, bis Ihre Domain über HTTPS antwortet, und gibt die Adresse und den Einrichtungscode aus.
Dann werden Sie der erste Admin.
Sie können das Installationsprogramm jederzeit erneut ausführen. Findet es einen Server in /opt/oleafly-server, lässt es .env unverändert, setzt die anderen Dateien zurück und startet den Server neu. Das repariert die meisten kaputten Setups.
Ihre Daten liegen im Docker-Volume oleafly-server_oleafly-data. Um woanders als /opt/oleafly-server zu installieren, setzen Sie OLEAFLY_DIR, zum Beispiel curl -fsSL https://oleafly.com/server/install.sh | sudo OLEAFLY_DIR=/srv/oleafly sh, und verwenden Sie diesen Ordner in den Befehlen unten.
Lesen Sie das Installationsprogramm zuerst
Abschnitt betitelt „Lesen Sie das Installationsprogramm zuerst“Erlaubt Ihre Institution nicht, ein Skript in eine Shell zu leiten, laden Sie install.sh und SHA256SUMS vom neuesten Release (öffnet in einem neuen Tab) in einen Ordner herunter. Prüfen Sie das Skript, lesen Sie es und führen Sie es dann aus:
sha256sum --check --ignore-missing SHA256SUMSsudo sh install.shInstallation ohne Fragen
Abschnitt betitelt „Installation ohne Fragen“Für ein Skript oder ein Provisionierungswerkzeug hängen Sie --yes an und übergeben die Antworten als Umgebungsvariablen. OLEAFLY_INSTALL_DOCKER=yes erlaubt dem Installationsprogramm, Docker hinzuzufügen, wenn es fehlt.
curl -fsSL https://oleafly.com/server/install.sh | sudo \ OLEAFLY_DOMAIN=collab.example.org \ OLEAFLY_SERVER_NAME='Smith Lab' \ OLEAFLY_GITHUB_CLIENT_ID=Ov23liExampleClientId \ OLEAFLY_GITHUB_CLIENT_SECRET=example-client-secret \ OLEAFLY_INSTALL_DOCKER=yes \ sh -s -- --yesDas Installationsprogramm verwendet jede Einstellung, die es in der Umgebung findet, ohne nachzufragen, mit oder ohne --yes. sudo sh /opt/oleafly-server/install.sh --help listet alle auf, einschließlich OpenID Connect, E-Mail und S3. Werte, die Sie auf einer Befehlszeile eingeben, können in Ihrer Shell-Historie landen. Ein Provisionierungswerkzeug sollte Secrets darum aus seinem eigenen Secret-Speicher übergeben.
Status, Updates und Entfernen
Abschnitt betitelt „Status, Updates und Entfernen“-
Status:
sudo sh /opt/oleafly-server/install.sh statuszeigt, ob der Server läuft und ob Ihre Domain über HTTPS mit einem gültigen Zertifikat antwortet. -
Update: Sichern Sie zuerst, wie unter Aktualisieren beschrieben. Führen Sie dann den Befehl unten aus. Er lädt die Dateien und das Image des neuesten Releases herunter, behält
.env, startet den Server neu und wartet, bis er antwortet. Verbundene Personen verbinden sich von selbst wieder. Das Installationsprogramm setzt einen Server nie auf ein älteres Release zurück.Terminalfenster curl -fsSL https://oleafly.com/server/install.sh | sudo sh -s -- update -
Deinstallieren:
sudo sh /opt/oleafly-server/install.sh uninstallstoppt und entfernt die Container. Ihre Daten und.envbleiben, außer Sie gebendeleteein, wenn es nachfragt. Sie zu löschen entfernt jedes geteilte Projekt auf dem Server, jedes Konto und das Sicherheitsprotokoll. Personen behalten ihre eigenen Kopien der Projekte auf ihren Computern.
Stoppt das Installationsprogramm mit einem Problem, das Sie nicht beheben können, melden Sie es (öffnet in einem neuen Tab) mit dem, was es ausgegeben hat.
Docker Compose von Hand
Abschnitt betitelt „Docker Compose von Hand“Dieses Setup betreibt zwei Container. oleafly-server ist der Server, und nur andere Container können ihn erreichen. caddy holt ein Zertifikat von Let’s Encrypt, bedient HTTPS auf den Ports 80 und 443 und leitet Anfragen an den Server weiter, Live-Verbindungen eingeschlossen.
-
Installieren Sie Docker Engine und das Compose-Plugin nach Dockers Anleitung (öffnet in einem neuen Tab).
-
Lassen Sie den DNS-Eintrag Ihrer Domain auf die Maschine zeigen. Öffnen Sie die TCP-Ports 80 und 443 und den UDP-Port 443 in jeder davorliegenden Firewall. Caddy braucht Port 80, um das Zertifikat zu holen.
-
Legen Sie einen Ordner für den Server an, laden Sie die Dateien des neuesten Releases hinein, prüfen Sie sie und erstellen Sie Ihre Einstellungsdatei:
Terminalfenster sudo mkdir -p /opt/oleafly-server && cd /opt/oleafly-serverbase=https://github.com/Oleafly/oleafly-server/releases/latest/downloadfor f in docker-compose.yml Caddyfile env.example litestream.yml SHA256SUMS; do sudo curl -fsSLO "$base/$f"; donesha256sum --check --ignore-missing SHA256SUMSsudo install -m 600 env.example .env -
Bearbeiten Sie
.envmitsudoedit .env. Setzen SieOLEAFLY_DOMAINauf Ihre Domain ohnehttps://, setzen SieOLEAFLY_SERVER_NAMEund tragen Sie mindestens einen Anbieter der Anmeldung ein. Lassen Sie die Anbieterzeilen, die Sie nicht nutzen, leer. Setzen Sie einen Wert in einfache Anführungszeichen, wenn er$oder#enthält. -
Starten Sie es. Der erste Start lädt das Server-Image,
ghcr.io/oleafly/oleafly-server, in der Version des Releases herunter.Terminalfenster sudo docker compose up -d -
Prüfen Sie, dass es antwortet. Dies gibt
200aus:Terminalfenster curl -sS -o /dev/null -w '%{http_code}\n' https://collab.example.org/healthz -
Werden Sie der erste Admin. Der Einrichtungscode steht im Log:
Terminalfenster sudo docker compose logs oleafly-server | grep 'Setup code'
Ihre Daten liegen im Docker-Volume oleafly-server_oleafly-data. Caddy hält seine Zertifikate in oleafly-server_caddy-data.
Docker öffnet die Ports 80 und 443 selbst, auch wenn eine Host-Firewall wie ufw aktiviert ist. Genau das braucht Caddy. Fügen Sie beim Dienst oleafly-server keinen ports:-Eintrag hinzu. Um den Server von der Maschine selbst zu erreichen, veröffentlichen Sie ihn als 127.0.0.1:8080:8080, damit er nicht im Netzwerk liegt.
Ändern Sie die Caddyfile, führen Sie sudo docker compose up -d --force-recreate caddy aus. Um später zu aktualisieren, laden Sie die Dateien des neuen Releases auf dieselbe Weise herunter und führen Sie sudo docker compose up -d erneut aus.
Secrets aus .env heraushalten
Abschnitt betitelt „Secrets aus .env heraushalten“Sieben Einstellungen können Secrets enthalten: OLEAFLY_SETUP_CODE, OLEAFLY_GITHUB_CLIENT_SECRET, OLEAFLY_OIDC_<NAME>_CLIENT_SECRET, OLEAFLY_SMTP_URL, OLEAFLY_BLOB_STORE, OLEAFLY_S3_ACCESS_KEY_ID und OLEAFLY_S3_SECRET_ACCESS_KEY. Jede hat außerdem eine _FILE-Version, die eine Datei mit dem Wert benennt. Setzen Sie eines von beiden, nicht beide.
Um zum Beispiel das GitHub-Client-Secret als Docker-Secret zu übergeben, speichern Sie es in secrets/github_client_secret neben docker-compose.yml, lassen Sie den Benutzer des Servers (ID 10001) es lesen und löschen Sie die Zeile OLEAFLY_GITHUB_CLIENT_SECRET aus .env:
sudo chown 10001:10001 secrets/github_client_secretsudo chmod 400 secrets/github_client_secretErstellen Sie dann docker-compose.override.yml neben docker-compose.yml. Compose liest sie automatisch, und das Installationsprogramm lässt sie in Ruhe, wenn es die anderen Dateien aktualisiert.
services: oleafly-server: environment: OLEAFLY_GITHUB_CLIENT_SECRET_FILE: /run/secrets/github_client_secret secrets: - github_client_secret
secrets: github_client_secret: file: ./secrets/github_client_secretFühren Sie sudo docker compose up -d erneut aus.
Coolify
Abschnitt betitelt „Coolify“Coolify setzt seinen eigenen Proxy vor den Server und holt das Zertifikat, darum hat dieses Setup kein Caddy. Coolify kann den Server aus dem Oleafly-Repository bauen oder das veröffentlichte Image betreiben, was den Bau überspringt.
Bevor Sie beginnen, lassen Sie den DNS-Eintrag Ihrer Domain, etwa collab.example.org, auf den Coolify-Server zeigen. Erstellen Sie dann die GitHub-OAuth-App wie unter GitHub beschrieben, mit der Callback-Adresse https://collab.example.org/auth/callback/github. Halten Sie Client-ID und Secret bereit.
Aus dem Repository bauen
Abschnitt betitelt „Aus dem Repository bauen“- Wählen Sie in Ihrem Coolify-Projekt + New und dann Public Repository und geben Sie
https://github.com/Oleafly/Oleaflyein. Behalten Sie den Branchmain. - Setzen Sie Build Pack auf Docker Compose, Base Directory auf
/und Docker Compose Location auf/deploy/server/docker-compose.coolify.ymlund wählen Sie dann Continue. - Setzen Sie unter Advanced › Build Build arguments auf Managed manually in Dockerfile. Das Image des Servers braucht keine Build-Argumente. Bleibt die Einstellung auf automatisch, schreibt Coolify jede Variable, Secrets eingeschlossen, in die Build-Historie des Images.
- Setzen Sie unter General die Domain von
oleafly-serveraufhttps://collab.example.org:8080und speichern Sie. Das:8080sagt Coolifys Proxy, auf welchem Port der Server lauscht. Personen verbinden sich weiterhin über den üblichen HTTPS-Port, und Coolify setztOLEAFLY_PUBLIC_URLfür Sie aufhttps://collab.example.org. - Füllen Sie unter Environment Variables
OLEAFLY_SERVER_NAMEaus, das Coolify als erforderlich markiert, dannOLEAFLY_GITHUB_CLIENT_IDundOLEAFLY_GITHUB_CLIENT_SECRET. Lassen Sie Variablen, die Sie nicht nutzen, leer. - Wählen Sie Deploy. Der erste Build kompiliert den Server und dauert ein paar Minuten. Ist er fertig, zeigt Coolify die Ressource als laufend und gesund.
- Öffnen Sie
https://collab.example.org/healthzin einem Browser. Er zeigt{"status":"ok"}. - Öffnen Sie Logs, wählen Sie den Container
oleafly-serverund kopieren Sie den Code aus der neuesten Zeile, die mitSetup code:beginnt. - Werden Sie mit diesem Code der erste Admin.
Startet der Server nicht, nennt sein Log die Einstellung, die er nicht verwenden kann. Sagt es, dass OLEAFLY_PUBLIC_URL nicht gesetzt ist, fehlt Schritt 4. Eine Domain, die mit http:// beginnt, wird abgelehnt, weil der Server HTTPS braucht.
Steht Cloudflare vor Coolify, weil Ihr DNS-Eintrag durch Cloudflares Proxy geht oder ein Tunnel zu Coolifys Proxy führt, setzen Sie OLEAFLY_PROXY_HOPS auf 2. Ohne das zeigt das Sicherheitsprotokoll für alle die Adresse des Proxys, und alle teilen sich ein Anmelde-Limit.
Die Coolify-Datei hat Platz für GitHub und einen OpenID-Connect-Anbieter namens UNIVERSITY. Setzen Sie OLEAFLY_OIDC_UNIVERSITY_LABEL auf den Text, den Personen sehen sollen, etwa GitLab. Seine Callback-Adresse endet auf /auth/callback/university. Für weitere Anbieter stellen Sie aus einem Fork mit Ihrer eigenen Kopie der Datei bereit.
Die Daten liegen in einem Docker-Volume, dessen Name auf oleafly-data endet. Finden Sie es mit docker volume ls --filter name=oleafly-data. Das Image hat keine Shell, darum kann Coolifys Terminal keine im Container des Servers öffnen. Logs und der Health-Check funktionieren wie gewohnt.
Das veröffentlichte Image bereitstellen
Abschnitt betitelt „Das veröffentlichte Image bereitstellen“Das Betreiben des veröffentlichten Images überspringt den Bau, was zu einem kleinen Coolify-Server passt. Folgen Sie den Schritten oben mit zwei Änderungen. Setzen Sie in Schritt 2 Docker Compose Location auf /deploy/server/docker-compose.coolify-image.yml. Überspringen Sie Schritt 3, weil nichts gebaut wird. Die Datei folgt einer Release-Serie, darum zieht jedes Redeploy das neueste Release darin.
Deploy to Render (öffnet in einem neuen Tab) liest den Blueprint im Oleafly-Repository. Er erstellt einen Webdienst aus dem veröffentlichten Image, mit einer 1-GB-Festplatte für den Datenordner. Render hängt Festplatten nur an bezahlte Instanztypen, darum startet der Dienst auf dem kleinsten bezahlten, in Renders Region Oregon. Für eine andere Region stellen Sie aus einem Fork bereit, mit in render.yaml gesetztem region.
- Öffnen Sie den Link und melden Sie sich bei Render an.
- Render fragt nach
OLEAFLY_SERVER_NAMEund der GitHub-Client-ID samt Secret. Füllen Sie den Namen aus und lassen Sie die GitHub-Felder vorerst leer. Ihre Callback-Adresse hängt von der Adresse des Dienstes ab, die Sie noch nicht haben. - Wählen Sie Deploy Blueprint. Sobald der Dienst läuft, zeigt seine Seite seine Adresse, etwa
https://oleafly-server.onrender.com. Der Blueprint setztOLEAFLY_PUBLIC_URLauf diese Adresse. - Erstellen Sie die GitHub-OAuth-App wie unter GitHub beschrieben, mit dieser Adresse, gefolgt von
/auth/callback/github, als Callback-Adresse. Fügen Sie Client-ID und Secret unter Environment des Dienstes hinzu. Render startet den Server damit neu. - Finden Sie die neueste Zeile
Setup code:in den Logs des Dienstes und werden Sie der erste Admin.
Geben Sie dem Dienst Ihre eigene Domain, setzen Sie OLEAFLY_PUBLIC_URL unter Environment darauf und ändern Sie die Callback-Adresse bei GitHub entsprechend.
Wegen der Festplatte stoppt Render den laufenden Server, bevor er den neuen startet, darum nimmt jede Bereitstellung den Server für ein paar Sekunden weg. Oleafly verbindet sich von selbst wieder.
Railway
Abschnitt betitelt „Railway“Railway betreibt das veröffentlichte Image, mit einem Volume für den Datenordner.
-
Wählen Sie in einem Railway-Projekt + New und dann Docker Image und geben Sie
ghcr.io/oleafly/oleafly-server:latestein. Um selbst zu wählen, wann Sie aktualisieren, verwenden Sie stattdessen den eigenen Tag eines Releases von der Release-Seite (öffnet in einem neuen Tab). Railway kann sofort eine erste Bereitstellung starten. Sie stoppt mitOLEAFLY_PUBLIC_URL is not set, was an diesem Punkt erwartet wird. -
Öffnen Sie den Dienst. Wählen Sie unter Settings › Networking Generate Domain und geben Sie den Port
8080ein. Railway zeigt die Adresse, etwaoleafly-server-production.up.railway.app. -
Setzen Sie unter Settings › Deploy Healthcheck Path auf
/readyz. -
Klicken Sie mit der rechten Maustaste auf die Projektfläche, fügen Sie ein Volume hinzu, hängen Sie es an den Dienst des Servers und setzen Sie seinen Mount-Pfad auf
/data. -
Öffnen Sie unter Variables den Raw Editor und fügen Sie diese Zeilen mit Ihrem eigenen Servernamen ein. Für die GitHub-Werte folgen Sie GitHub. Die Callback-Adresse ist Ihre Adresse aus Schritt 2, mit
https://davor und/auth/callback/githubdahinter.OLEAFLY_PUBLIC_URL=https://${{RAILWAY_PUBLIC_DOMAIN}}OLEAFLY_BIND=0.0.0.0:8080OLEAFLY_DATA_DIR=/dataOLEAFLY_BEHIND_PROXY=trueOLEAFLY_SERVER_NAME=Smith LabOLEAFLY_GITHUB_CLIENT_ID=Ov23liExampleClientIdOLEAFLY_GITHUB_CLIENT_SECRET=example-client-secretPORT=8080RAILWAY_RUN_UID=0Railway hängt Volumes als root ein.
RAILWAY_RUN_UID=0betreibt den Server als root, damit er auf das Volume schreiben kann. -
Stellen Sie die Änderungen bereit. Finden Sie die neueste Zeile
Setup code:in den Deploy Logs des Dienstes und werden Sie der erste Admin.
Linux ohne Docker
Abschnitt betitelt „Linux ohne Docker“Auf einer Maschine ohne Docker läuft der Server als einzelnes Programm unter systemd, mit Caddy davor für HTTPS.
Den Server herunterladen
Abschnitt betitelt „Den Server herunterladen“Jedes Server-Release auf der Release-Seite (öffnet in einem neuen Tab) enthält ein fertig gebautes Programm für x86-64 und für ARM sowie eine SHA256SUMS-Datei zum Abgleichen. Das Programm braucht nichts weiter installiert.
Laden Sie das Archiv für Ihre Maschine, endend auf x86_64-unknown-linux-musl.tar.gz oder aarch64-unknown-linux-musl.tar.gz, und SHA256SUMS in einen Ordner herunter. Prüfen und installieren Sie es dann. Auf einer ARM-Maschine verwenden Sie aarch64 anstelle von x86_64:
sha256sum --check --ignore-missing SHA256SUMStar -xzf oleafly-server-*-x86_64-unknown-linux-musl.tar.gzsudo install -m 0755 oleafly-server-*-x86_64-unknown-linux-musl/oleafly-server /usr/local/bin/oleafly-serveroleafly-server --versionMit installierter GitHub-CLI prüft gh attestation verify oleafly-server-*-x86_64-unknown-linux-musl.tar.gz --repo Oleafly/Oleafly außerdem, dass GitHub das Archiv aus dem Oleafly-Repository gebaut hat. Das Archiv enthält die systemd-Unit, oleafly-server.service.
Um das Programm stattdessen selbst zu bauen, führen Sie dies aus einem Klon des Oleafly-Repositories auf einem beliebigen Computer mit Docker aus. Verwenden Sie für einen ARM-Server --platform linux/arm64.
docker buildx build --platform linux/amd64 --target binary --output type=local,dest=dist -f crates/oleafly-server/Dockerfile .Das schreibt dist/oleafly-server. Kopieren Sie es auf dem Server nach /usr/local/bin/oleafly-server und machen Sie es ausführbar.
Betrieb mit systemd
Abschnitt betitelt „Betrieb mit systemd“-
Erstellen Sie die Einstellungsdatei. Nur root kann sie lesen:
Terminalfenster sudo install -d -m 0755 /etc/oleafly-serversudo install -m 0600 /dev/null /etc/oleafly-server/oleafly-server.envsudoedit /etc/oleafly-server/oleafly-server.envSchreiben Sie eine Einstellung pro Zeile.
OLEAFLY_BIND=127.0.0.1:8080hält den Server aus dem Netzwerk heraus, sodass nur Caddy ihn erreichen kann. Setzen SieOLEAFLY_DATA_DIRnicht, weil die Unit ihn setzt.OLEAFLY_PUBLIC_URL=https://collab.example.orgOLEAFLY_BIND=127.0.0.1:8080OLEAFLY_BEHIND_PROXY=trueOLEAFLY_SERVER_NAME=Smith LabOLEAFLY_GITHUB_CLIENT_ID=Ov23liExampleClientIdOLEAFLY_GITHUB_CLIENT_SECRET=example-client-secret -
Installieren und starten Sie die Unit aus dem entpackten Archiv oder aus
deploy/serverin einem Klon des Repositories. Finden Sie dann den Einrichtungscode:Terminalfenster sudo install -m 0644 oleafly-server.service /etc/systemd/system/oleafly-server.servicesudo systemctl daemon-reloadsudo systemctl enable --now oleafly-serversudo journalctl -u oleafly-server | grep 'Setup code'
Die Unit betreibt den Server als Benutzer, den systemd dafür anlegt, mit einer nur lesenden Sicht auf den Rest des Systems. Der einzige Ort, auf den er schreiben kann, ist /var/lib/oleafly-server, wo er seine Daten hält. Auf der Festplatte ist dieser Ordner /var/lib/private/oleafly-server.
Um das Client-Secret aus der Einstellungsdatei herauszuhalten, verwenden Sie eine systemd-Credential. Speichern Sie das Secret in /etc/oleafly-server/github-client-secret mit den Rechten 600, löschen Sie die Zeile OLEAFLY_GITHUB_CLIENT_SECRET aus der Einstellungsdatei, führen Sie sudo systemctl edit oleafly-server aus und fügen Sie hinzu:
[Service]LoadCredential=github-client-secret:/etc/oleafly-server/github-client-secretEnvironment=OLEAFLY_GITHUB_CLIENT_SECRET_FILE=%d/github-client-secretFühren Sie dann sudo systemctl restart oleafly-server aus.
HTTPS vorschalten
Abschnitt betitelt „HTTPS vorschalten“Installieren Sie Caddy nach seiner Anleitung für Ihre Distribution (öffnet in einem neuen Tab). Ersetzen Sie /etc/caddy/Caddyfile durch diese Zeilen und führen Sie sudo systemctl reload caddy aus. Caddy holt das Zertifikat und leitet Live-Verbindungen durch.
collab.example.org { reverse_proxy 127.0.0.1:8080}Für nginx oder Apache oder einen Webserver, den Ihre Universität bereits betreibt, lesen Sie Hinter einem Reverse-Proxy.
Ohne öffentliche Adresse
Abschnitt betitelt „Ohne öffentliche Adresse“Hat die Maschine keine öffentliche Adresse, zum Beispiel ein Computer in Ihrem Labor hinter der Firewall der Universität, kann Cloudflare Tunnel sie erreichbar machen. Sie brauchen ein Cloudflare-Konto mit Ihrer Domain darauf. Cloudflare übernimmt HTTPS für den Hostnamen, darum werden Anfragen auf Cloudflares Netzwerk entschlüsselt, bevor sie Ihre Maschine erreichen. Zählen Sie Cloudflare zu den Parteien, die den Verkehr zu Ihrem Server lesen können.
-
Folgen Sie den Schritten von Docker Compose von Hand bis zur Bearbeitung von
.env. Setzen SieOLEAFLY_DOMAINauf den Hostnamen, den Sie verwenden, etwacollab.example.org. Das Installationsprogramm mit einem Befehl passt hier nicht, weil es Caddy startet. -
Starten Sie nur den Server. Caddy wird hier nicht gebraucht:
Terminalfenster sudo docker compose up -d oleafly-server -
Gehen Sie im Cloudflare-Dashboard zu Networking › Tunnels, wählen Sie Create Tunnel, geben Sie ihm einen Namen und wählen Sie erneut Create Tunnel. Kopieren Sie das Token aus dem Installationsbefehl, den es zeigt.
-
Starten Sie den Tunnel neben dem Server. Der Befehl
readwartet darauf, dass Sie das Token einfügen, und zeigt es nicht an:Terminalfenster read -rs TUNNEL_TOKEN && export TUNNEL_TOKENsudo --preserve-env=TUNNEL_TOKEN docker run -d --name oleafly-tunnel --restart unless-stopped --network oleafly-server_default -e TUNNEL_TOKEN cloudflare/cloudflared:2026.10.0 tunnel --no-autoupdate run -
Zurück im Dashboard öffnen Sie den Tunnel. Wählen Sie unter Routes Add route und dann Published application. Geben Sie unter Hostname die Subdomain ein und wählen Sie Ihre Domain. Setzen Sie Service URL auf
http://oleafly-server:8080und wählen Sie Add route. -
Prüfen Sie, dass es unter
https://collab.example.org/healthzantwortet, und werden Sie dann der erste Admin.
Installieren Sie auf einer Maschine ohne Docker cloudflared aus Cloudflares Paketrepository (öffnet in einem neuen Tab), führen Sie sudo cloudflared service install gefolgt vom Token aus und setzen Sie Service URL auf http://127.0.0.1:8080.
Cloudflare leitet Live-Verbindungen durch und setzt die Adresse des Besuchers an letzte Stelle in X-Forwarded-For, darum lassen Sie OLEAFLY_BEHIND_PROXY=true gesetzt. Führt der Tunnel zu einem anderen Proxy, etwa dem von Coolify, und nicht direkt zum Server, setzen Sie außerdem OLEAFLY_PROXY_HOPS=2. Cloudflare lehnt Anfragen über 100 MB in seinen Free- und Pro-Tarifen ab. Setzen Sie darum OLEAFLY_MAX_PROJECT_MB auf 100 oder weniger, sonst scheitert das Hochladen großer Projekte. Setzen Sie kein Cloudflare Access vor den Server, weil Oleafly nicht über seine Anmeldeseite hinwegkommt.
Wenn Sie den Server später aktualisieren, laden Sie die Dateien des neuen Releases herunter und benennen Sie den Dienst, damit Caddy ausbleibt: sudo docker compose up -d oleafly-server.
Werden Sie der erste Admin
Abschnitt betitelt „Werden Sie der erste Admin“Ein neuer Server hat keinen Admin. Bis jemand die Einrichtung abschließt, erzeugt der Server bei jedem Start einen neuen einmaligen Einrichtungscode und schreibt ihn in sein Log.
- Finden Sie die neueste Zeile im Log, die mit
Setup code:beginnt:- Installation mit einem Befehl: Das Installationsprogramm gibt ihn aus, wenn es fertig ist. Um ihn erneut zu sehen, führen Sie
cd /opt/oleafly-server && sudo docker compose logs oleafly-server | grep 'Setup code'aus - Docker Compose von Hand:
sudo docker compose logs oleafly-server | grep 'Setup code'im Ordner des Servers - Coolify: die Logs des Dienstes
oleafly-server - systemd:
sudo journalctl -u oleafly-server | grep 'Setup code'
- Installation mit einem Befehl: Das Installationsprogramm gibt ihn aus, wenn es fertig ist. Um ihn erneut zu sehen, führen Sie
- Öffnen Sie in Oleafly Einstellungen → Zusammenarbeit, wählen Sie Server hinzufügen und geben Sie die Adresse Ihres Servers ein. Oleafly erkennt, dass der Server eingerichtet werden muss, und fragt nach dem Einrichtungscode.
- Geben Sie den Code ein und melden Sie sich mit einem beliebigen Anbieter an, den Sie eingerichtet haben. Sie werden zum Admin des Servers, und der Code funktioniert nicht mehr.
Jeder, der den Code hat, bevor Sie ihn verwenden, kann sich zum Admin machen. Fügen Sie ihn darum nur in Oleafly ein.
Sie können den Code auch selbst mit OLEAFLY_SETUP_CODE wählen: mindestens 12 Buchstaben oder Ziffern, bei Bedarf mit Bindestrichen oder Leerzeichen. Der Server gibt ihn dann nie aus. Das Log sagt nur Setup code: set by OLEAFLY_SETUP_CODE, und Sie geben den Wert ein, den Sie gesetzt haben. Entfernen Sie ihn nach der Einrichtung aus Ihren Einstellungen.
Als Nächstes lassen Sie Personen hinein. Anmeldung und Zugriff erklärt wie.
Den Server prüfen
Abschnitt betitelt „Den Server prüfen“- Bei der Installation mit einem Befehl prüft
sudo sh /opt/oleafly-server/install.sh statusContainer und HTTPS in einem Rutsch. https://collab.example.org/healthzantwortet mit200, solange der Serverprozess läuft./readyzantwortet nur mit200, solange der Server auf seine Datenbank und seinen Datenordner schreiben kann. Kann er es nicht, etwa bei einer vollen Festplatte, antwortet er mit503und nennt, was fehlschlug,databaseoderstorage.- Das Docker-Image prüft
/readyzvon selbst, darum zeigendocker psund Coolify einen ungesunden Server statt eines laufenden, der nichts speichern kann. - In Oleafly prüft Verbindung testen unter Einstellungen → Zusammenarbeit die Adresse, HTTPS, die Version, Live-Verbindungen, Anmeldeoptionen und die Uhr des Servers. Verbindungstests in der Admin-Konsole führt dieselben Prüfungen aus.