Zum Inhalt springen
Oleaflyv0.4.12

Server betreiben

Richten Sie Anmeldeanbieter und E-Mail für Oleafly Server ein, entscheiden Sie mit Zugangsregeln, offener Registrierung, Rollen und Gästen, wer hineinkommt, schalten Sie den Browserzugriff ein und betreiben Sie den Server über die Admin-Konsole.

Personen melden sich über Anbieter bei Oleafly Server an, die Sie konfigurieren, deshalb verwaltet der Server nie Passwörter. Mit Zugangsregeln entscheiden Sie, wer hineinkommt. Admins verwalten das Übrige über die Admin-Konsole in Oleafly.

Richten Sie mindestens einen Anbieter ein. Ohne einen startet der Server nicht, und sein Protokoll nennt die Einstellungen, die Sie hinzufügen müssen. Der erste Admin meldet sich damit an, weil die Anmeldung per E-Mail-Link ausgeschaltet bleibt, bis ein Admin sie einschaltet. Jeder Anbieter schickt Personen an eine Callback-Adresse auf Ihrem Server zurück:

https://collab.example.org/auth/callback/<provider>

Wenn OLEAFLY_PUBLIC_URL einen Pfad enthält, enthält auch die Callback-Adresse einen, zum Beispiel https://www.cs.example.edu/oleafly/auth/callback/github.

  1. Wählen Sie auf GitHub Ihr Profilbild, dann Einstellungen › Entwicklereinstellungen › OAuth-Apps, und wählen Sie Neue OAuth-App. Für eine App im Besitz einer Organisation verwenden Sie stattdessen Entwicklereinstellungen in den Einstellungen der Organisation.
  2. Füllen Sie Anwendungsname (zum Beispiel Smith Lab Oleafly), Homepage-URL (https://collab.example.org) und Autorisierungs-Callback-URL (https://collab.example.org/auth/callback/github) aus. Lassen Sie Gerätefluss aktivieren aus.
  3. Wählen Sie Anwendung registrieren. Kopieren Sie die Client-ID, wählen Sie dann Neuen Client-Geheimschlüssel generieren und kopieren Sie den Geheimschlüssel.
  4. Setzen Sie OLEAFLY_GITHUB_CLIENT_ID und OLEAFLY_GITHUB_CLIENT_SECRET und starten Sie den Server neu.

Der Server fragt bei GitHub nur das Profil und die E-Mail-Adressen der Person ab (read:user und user:email). OLEAFLY_GITHUB_LABEL ändert den Text auf der Anmeldeschaltfläche.

Für GitHub Enterprise Server registrieren Sie die App dort und setzen zusätzlich OLEAFLY_GITHUB_URL auf ihre Adresse, etwa https://github.example.edu. Setzen Sie OLEAFLY_GITHUB_API_URL nur, wenn Ihre API-Adresse ungewöhnlich ist.

OpenID Connect deckt GitLab, Google, Microsoft Entra ID, Keycloak, Authentik, Okta und die meisten Single-Sign-on-Systeme von Universitäten ab. Wenn Ihre Universität nur SAML anbietet, schalten Sie Keycloak oder Dex dazwischen.

  1. Wählen Sie einen kurzen Namen aus Buchstaben und Ziffern, etwa GITLAB. Er wird Teil der Variablennamen, und in Kleinschreibung wird er Teil der Callback-Adresse. Benennen Sie in der Compose-.env die UNIVERSITY-Zeilen um oder fügen Sie einen zweiten Block hinzu.

  2. Registrieren Sie eine Anwendung bei Ihrem Anbieter. Wählen Sie eine vertrauliche Anwendung oder eine Web-Anwendung, setzen Sie die Redirect-URI auf https://collab.example.org/auth/callback/gitlab und erlauben Sie die Scopes openid, email und profile.

  3. Fügen Sie die Angaben des Anbieters hinzu:

    OLEAFLY_OIDC_GITLAB_ISSUER=https://gitlab.com
    OLEAFLY_OIDC_GITLAB_CLIENT_ID=example-client-id
    OLEAFLY_OIDC_GITLAB_CLIENT_SECRET=example-client-secret
    OLEAFLY_OIDC_GITLAB_LABEL=GitLab
  4. Starten Sie den Server neu.

Das Label ist der Text auf der Anmeldeschaltfläche, etwa University login. Der Aussteller ist die Adresse, unter der der Anbieter /.well-known/openid-configuration veröffentlicht. Einige übliche:

AnbieterAussteller
GitLab.comhttps://gitlab.com
Selbst betriebenes GitLabIhre GitLab-Adresse, etwa https://gitlab.example.edu
Googlehttps://accounts.google.com
Microsoft Entra IDhttps://login.microsoftonline.com/ gefolgt von Ihrer Mandanten-ID und /v2.0
Keycloakhttps://sso.example.edu/realms/ gefolgt vom Namen des Realms

Einträge in der Liste zugelassener Personen und Domainregeln passen nur auf bestätigte E-Mail-Adressen. Der Server zählt eine Adresse nur dann als bestätigt, wenn der Anbieter es sagt: GitHub markiert sie als bestätigt, oder der OpenID-Connect-Claim email_verified ist true.

Manche Anbieter von Institutionen lassen diesen Claim weg. Wenn Ihrer das tut und er nur Adressen vergibt, die Ihre Institution verwaltet, setzen Sie OLEAFLY_OIDC_<NAME>_TRUST_EMAIL=true. Setzen Sie das niemals für einen Anbieter, bei dem Personen eine beliebige E-Mail-Adresse eingeben können. Jede Person könnte sich sonst als jemand auf Ihrer Liste zugelassener Personen ausgeben.

Zertifikate, die Ihre Universität selbst signiert

Abschnitt betitelt „Zertifikate, die Ihre Universität selbst signiert“

Wenn Ihre Universität ihre eigenen Zertifikate signiert, für ihren Proxy oder ihren Anmeldedienst, muss der Server dieser Zertifizierungsstelle vertrauen. Dasselbe gilt für jeden Computer, auf dem Oleafly läuft.

Ohne Docker fügen Sie das Zertifikat zum Betriebssystem hinzu. Kopieren Sie es auf Debian und Ubuntu nach /usr/local/share/ca-certificates/, mit einem Namen, der auf .crt endet, und führen Sie sudo update-ca-certificates aus.

Das Docker-Image hat keinen Paketmanager, geben Sie ihm deshalb eine Zertifikatsliste, die Ihre enthält. Neben docker-compose.yml, auf einer Debian- oder Ubuntu-Maschine:

Terminalfenster
cat /etc/ssl/certs/ca-certificates.crt university-ca.pem > ca-bundle.pem
chmod 644 ca-bundle.pem

Fügen Sie die Datei dann in docker-compose.override.yml zum Server hinzu und führen Sie wieder docker compose up -d aus:

services:
oleafly-server:
volumes:
- ./ca-bundle.pem:/etc/ssl/certs/ca-certificates.crt:ro

E-Mail ist optional, alles Übrige funktioniert auch ohne. Ohne E-Mail schicken Sie den Personen die Adresse des Servers selbst, und Oleafly listet die Projekte, die mit jeder Person geteilt wurden, unter Mit Ihnen geteilt auf.

Zum Einrichten geben Sie dem Server ein SMTP-Konto:

OLEAFLY_SMTP_URL=smtps://oleafly%40example.org:example-app-password@smtp.example.org:465
OLEAFLY_MAIL_FROM=Smith Lab <oleafly@example.org>

Setzen Sie beide Zeilen oder keine. Schreiben Sie Sonderzeichen in Benutzername und Passwort in URL-Form, zum Beispiel %40 für @.

  • smtps:// verwendet TLS von Anfang an, auf Port 465, wenn Sie keinen anderen Port angeben.
  • smtp:// verwendet Port 587, wenn Sie keinen anderen angeben, und wechselt dann mit STARTTLS zu TLS. Bietet der Mailserver STARTTLS nicht an, verschickt der Server nicht.
  • Ein Mail-Relay auf derselben Maschine ist die Ausnahme: smtp://localhost, smtp://127.0.0.1 und smtp://[::1] verschicken ohne TLS.
  • Ein Relay im selben privaten Netz kann TLS überspringen, wenn Sie ?tls=none anfügen, wie in smtp://mailpit:1025?tls=none. Die Adresse darf dann keinen Benutzernamen und kein Passwort enthalten, weil diese unverschlüsselt das Netz durchqueren würden. Verwenden Sie das nur, wenn niemand sonst dieses Netz erreichen kann.

Der Server prüft das Zertifikat des Mailservers gegen die vertrauenswürdigen Zertifikate des Systems.

Es gibt sechs Arten von E-Mails. E-Mails an Personen mit vorhandenem Konto gehen nur an deren bestätigte Adressen, und die Noreply-Adressen von GitHub werden immer übersprungen.

E-MailWann sie verschickt wird
Zum Server hinzugefügtEin Admin fügt jemanden per E-Mail-Adresse zur Liste zugelassener Personen hinzu. Sie enthält den Namen des Servers, einen Zu Oleafly hinzufügen-Link und die Adresse des Servers. Das Hinzufügen per GitHub-Benutzername oder über eine Domainregel verschickt nichts, weil der Server für die Person noch keine Adresse hat.
Projekt geteiltDer Inhaber eines Projekts fügt jemanden zu einem Projekt hinzu. Sie enthält den Projekttitel, wer es geteilt hat, welche Rolle die Person bekommt, und einen Link, der das Projekt öffnet, dazu die Webseite des Projekts für den Fall, dass der Link die App nicht öffnet. Eine später geänderte Rolle verschickt nichts. Jede Person kann diese E-Mails auf der Serverkarte unter Einstellungen → Zusammenarbeit abschalten.
Neues GerätEin Konto meldet sich auf einem anderen Gerät an. Sie enthält den Gerätenamen, sein System und die Uhrzeit in der Zeitzone des Servers, mit dem Hinweis, dieses Gerät abzumelden, falls die Person es nicht selbst war. Das erste Gerät eines neuen Kontos bekommt keine E-Mail. Setzen Sie TZ, zum Beispiel TZ=Europe/Berlin, um die Zeitzone zu wählen.
GasteinladungDer Inhaber eines Projekts lädt einen Gast ein. Sie enthält den Projekttitel, wer die Person eingeladen hat, einen Zu Oleafly hinzufügen-Link und die Adresse zum Anmelden. Bei eingeschalteter Genehmigung geht sie erst raus, sobald die Einladung genehmigt ist.
ErwähnungJemand erwähnt ein Mitglied in einem Kommentar oder einer Antwort. Sie nennt, wer die Person erwähnt hat, das Projekt und die Datei, den Text, auf den sich der Kommentar bezieht, und den Kommentar, mit einem Link, der den Kommentar in Oleafly öffnet. Sie geht etwa eine Minute nachdem der Kommentar den Server erreicht hat raus, und Erwähnungen für dieselbe Person innerhalb dieser Minute kommen in einer E-Mail zusammen. Niemand bekommt eine für eigene Kommentare oder für ein Projekt, das die Person nicht öffnen kann, und das Bearbeiten eines Kommentars verschickt dieselbe Erwähnung nie zweimal. Jede Person kann diese E-Mails mit Mir eine E-Mail schicken, wenn mich jemand in einem Kommentar erwähnt auf der Serverkarte unter Einstellungen → Zusammenarbeit abschalten.
AnmeldelinkJemand fordert einen auf der Anmeldeseite des Servers an.

Admins können jede Art außer Anmeldelinks mit E-Mail-Benachrichtigungen in den Servereinstellungen stoppen. Anmeldelinks gehen immer raus, weil sich Personen ohne sie nicht anmelden können.

Öffnen Sie in der Admin-Konsole E-Mail. Die Seite zeigt, ob E-Mail eingeschaltet ist, und die Absenderadresse, nie das Passwort. Ein Admin kann Test-E-Mail senden wählen, um eine an die eigene bestätigte Adresse zu schicken. Die Seite sagt dann, ob sie rausging, oder was der Mailserver geantwortet hat.

Wenn E-Mail ausgeschaltet ist, zeigt die Seite den Zu Oleafly hinzufügen-Link und die Adresse des Servers, damit Sie sie selbst verschicken können.

Das Versenden hält nie die Aktion dahinter auf. Der Server behält E-Mails in einer Warteschlange im Speicher und versucht es nach 30 Sekunden, 2 Minuten, 10 Minuten, 30 Minuten und 2 Stunden erneut. Jeder fehlgeschlagene Versuch ist eine Warnung im Serverprotokoll, und die Seite E-Mail zeigt den letzten Fehlschlag. Schlägt auch der letzte Versuch fehl, protokolliert der Server einen Fehler und verwirft diese E-Mail. E-Mails, die beim Neustart des Servers noch warten, sind verloren.

Personen können sich auch mit einem Link anmelden, den der Server ihnen per E-Mail schickt, deshalb brauchen sie kein GitHub- oder OpenID-Connect-Konto. Dafür braucht es E-Mail. Dann schaltet ein Admin Anmeldung per E-Mail in den Servereinstellungen ein. Standardmäßig ist sie aus.

Die Person wählt in Oleafly Mit E-Mail fortfahren, gibt ihre Adresse im Browser ein und wählt Schicken Sie mir einen Link per E-Mail. Der Link funktioniert einmal, 15 Minuten lang, auf dem Computer, der ihn angefordert hat. Das Öffnen des Links zeigt eine Seite mit einer Schaltfläche Anmelden. Allein das Öffnen verbraucht den Link nicht, deshalb kann ein Mailscanner, der Links folgt, ihn nicht verbrauchen.

Ihre Zugangsregeln entscheiden weiterhin, wer hineinkommt: ein Eintrag in der Liste zugelassener Personen für diese E-Mail-Adresse, eine Domainregel oder eine Gasteinladung. Ein Eintrag per GitHub-Benutzername passt nicht zu einem E-Mail-Link. Die Seite sagt immer dasselbe, egal ob der Server die Adresse hineinlässt, deshalb kann niemand darüber herausfinden, wer ein Konto hat.

Das Einschalten öffnet auch bestehende Konten für E-Mail-Links. Ein Link meldet sich bei dem Konto an, das diese Adresse bereits als bestätigte Adresse hat. Der Server behält jede bestätigte Adresse, die ein Anbieter für ein Konto gemeldet hat, nicht nur die Hauptadresse, und er behält eine Adresse auch, nachdem die Person sie beim Anbieter entfernt hat. GitHub meldet zum Beispiel jede bestätigte Adresse des GitHub-Kontos. Jede Person, die E-Mail an einer dieser Adressen lesen kann, kann sich also per E-Mail bei diesem Konto anmelden. Prüfen Sie vor dem Einschalten, dass die Personen noch jede Adresse auf ihren Konten kontrollieren.

Gehört eine Adresse zu mehr als einem Konto, meldet der Link sich bei keinem davon an. Ist das einzige Konto mit dieser Adresse gesperrt oder entfernt, wird der Link abgelehnt, bis Sie die Person wieder hineinlassen.

Der Server schickt höchstens 3 Links an eine E-Mail-Adresse und 100 Links an eine IP-Adresse in 15 Minuten, deshalb können sich 50 Personen einer Klasse an einer Adresse alle anmelden. OLEAFLY_EMAIL_LINKS_PER_ADDRESS und OLEAFLY_EMAIL_LINKS_PER_IP ändern diese Zahlen. Alle IPv6-Adressen in einem /64-Netz zählen als eine Adresse. Das Ausschalten der Anmeldung per E-Mail stoppt Links, die bereits verschickt wurden.

Wenn der Browser nach einer Anmeldung nicht zu Oleafly zurückkehren kann, zum Beispiel auf einem streng gesperrten Computer, können sich Personen mit einem Code anmelden. Er braucht keine Einstellung und funktioniert mit jeder Anmeldeoption des Servers.

Oleafly zeigt die Adresse Ihres Servers, gefolgt von /auth/device, und einen Code aus acht Buchstaben. Die Person öffnet diese Adresse auf einem beliebigen Telefon oder Computer, tippt den Code ein, prüft den Computernamen, den die Seite zeigt, und meldet sich an. Die Anmeldung muss in dem Browser abgeschlossen werden, in dem der Code getippt wurde, deshalb meldet eine Anmeldeseite, die jemand anderes als Link schickt, niemanden an.

Ein Code funktioniert einmal, funktioniert nach 10 Minuten nicht mehr, und nur die Oleafly-Kopie, die ihn angefordert hat, kann die Anmeldung abschließen. Stopp, das war ich nicht bricht ihn ab. Eine IP-Adresse kann in 10 Minuten 100 Codes anfordern und 10 falsche Codes eingeben. Das reicht für eine Klasse von 50, die sich eine Adresse teilt, und OLEAFLY_DEVICE_CODES_PER_IP ändert es.

Die Anmeldung allein reicht nicht, um hineinzukommen. Eine Zugangsregel muss die Person hineinlassen. Verwalten Sie sie unter Zugangsregeln in der Admin-Konsole:

  • Zugelassene Personen: fügen Sie eine Person per E-Mail-Adresse oder per GitHub-Benutzername hinzu, mit der Rolle, die sie bekommt. Benutzernamen funktionieren nur für GitHub, weil andere Anbieter Personen ihre eigenen wählen oder ändern lassen. Verschickt der Server E-Mail, bekommt die Person beim Hinzufügen per E-Mail-Adresse die Adresse des Servers und einen Zu Oleafly hinzufügen-Link geschickt.
  • Domains: jede Person mit einer bestätigten E-Mail-Adresse an einer Domain wie cs.example.edu kann sich mit der Rolle anmelden, die Sie wählen.

Sobald Sie Personen hinzugefügt haben, können sie den Server in Oleafly hinzufügen und sich anmelden.

Unter Personen können Sie die Rolle einer Person ändern, sie sperren oder wieder aktivieren, sie entfernen und ihre Geräte abmelden. Eine gesperrte Person behält ihr Konto, kann aber nicht synchronisieren, bis Sie es wieder aktivieren. Ihre Änderungen bleiben auf ihrem Computer.

Eine entfernte Person bleibt draußen, auch wenn eine Domainregel ihre Adresse abdeckt oder ein Projektinhaber sie als Gast einlädt. Um sie wieder hineinzulassen, fügen Sie sie erneut per E-Mail-Adresse oder Benutzernamen hinzu. Sie bekommt ihr altes Konto zurück, mit jedem Projekt, das sie hatte.

Für einen Server, den jeder nutzen darf, setzen Sie OLEAFLY_OPEN_SIGNUP=true und starten ihn neu. Dann bekommt jeder, der sich über einen Ihrer Anbieter anmeldet, ein Konto mit der Rolle Mitglied, ohne Eintrag bei den zugelassenen Personen und ohne Domainregel. Ist Anmeldung per E-Mail eingeschaltet, funktioniert ein E-Mail-Link genauso.

Auch bei offener Registrierung bleiben Personen draußen, die Sie entfernt oder gesperrt haben, und alle, deren bestätigte Adresse zu einem entfernten Konto gehört. Sind Gäste erlaubt, wird jemand mit einer Gasteinladung bei der Anmeldung Mitglied und bekommt trotzdem die Projekte, zu denen er eingeladen wurde.

Sie schaltet außerdem Limits pro Konto ein: Sofern Sie keine anderen Werte setzen, darf jedes Konto 100 MB speichern, 50 geteilte Projekte besitzen und 300 Uploads pro Stunde machen.

Die Admin-Konsole zeigt nicht, ob die offene Registrierung eingeschaltet ist. Das Protokoll des Servers sagt es bei jedem Start: „Open sign-up is on, so anyone who signs in gets an account as a member.“ Mitglieder können einander nachschlagen, wenn sie ein Projekt teilen. Auf einem offenen Server sollten Sie daher erwägen, Mitgliederverzeichnis in den Servereinstellungen auszuschalten.

Jede Person hat eine Serverrolle, die Admins und Maintainer vergeben. In jedem Projekt, zu dem sie hinzugefügt wird, hat sie außerdem eine Projektrolle, die der Inhaber dieses Projekts vergibt. Rollen listet die Projektrollen auf: Inhaber, Bearbeiter, Gutachter, Kommentator und Betrachter.

Keine Serverrolle öffnet ein Projekt von selbst. Projektzugriff kommt nur vom Inhaber des Projekts.

AktionAdminMaintainerMitgliedGast
Den Server zu Oleafly hinzufügenJaJaJaJa
Die Mitgliederliste sehenJaJaJa, sofern ein Admin sie nicht verstecktNein
Ein Projekt teilenJaJaJaNein
Das Sicherheitsprotokoll lesenJaJaNeinNein
Mitglieder zum Server hinzufügenJaJaNeinNein
Maintainer ernennenJaNeinNeinNein
Servereinstellungen ändernJaNeinNeinNein
Ein Projekt löschen, um Speicher freizugebenJaNeinNeinNein
Das Gerät einer Person abmeldenJaJa, aber nicht das anderer Admins oder MaintainerNur eigene GeräteNur eigene Geräte
Gespeicherte Projekte mit direktem Serverzugriff lesenNicht in der AppNicht in der AppNicht in der AppNicht in der App

Die letzte Zeile ist am wichtigsten. Projekte sind auf dem Server nicht verschlüsselt, deshalb kann, wer die Maschine betreibt, jedes gespeicherte Projekt lesen, egal welche Rolle die Person hat. Oleafly gibt keiner Rolle, Admins eingeschlossen, einen Weg, das aus der App zu tun. Wenn ein Admin ein Projekt löscht, um Speicher freizugeben, werden der Inhaber und die Mitglieder informiert, und ihre eigenen Kopien bleiben auf ihren Computern.

Ein Gast ist eine Person von außerhalb Ihres Servers, etwa ein Koautor an einer anderen Universität, die ein Projektinhaber zu einem Projekt einlädt. Gäste sehen nur die Projekte, zu denen sie eingeladen wurden.

Auf einem neuen Server sind Gäste aus. Ein Admin schaltet sie mit Gäste erlauben in den Servereinstellungen ein. Gäste zuerst genehmigen ist standardmäßig eingeschaltet, deshalb genehmigt ein Admin oder Maintainer jede Einladung, bevor sie funktioniert. Schalten Sie es aus, damit Einladungen sofort wirken. Wenn ein Admin oder Maintainer eine Einladung verschickt, ist sie sofort genehmigt.

Schalten Sie Gäste erlauben später aus, können Inhaber keine neuen Einladungen mehr verschicken und unbenutzte Einladungen funktionieren nicht mehr. Gäste, die sich bereits angemeldet haben, behalten ihre Projekte, bis ein Inhaber sie entfernt oder Sie sie unter Personen entfernen.

Nur der Inhaber eines Projekts kann Gäste dazu einladen, aus dem Dialog Teilen des Projekts.

  • Eine Einladung gilt für eine Adresse und ein Projekt und endet nach 14 Tagen.
  • Eine Person kann bis zu 20 Einladungen pro Stunde verschicken.
  • Ist die Genehmigung eingeschaltet, wartet die Einladung unter Wartende Gäste oben in Personen. Admins und Maintainer genehmigen sie dort, lehnen sie ab oder ziehen sie zurück. Der Inhaber kann sie ebenfalls zurückziehen.
  • Verschickt der Server E-Mail und sind E-Mail-Benachrichtigungen eingeschaltet, bekommt der Gast eine Einladungs-E-Mail. Andernfalls gibt Oleafly dem Inhaber einen Zu Oleafly hinzufügen-Link, den er selbst verschicken kann.
  • Hat das Projekt bereits so viele Personen, wie der Server erlaubt, wartet die Einladung und funktioniert, sobald die Person das nächste Mal angemeldet ist, nachdem jemand gegangen ist.

Der Gast fügt den Server hinzu und meldet sich mit einer beliebigen Option an, die dem Server die eingeladene Adresse als bestätigte Adresse gibt: GitHub, ein OpenID-Connect-Anbieter oder ein E-Mail-Link. Eine unbestätigte Adresse zählt nicht. Die erste Anmeldung erstellt ein Gastkonto und öffnet jedes Projekt, zu dem diese Adresse eingeladen wurde.

Gäste können die Projekte öffnen und kompilieren, zu denen sie eingeladen wurden, sie bearbeiten, wenn ihre Rolle es erlaubt, und ihre eigenen Geräte abmelden. Sie können das Mitgliederverzeichnis und die E-Mail-Adresse niemandes sehen, keine Projekte teilen, keine anderen Personen einladen und keinem Projekt über seinen Link beitreten. Um einem Gast ein weiteres Projekt zu geben, lädt der Inhaber dieses Projekts dieselbe Adresse ein.

Wird ein Gast aus seinem letzten Projekt entfernt oder verlässt er es, beendet der Server den Zugriff. Er entfernt das Konto und meldet jedes Gerät ab. Eine neue Einladung bringt dasselbe Konto zurück. Entfernen Sie einen Gast unter Personen, während er noch Projekte hat, bringt eine neue Einladung ihn nicht zurück.

Wenn ein Inhaber jemanden aus einem Projekt entfernt, Gast oder nicht, kann diese Person nicht über den Link des Projekts zurückkommen, auch bei eingeschaltetem Teilen per Link. Jeder Versuch erscheint im Sicherheitsprotokoll. Um die Person wieder hineinzulassen, fügt der Inhaber sie erneut hinzu oder schickt eine neue Einladung, wenn sie Gast ist. Wer ein Projekt von selbst verlässt, kann über seinen Link weiterhin beitreten.

Mit eingeschaltetem Browserzugriff können Personen die mit ihnen geteilten Projekte in einem Webbrowser öffnen, ohne Oleafly zu installieren. Sie bearbeiten, schlagen Änderungen vor, kommentieren, chatten und lesen das neueste kompilierte PDF. Im Browser arbeiten beschreibt, was sie sehen.

Setzen Sie OLEAFLY_WEB=true und starten Sie den Server neu. Das veröffentlichte Container-Image enthält die Browser-App. Ein Build ohne sie schreibt ins Protokoll: „OLEAFLY_WEB is true, but this build of Oleafly Server has no browser app, so browser access stays off.“

Sobald er eingeschaltet ist:

  • Die Browser-App liegt unter der Adresse Ihres Servers, gefolgt von /web/, etwa https://collab.example.org/web/. Die Seite jedes Projekts unter /p/ bekommt außerdem einen Link Im Browser öffnen.
  • Personen melden sich unter /web/sign-in mit denselben Anbietern und E-Mail-Links an wie in Oleafly, und dieselben Zugangsregeln entscheiden, wer hineinkommt. Ein Browser bleibt 30 Tage angemeldet.
  • Jeder Browser zählt als Gerät des jeweiligen Kontos, mit einem Namen wie „Safari on macOS“. Er erscheint in der Geräteliste der Person und im Sicherheitsprotokoll, und wenn Sie ihn abmelden, endet die Sitzung dieses Browsers.
  • Der Browser verbindet sich per WebSocket mit /web/ws und hat keinen langsameren Ausweichweg, deshalb muss Ihr Proxy dort WebSocket-Upgrades durchreichen. Caddy und die Beispiele für nginx und Apache unter Hinter einem Reverse-Proxy tun das bereits.
  • Das PDF, das Personen lesen, ist das neueste, das ein Inhaber oder Bearbeiter in Oleafly kompiliert hat. Kompilierte PDFs erklärt, wie es dorthin kommt.

Die Browser-App lässt sich nicht in einem Frame auf einer anderen Website anzeigen. Sie verbindet sich nur mit Ihrem Server, abgesehen vom Laden der Avatarbilder von Personen.

Die Admin-Konsole ist ein Fenster zum Betreiben eines einzelnen Servers aus Oleafly. Admins und Maintainer können sie öffnen. Wählen Sie unter Einstellungen → Zusammenarbeit auf der Serverkarte Admin-Konsole öffnen oder oben unter Server verwalten. Jeder Server bekommt sein eigenes Fenster.

AbschnittWas er zeigt und tut
ÜberblickOb der Server gesund ist, wie viele Personen, Geräte und Projekte er hat, wer online ist, wie viel Speicher er verwendet, seine E-Mail- und Anmeldeoptionen und seine Einstellungen auf einen Blick. Er warnt mit Niemand kann sich anmelden, wenn der Server keine Anmeldeoption hat, und mit Der Server kann keine Dateien speichern, wenn der Datenordner nicht beschreibbar ist.
PersonenAlle, die sich angemeldet haben. Rollen ändern, Personen sperren oder entfernen und ihre Geräte abmelden. Gasteinladungen, die auf Genehmigung warten, stehen oben.
ZugangsregelnDie Liste der zugelassenen Personen und die Domainregeln.
ProjekteJedes auf dem Server geteilte Projekt, mit seinem Inhaber, wie viele Personen es hat, seiner Größe und seiner letzten Aktivität. Nach Titel oder Inhaber suchen, nur geteilte, archivierte oder im Upload befindliche Projekte zeigen und ein Projekt archivieren oder wiederherstellen.
EinstellungenDie Servereinstellungen.
E-MailOb E-Mail eingerichtet ist, die Absenderadresse und der letzte Fehlschlag. Von hier eine Test-E-Mail senden.
SicherheitsprotokollAnmeldungen und abgelehnte Anmeldungen, Geräte, Personen, Einstellungen, Projekte und Gäste. Jeder Eintrag sagt, wer es getan hat, wann und von welcher IP-Adresse, mit Details wie dem Projekt, der benutzten Anmeldeoption oder dem Grund einer abgelehnten Anmeldung.
VerbindungstestsDieselben Prüfungen wie Verbindung testen, ausgeführt von Ihrem Computer zum Server.

Maintainer können jeden Abschnitt benutzen, aber sie können niemanden zum Admin oder Maintainer machen, die Geräte anderer Admins oder Maintainer sehen oder abmelden, die Speichernutzung sehen, Projekte archivieren oder wiederherstellen, Servereinstellungen ändern oder eine Test-E-Mail senden. Admins können all das.

Ein Projekt zu archivieren beendet das Teilen für alle. Personen synchronisieren es nicht mehr und behalten ihre eigenen Kopien, und der Server löscht es nach OLEAFLY_ARCHIVE_DAYS Tagen, sofern ein Admin es nicht vorher wiederherstellt. Das Wiederherstellen teilt es wieder mit denselben Personen. Ein Projekt, dessen erste Übertragung nie abgeschlossen wurde, kann nicht wiederhergestellt werden. Beides erscheint im Sicherheitsprotokoll.

Die Konsole öffnet nie ein Projekt. Sie zeigt Titel, Inhaber und Größen, aber nichts darin.

Diese gelten für alle auf dem Server. Nur Admins können sie ändern.

EinstellungWas sie tut
Gäste erlaubenMitglieder können Personen von außerhalb des Servers zu Projekten einladen, die ihnen gehören.
Gäste zuerst genehmigenEin Maintainer oder Admin genehmigt jede Gasteinladung, bevor sie funktioniert.
MitgliederverzeichnisMitglieder können einander nach Namen nachschlagen, wenn sie ein Projekt teilen.
E-Mail-Adressen im Verzeichnis zeigenMitglieder sehen die E-Mail-Adressen der anderen, wenn sie jemanden nachschlagen.
Teilen per Link erlaubenProjektinhaber können jedem Mitglied erlauben, ein Projekt über seinen Link zu öffnen.
Öffentliche Links zu Notizen erlaubenMitglieder können eine schreibgeschützte Kopie einer Notiz unter einem Link veröffentlichen, den jeder ohne Anmeldung öffnen kann. Standardmäßig ist das ausgeschaltet. Schalten Sie es aus, werden alle veröffentlichten Links gestoppt, bis Sie es wieder einschalten. Siehe Eine schreibgeschützte Kopie veröffentlichen.
Zugriffsprotokolle für Projekte erlaubenProjektinhaber können ein Protokoll führen, wer ihr Projekt geöffnet hat.
Kommentare erlaubenPersonen in geteilten Projekten können Text kommentieren und antworten. Das Ausschalten versteckt Kommentare überall und speichert sie weiter.
E-Mail-BenachrichtigungenSchalten Sie dies aus, um die E-Mails des Servers für alle zu stoppen, außer die Anmeldelinks.
Anmeldung per E-MailPersonen können sich mit einem Link anmelden, der an ihre E-Mail-Adresse geschickt wird. Dafür braucht es die E-Mail-Einstellungen des Servers.
Bildvorschau

KI-Antworten konnten nicht geladen werden

Versuchen Sie es erneut oder durchsuchen Sie die Dokumentation.