Hoppa till huvudinnehåll
Ayakaleaf Pro innehåller en modul som laddar ned sidor från en MediaWiki-webbplats på en URL som du konfigurerar och serverar dem under /learn på din instans. Ayakaleaf Pro levererar, hostar eller distribuerar inte själv något wikiinnehåll. För att aktivera modulen lägger du till OVERLEAF_PROXY_LEARN=true i filen config/variables.env i Toolkit och kör kommandot bin/up. Användarna kan sedan öppna wikisidorna genom att klicka på knappen Documentation i navigeringsmenyn, utan att lämna din instans.
Som standard kan endast inloggade användare öppna /learn. För att göra sidan tillgänglig för utloggade besökare anger du även OVERLEAF_ALLOW_PUBLIC_ACCESS=true, se Page Access.
För Docker Compose-driftsättningar behöver du lägga till miljövariabeln OVERLEAF_PROXY_LEARN: true i avsnittet environment för tjänsten sharelatex i din docker-compose.yml-fil.
När du aktiverar det här alternativet första gången och startar om din Overleaf-container behöver systemet ladda ned den aktuella wikin, vilket kan ta upp till 5 minuter eller mer. Först när nedladdningen är klar kan du se din Overleaf-inloggningssida.

Välja wikikälla

Wikin som ska proxas anges med WIKI_URL. Om du lämnar den oangiven används standardvärdet som ärvs från den uppströms Overleaf-konfigurationen (services/web/config/settings.defaults.js):
Det här är wikin bakom Overleaf Learn-sidorna. Din instans behöver internetåtkomst för att nå den.
Tänk på upphovsrätten. Modulen hämtar bara från URL:en i WIKI_URL; innehållet tillhör den som driver wikin. När modulen är aktiverad laddar din instans ned varje sida i wikin och sparar en kopia på din server. Standardwikin drivs av Overleaf, och dess innehåll ägs av Overleaf, inte av Ayakaleaf Pro. Innan du aktiverar modulen bör du kontrollera att nedladdning, lagring och servering av sidorna följer Overleafs villkor, särskilt om din instans är öppen för utloggade besökare. Om du är osäker kan du låta WIKI_URL peka på en wiki vars innehåll du äger eller har licens att använda.
Du kan i stället låta WIKI_URL peka på din egen wiki, till exempel en intern kunskapsbas:
Wikin måste vara en MediaWiki-webbplats som serverar:
  • sitt API på <WIKI_URL>/learn-scripts/api.php, med anonym läsåtkomst till action=query och action=parse
  • uppladdade bilder under <WIKI_URL>/learn-scripts/images/
  • artikellänkar på formen /learn/<Page>, som modulen skriver om till /learn/latex/<Page> på din instans
Dessa sökvägar är fasta i modulen och följer strukturen i standardwikin. En ny MediaWiki-installation använder andra sökvägar, så ange följande i dess LocalSettings.php (eller mappa sökvägarna i din omvända proxy):
Sidorna mappas enligt följande:

Cache

Hämtade sidor cachas i /var/lib/overleaf/data/learnPages i containern sharelatex. En cachad sida uppdateras när den är äldre än WIKI_MAX_CACHE_AGE millisekunder (standard 300000, 5 minuter). Om wikin inte går att nå fortsätter den cachade kopian att serveras.

Erkännanden

Modulens implementation bygger på learn-proxyn i overleaf-go av Jakob Ackermann, en Golang-portering av Overleaf licensierad under AGPL-3.0, inklusive dess sidmappning och dess användning av MediaWiki-API:et.
Senast ändrad 2 november 2026