Zum Hauptinhalt springen
Ayakaleaf Pro enthält ein Modul, das Seiten von einer MediaWiki-Site unter einer von Ihnen konfigurierten URL herunterlädt und sie unter /learn auf Ihrer Instanz bereitstellt. Ayakaleaf Pro selbst liefert, hostet oder verbreitet keinerlei Wiki-Inhalte. Um das Modul zu aktivieren, fügen Sie OVERLEAF_PROXY_LEARN=true zu Ihrer Datei config/variables.env im Toolkit hinzu und führen Sie den Befehl bin/up aus. Benutzer können die Wiki-Seiten dann über die Schaltfläche Documentation im Navigationsmenü öffnen, ohne Ihre Instanz zu verlassen.
Standardmäßig können nur angemeldete Benutzer /learn öffnen. Um die Seiten auch für nicht angemeldete Besucher verfügbar zu machen, setzen Sie zusätzlich OVERLEAF_ALLOW_PUBLIC_ACCESS=true, siehe Seitenzugriff.
Bei Docker-Compose-Deployments müssen Sie die Umgebungsvariable OVERLEAF_PROXY_LEARN: true zum Abschnitt environment des Dienstes sharelatex in Ihrer Datei docker-compose.yml hinzufügen.
Wenn Sie diese Option zum ersten Mal aktivieren und Ihren Overleaf-Docker-Container neu starten, muss das System das zugehörige Wiki herunterladen, was 5 Minuten oder länger dauern kann. Erst nach Abschluss des Downloads wird Ihre Overleaf-Anmeldeseite erfolgreich angezeigt.

Auswahl der Wiki-Quelle

Das zu proxyende Wiki wird mit WIKI_URL festgelegt. Wenn Sie die Variable nicht setzen, wird der aus der Upstream-Konfiguration von Overleaf (services/web/config/settings.defaults.js) übernommene Standardwert verwendet:
Dies ist das Wiki hinter den Overleaf Learn-Seiten. Ihre Instanz benötigt Internetzugang, um es zu erreichen.
Beachten Sie das Urheberrecht. Das Modul ruft nur Inhalte von der URL in WIKI_URL ab; die Inhalte gehören dem Betreiber dieses Wikis. Wenn das Modul aktiviert ist, lädt Ihre Instanz jede Seite dieses Wikis herunter und speichert eine Kopie auf Ihrem Server. Das Standard-Wiki wird von Overleaf betrieben, und seine Inhalte gehören Overleaf, nicht Ayakaleaf Pro. Prüfen Sie vor dem Aktivieren des Moduls, ob das Herunterladen, Speichern und Bereitstellen dieser Seiten mit den Bedingungen von Overleaf vereinbar ist, insbesondere wenn Ihre Instanz für nicht angemeldete Besucher zugänglich ist. Im Zweifelsfall richten Sie WIKI_URL auf ein Wiki, dessen Inhalte Ihnen gehören oder für das Sie eine Nutzungslizenz haben.
Sie können WIKI_URL stattdessen auch auf Ihr eigenes Wiki richten, zum Beispiel auf eine interne Wissensdatenbank:
Das Wiki muss eine MediaWiki-Site sein, die Folgendes bereitstellt:
  • ihre API unter <WIKI_URL>/learn-scripts/api.php, mit anonymem Lesezugriff auf action=query und action=parse
  • hochgeladene Bilder unter <WIKI_URL>/learn-scripts/images/
  • Artikellinks der Form /learn/<Page>, die das Modul auf Ihrer Instanz zu /learn/latex/<Page> umschreibt
Diese Pfade sind im Modul fest vorgegeben und folgen dem Aufbau des Standard-Wikis. Eine frische MediaWiki-Installation verwendet andere Pfade, setzen Sie daher Folgendes in deren LocalSettings.php (oder bilden Sie die Pfade in Ihrem Reverse Proxy ab):
Die Seiten werden wie folgt zugeordnet:

Cache

Abgerufene Seiten werden in /var/lib/overleaf/data/learnPages innerhalb des Containers sharelatex zwischengespeichert. Eine zwischengespeicherte Seite wird aktualisiert, wenn sie älter als WIKI_MAX_CACHE_AGE Millisekunden ist (Standard 300000, 5 Minuten). Ist das Wiki nicht erreichbar, wird weiterhin die zwischengespeicherte Kopie ausgeliefert.

Danksagung

Die Implementierung des Moduls orientiert sich am Learn-Proxy in overleaf-go von Jakob Ackermann, einer unter AGPL-3.0 lizenzierten Golang-Portierung von Overleaf, einschließlich dessen Seitenzuordnung und Nutzung der MediaWiki-API.
Zuletzt geändert am 2. November 2026