Hopp til hovedinnhold
Ayakaleaf Pro inneholder en modul som laster ned sider fra et MediaWiki-nettsted på en URL du konfigurerer, og serverer dem under /learn på instansen din. Ayakaleaf Pro leverer, hoster eller distribuerer ikke selv noe wiki-innhold. For å aktivere modulen legger du til OVERLEAF_PROXY_LEARN=true i config/variables.env-filen i Toolkit og kjører kommandoen bin/up. Brukerne kan deretter åpne wiki-sidene ved å klikke på Documentation-knappen i navigasjonsmenyen, uten å forlate instansen din.
Som standard kan bare innloggede brukere åpne /learn. For å gjøre siden tilgjengelig for besøkende som ikke er logget inn, setter du også OVERLEAF_ALLOW_PUBLIC_ACCESS=true, se Page Access.
For Docker Compose-distribusjoner må du legge til miljøvariabelen OVERLEAF_PROXY_LEARN: true i environment-seksjonen for sharelatex-tjenesten i docker-compose.yml-filen din.
Når du aktiverer dette alternativet for første gang og starter Overleaf-containeren på nytt, må systemet laste ned den aktuelle wikien, noe som kan ta opptil 5 minutter eller mer. Først når nedlastingen er fullført, vil du kunne se innloggingssiden til Overleaf.

Velge wiki-kilden

Wikien som skal proxyes, angis med WIKI_URL. Hvis du lar den være uangitt, brukes standardverdien som er arvet fra upstream-konfigurasjonen til Overleaf (services/web/config/settings.defaults.js):
Dette er wikien bak Overleaf Learn-sidene. Instansen din trenger internettilgang for å nå den.
Vær oppmerksom på opphavsretten. Modulen henter bare fra URL-en i WIKI_URL; innholdet tilhører den som driver den wikien. Når modulen er aktivert, laster instansen din ned hver eneste side i wikien og lagrer en kopi på serveren din. Standardwikien drives av Overleaf, og innholdet eies av Overleaf, ikke av Ayakaleaf Pro. Før du aktiverer modulen, må du kontrollere at nedlasting, lagring og servering av disse sidene er i samsvar med Overleafs vilkår, særlig hvis instansen din er åpen for besøkende som ikke er logget inn. Hvis du er i tvil, kan du peke WIKI_URL mot en wiki der du eier innholdet eller har lisens til å bruke det.
Du kan i stedet peke WIKI_URL mot din egen wiki, for eksempel en intern kunnskapsbase:
Wikien må være et MediaWiki-nettsted som serverer:
  • API-et sitt på <WIKI_URL>/learn-scripts/api.php, med anonym lesetilgang til action=query og action=parse
  • opplastede bilder under <WIKI_URL>/learn-scripts/images/
  • artikkellenker på formen /learn/<Page>, som modulen skriver om til /learn/latex/<Page> på instansen din
Disse stiene er faste i modulen og følger oppsettet til standardwikien. En ny MediaWiki-installasjon bruker andre stier, så angi følgende i LocalSettings.php (eller tilordne stiene i reverse proxyen din):
Sidene tilordnes slik:

Hurtigbuffer

Hentede sider hurtigbufres i /var/lib/overleaf/data/learnPages inne i sharelatex-containeren. En hurtigbufret side oppdateres når den er eldre enn WIKI_MAX_CACHE_AGE millisekunder (standard 300000, 5 minutter). Hvis wikien ikke kan nås, fortsetter den hurtigbufrede kopien å bli servert.

Anerkjennelser

Implementasjonen av modulen bygger på learn-proxyen i overleaf-go av Jakob Ackermann, en Golang-port av Overleaf lisensiert under AGPL-3.0, inkludert sidetilordningen og bruken av MediaWiki-API-et.
Sist endret 2. november 2026