Přejít na hlavní obsah
Ayakaleaf Pro obsahuje modul, který stahuje stránky z webu MediaWiki na vámi nastavené URL a poskytuje je ve vaší instanci pod cestou /learn. Ayakaleaf Pro samo žádný obsah wiki nedodává, nehostuje ani nešíří. Chcete-li modul povolit, přidejte do souboru config/variables.env v Toolkitu OVERLEAF_PROXY_LEARN=true a spusťte příkaz bin/up. Uživatelé pak mohou stránky wiki otevřít kliknutím na tlačítko Documentation v navigační nabídce, aniž by opustili vaši instanci.
Ve výchozím nastavení mohou /learn otevřít pouze přihlášení uživatelé. Chcete-li stránky zpřístupnit i nepřihlášeným návštěvníkům, nastavte také OVERLEAF_ALLOW_PUBLIC_ACCESS=true, viz Page Access.
U nasazení pomocí Docker Compose je třeba přidat proměnnou prostředí OVERLEAF_PROXY_LEARN: true do sekce environment služby sharelatex ve vašem souboru docker-compose.yml.
Když tuto možnost poprvé povolíte a restartujete svůj Docker kontejner Overleaf, systém musí stáhnout příslušnou Wiki, což může trvat 5 minut i déle. Přihlašovací stránku Overleafu uvidíte až po dokončení stahování.

Volba zdroje wiki

Wiki, která se má zprostředkovat, se nastavuje pomocí WIKI_URL. Pokud ji nenastavíte, použije se výchozí hodnota převzatá z upstreamové konfigurace Overleafu (services/web/config/settings.defaults.js):
Jde o wiki, na které stojí stránky Overleaf Learn. Vaše instance k ní potřebuje přístup k internetu.
Dbejte na autorská práva. Modul stahuje pouze z URL uvedené v WIKI_URL; obsah patří tomu, kdo danou wiki provozuje. Když je modul povolen, vaše instance stáhne všechny stránky této wiki a uchovává jejich kopii na vašem serveru. Výchozí wiki provozuje Overleaf a její obsah vlastní Overleaf, nikoli Ayakaleaf Pro. Před povolením modulu ověřte, že stahování, ukládání a poskytování těchto stránek je v souladu s podmínkami Overleafu, zejména pokud je vaše instance otevřená nepřihlášeným návštěvníkům. V případě pochybností nasměrujte WIKI_URL na wiki, jejíž obsah vlastníte nebo k jehož užití máte licenci.
Místo toho můžete WIKI_URL nasměrovat na vlastní wiki, například na interní znalostní bázi:
Wiki musí být web MediaWiki, který poskytuje:
  • své API na <WIKI_URL>/learn-scripts/api.php s anonymním přístupem pro čtení k action=query a action=parse
  • nahrané obrázky pod <WIKI_URL>/learn-scripts/images/
  • odkazy na články ve tvaru /learn/<Page>, které modul ve vaší instanci přepisuje na /learn/latex/<Page>
Tyto cesty jsou v modulu pevně dané a odpovídají uspořádání výchozí wiki. Čerstvá instalace MediaWiki používá jiné, proto v jejím LocalSettings.php nastavte následující (nebo cesty namapujte v reverzní proxy):
Stránky se mapují takto:

Cache

Stažené stránky se ukládají do cache v /var/lib/overleaf/data/learnPages uvnitř kontejneru sharelatex. Stránka v cache se obnoví, je-li starší než WIKI_MAX_CACHE_AGE milisekund (výchozí 300000, 5 minut). Pokud je wiki nedostupná, nadále se poskytuje kopie z cache.

Poděkování

Implementace modulu vychází z learn proxy v projektu overleaf-go od Jakoba Ackermanna, portu Overleafu do jazyka Go licencovaného pod AGPL-3.0, včetně jeho mapování stránek a využití MediaWiki API.
Naposledy změněno 2. listopadu 2026