Naar hoofdinhoud gaan
Ayakaleaf Pro bevat een module die pagina’s downloadt van een MediaWiki-site op een URL die je zelf configureert en deze onder /learn op je instantie aanbiedt. Ayakaleaf Pro levert, host of verspreidt zelf geen wiki-inhoud. Om de module in te schakelen, voeg je OVERLEAF_PROXY_LEARN=true toe aan je bestand config/variables.env in de Toolkit en voer je de opdracht bin/up uit. Gebruikers kunnen de wikipagina’s vervolgens openen door op de knop Documentation in het navigatiemenu te klikken, zonder je instantie te verlaten.
Standaard kunnen alleen ingelogde gebruikers /learn openen. Om het beschikbaar te maken voor bezoekers die niet zijn ingelogd, stel je ook OVERLEAF_ALLOW_PUBLIC_ACCESS=true in; zie Page Access.
Voor Docker Compose-implementaties moet je de omgevingsvariabele OVERLEAF_PROXY_LEARN: true toevoegen aan de sectie environment van de service sharelatex in je bestand docker-compose.yml.
Wanneer je deze optie voor het eerst inschakelt en je Overleaf-Docker herstart, moet het systeem de betreffende wiki downloaden, wat 5 minuten of langer kan duren. Pas nadat de download is voltooid, zie je je Overleaf-inlogpagina.

De wikibron kiezen

De wiki die wordt geproxied, stel je in met WIKI_URL. Als je deze niet instelt, wordt de standaardwaarde gebruikt die is overgenomen uit de upstream Overleaf-configuratie (services/web/config/settings.defaults.js):
Dit is de wiki achter de Overleaf Learn-pagina’s. Je instantie heeft internettoegang nodig om deze te bereiken.
Let op het auteursrecht. De module haalt alleen gegevens op van de URL in WIKI_URL; de inhoud is eigendom van degene die die wiki beheert. Wanneer de module is ingeschakeld, downloadt je instantie elke pagina van die wiki en bewaart een kopie op je server. De standaardwiki wordt beheerd door Overleaf en de inhoud ervan is eigendom van Overleaf, niet van Ayakaleaf Pro. Controleer voordat je de module inschakelt of het downloaden, opslaan en aanbieden van die pagina’s in overeenstemming is met de voorwaarden van Overleaf, vooral als je instantie open is voor bezoekers die niet zijn ingelogd. Twijfel je, laat WIKI_URL dan verwijzen naar een wiki waarvan je de inhoud bezit of waarvoor je een licentie hebt.
Je kunt WIKI_URL in plaats daarvan ook naar je eigen wiki laten verwijzen, bijvoorbeeld een interne kennisbank:
De wiki moet een MediaWiki-site zijn die het volgende aanbiedt:
  • de API op <WIKI_URL>/learn-scripts/api.php, met anonieme leestoegang tot action=query en action=parse
  • geüploade afbeeldingen onder <WIKI_URL>/learn-scripts/images/
  • artikellinks in de vorm /learn/<Page>, die de module op je instantie herschrijft naar /learn/latex/<Page>
Deze paden liggen vast in de module en volgen de indeling van de standaardwiki. Een nieuwe MediaWiki-installatie gebruikt andere paden, dus stel het volgende in via het bestand LocalSettings.php (of koppel de paden in je reverse proxy):
Pagina’s worden als volgt gekoppeld:

Cache

Opgehaalde pagina’s worden gecachet in /var/lib/overleaf/data/learnPages binnen de container sharelatex. Een gecachete pagina wordt vernieuwd wanneer deze ouder is dan WIKI_MAX_CACHE_AGE milliseconden (standaard 300000, 5 minuten). Als de wiki onbereikbaar is, wordt de gecachete kopie gewoon verder aangeboden.

Credits

De implementatie van de module verwijst naar de learn-proxy in overleaf-go van Jakob Ackermann, een Golang-port van Overleaf onder de AGPL-3.0-licentie, inclusief de paginakoppeling en het gebruik van de MediaWiki API.
Laatst gewijzigd op 2 november 2026