Siirry pääsisältöön
Ayakaleaf Pro sisältää moduulin, joka lataa sivuja määrittämästäsi MediaWiki-sivustosta ja tarjoaa ne instanssisi polussa /learn. Ayakaleaf Pro ei itse toimita, isännöi eikä jaa mitään wikisisältöä. Ota moduuli käyttöön lisäämällä rivi OVERLEAF_PROXY_LEARN=true Toolkitin config/variables.env-tiedostoon ja ajamalla komento bin/up. Käyttäjät voivat sen jälkeen avata wikisivut napsauttamalla navigointivalikon Documentation-painiketta poistumatta instanssistasi.
Oletuksena vain kirjautuneet käyttäjät voivat avata /learn-sivun. Jos haluat sen myös kirjautumattomien vierailijoiden saataville, aseta lisäksi OVERLEAF_ALLOW_PUBLIC_ACCESS=true, katso Page Access.
Docker Compose -käyttöönotoissa sinun on lisättävä ympäristömuuttuja OVERLEAF_PROXY_LEARN: true docker-compose.yml-tiedoston sharelatex-palvelun environment-osioon.
Kun otat tämän asetuksen ensimmäistä kertaa käyttöön ja käynnistät Overleaf-Docker-konttisi uudelleen, järjestelmän on ladattava asiaankuuluva Wiki, mikä voi kestää 5 minuuttia tai kauemmin. Vasta kun lataus on valmis, Overleafin kirjautumissivu näkyy onnistuneesti.

Wikilähteen valitseminen

Välitettävä wiki asetetaan muuttujalla WIKI_URL. Jos jätät sen asettamatta, käytetään upstream-Overleafin määrityksestä (services/web/config/settings.defaults.js) perittyä oletusarvoa:
Tämä on Overleaf Learn -sivujen taustalla oleva wiki. Instanssisi tarvitsee internetyhteyden tavoittaakseen sen.
Huomioi tekijänoikeudet. Moduuli hakee sisältöä vain WIKI_URL-muuttujan osoitteesta; sisältö kuuluu sille, joka ylläpitää kyseistä wikiä. Kun moduuli on käytössä, instanssisi lataa wikin jokaisen sivun ja säilyttää niistä kopion palvelimellasi. Oletuswikiä ylläpitää Overleaf, ja sen sisällön omistaa Overleaf, ei Ayakaleaf Pro. Tarkista ennen moduulin käyttöönottoa, että sivujen lataaminen, tallentaminen ja tarjoaminen on Overleafin ehtojen mukaista, erityisesti jos instanssisi on avoin kirjautumattomille vierailijoille. Jos olet epävarma, osoita WIKI_URL wikiin, jonka sisällön omistat tai jonka käyttöön sinulla on lisenssi.
Voit sen sijaan osoittaa WIKI_URL-muuttujan omaan wikiisi, esimerkiksi sisäiseen tietokantaan:
Wikin on oltava MediaWiki-sivusto, joka tarjoaa:
  • API:nsa osoitteessa <WIKI_URL>/learn-scripts/api.php niin, että action=query- ja action=parse-toimintoihin on anonyymi lukuoikeus
  • ladatut kuvat polussa <WIKI_URL>/learn-scripts/images/
  • artikkelilinkit muodossa /learn/<Page>, jotka moduuli kirjoittaa instanssissasi muotoon /learn/latex/<Page>
Nämä polut on kiinnitetty moduuliin, ja ne noudattavat oletuswikin rakennetta. Uusi MediaWiki-asennus käyttää eri polkuja, joten aseta seuraavat sen LocalSettings.php-tiedostoon (tai ohjaa polut käänteisessä välityspalvelimessasi):
Sivut vastaavat toisiaan seuraavasti:

Välimuisti

Haetut sivut tallennetaan välimuistiin hakemistoon /var/lib/overleaf/data/learnPages sharelatex-kontin sisällä. Välimuistissa oleva sivu päivitetään, kun se on vanhempi kuin WIKI_MAX_CACHE_AGE millisekuntia (oletus 300000, 5 minuuttia). Jos wikiin ei saada yhteyttä, välimuistissa olevaa kopiota tarjotaan edelleen.

Kiitokset

Moduulin toteutus pohjautuu Jakob Ackermannin overleaf-go-projektin learn-välityspalvelimeen. overleaf-go on AGPL-3.0-lisensoitu Overleafin Golang-versio, ja moduuli hyödyntää myös sen sivujen vastaavuuksia ja MediaWiki API:n käyttötapaa.
Viimeksi muokattu 2. marraskuuta 2026