Przejdź do głównej treści
Ayakaleaf Pro zawiera moduł, który pobiera strony z witryny MediaWiki pod skonfigurowanym przez Ciebie adresem URL i udostępnia je pod ścieżką /learn w Twojej instancji. Ayakaleaf Pro sam nie dostarcza, nie hostuje ani nie rozpowszechnia żadnych treści wiki. Aby włączyć moduł, dodaj OVERLEAF_PROXY_LEARN=true do pliku config/variables.env w Toolkit i uruchom polecenie bin/up. Użytkownicy mogą wtedy otwierać strony wiki, klikając przycisk Documentation w menu nawigacyjnym — bez opuszczania instancji.
Domyślnie tylko zalogowani użytkownicy mogą otworzyć /learn. Aby udostępnić tę stronę niezalogowanym odwiedzającym, ustaw także OVERLEAF_ALLOW_PUBLIC_ACCESS=true, zobacz Page Access.
W przypadku wdrożeń Docker Compose musisz dodać zmienną środowiskową OVERLEAF_PROXY_LEARN: true do sekcji environment usługi sharelatex w pliku docker-compose.yml.
Gdy po raz pierwszy włączysz tę opcję i zrestartujesz kontener Docker Overleaf, system musi pobrać odpowiednie Wiki, co może potrwać 5 minut lub dłużej. Dopiero po zakończeniu pobierania zobaczysz poprawnie stronę logowania Overleaf.

Wybór źródła wiki

Wiki, do którego kierowane jest proxy, ustawia się za pomocą WIKI_URL. Jeśli pozostawisz tę zmienną nieustawioną, używana jest wartość domyślna odziedziczona z konfiguracji upstream Overleaf (services/web/config/settings.defaults.js):
To jest wiki, na którym opierają się strony Overleaf Learn. Twoja instancja potrzebuje dostępu do internetu, aby się z nim połączyć.
Pamiętaj o prawach autorskich. Moduł pobiera treści wyłącznie z adresu URL podanego w WIKI_URL; treści należą do tego, kto prowadzi dane wiki. Po włączeniu modułu Twoja instancja pobiera każdą stronę tego wiki i przechowuje jej kopię na Twoim serwerze. Domyślne wiki jest prowadzone przez Overleaf, a jego treści należą do Overleaf, a nie do Ayakaleaf Pro. Przed włączeniem modułu sprawdź, czy pobieranie, przechowywanie i udostępnianie tych stron jest zgodne z warunkami Overleaf, zwłaszcza jeśli Twoja instancja jest otwarta dla niezalogowanych odwiedzających. W razie wątpliwości skieruj WIKI_URL na wiki, którego treści są Twoją własnością lub do których korzystania masz licencję.
Zamiast tego możesz skierować WIKI_URL na własne wiki, na przykład wewnętrzną bazę wiedzy:
Wiki musi być witryną MediaWiki, która udostępnia:
  • swoje API pod adresem <WIKI_URL>/learn-scripts/api.php, z anonimowym dostępem do odczytu dla action=query i action=parse
  • przesłane obrazy pod <WIKI_URL>/learn-scripts/images/
  • linki do artykułów w postaci /learn/<Page>, które moduł przepisuje na /learn/latex/<Page> w Twojej instancji
Te ścieżki są na stałe zapisane w module i odpowiadają układowi domyślnego wiki. Świeża instalacja MediaWiki używa innych ścieżek, dlatego ustaw w jej pliku LocalSettings.php poniższe wartości (lub zmapuj ścieżki w swoim reverse proxy):
Strony są mapowane w następujący sposób:

Pamięć podręczna

Pobrane strony są buforowane w /var/lib/overleaf/data/learnPages wewnątrz kontenera sharelatex. Strona w pamięci podręcznej jest odświeżana, gdy jest starsza niż WIKI_MAX_CACHE_AGE milisekund (domyślnie 300000, czyli 5 minut). Jeśli wiki jest nieosiągalne, nadal udostępniana jest kopia z pamięci podręcznej.

Podziękowania

Implementacja modułu opiera się na proxy learn z projektu overleaf-go autorstwa Jakoba Ackermanna — portu Overleaf w języku Go, udostępnionego na licencji AGPL-3.0 — w tym na jego mapowaniu stron i sposobie korzystania z API MediaWiki.
Ostatnia modyfikacja 2 listopada 2026