Перейти до основного вмісту
Ayakaleaf Pro містить модуль, який завантажує сторінки із сайту MediaWiki за налаштованою вами URL-адресою і відображає їх за шляхом /learn у вашому екземплярі. Сам Ayakaleaf Pro не постачає, не розміщує й не поширює жодного вмісту wiki. Щоб увімкнути модуль, додайте OVERLEAF_PROXY_LEARN=true до файлу config/variables.env у Toolkit і виконайте команду bin/up. Після цього користувачі можуть відкривати сторінки wiki, натиснувши кнопку Documentation у навігаційному меню, не залишаючи вашого екземпляра.
За замовчуванням відкрити /learn можуть лише користувачі, які увійшли в систему. Щоб зробити сторінки доступними для відвідувачів, які не ввійшли, також встановіть OVERLEAF_ALLOW_PUBLIC_ACCESS=true, див. Page Access.
Для розгортань через Docker Compose потрібно додати змінну середовища OVERLEAF_PROXY_LEARN: true до розділу environment служби sharelatex у файлі docker-compose.yml.
Коли ви вперше вмикаєте цей параметр і перезапускаєте Docker з Overleaf, система має завантажити відповідну Wiki, що може тривати 5 хвилин або довше. Лише після завершення завантаження ви зможете побачити сторінку входу Overleaf.

Вибір джерела wiki

Wiki для проксування задається змінною WIKI_URL. Якщо її не встановлено, використовується значення за замовчуванням, успадковане з конфігурації upstream Overleaf (services/web/config/settings.defaults.js):
Це wiki, на якій базуються сторінки Overleaf Learn. Вашому екземпляру потрібен доступ до інтернету, щоб звертатися до неї.
Зважайте на авторські права. Модуль лише завантажує дані з URL-адреси у WIKI_URL; вміст належить тому, хто керує цією wiki. Коли модуль увімкнено, ваш екземпляр завантажує всі сторінки цієї wiki і зберігає їхню копію на вашому сервері. Wiki за замовчуванням керує Overleaf, і її вміст належить Overleaf, а не Ayakaleaf Pro. Перш ніж увімкнути модуль, переконайтеся, що завантаження, зберігання й відображення цих сторінок відповідає умовам Overleaf, особливо якщо ваш екземпляр відкритий для відвідувачів, які не ввійшли в систему. Якщо маєте сумніви, вкажіть у WIKI_URL wiki, вміст якої належить вам або на використання якої ви маєте ліцензію.
Натомість ви можете вказати у WIKI_URL власну wiki, наприклад внутрішню базу знань:
Wiki має бути сайтом MediaWiki, який надає:
  • свій API за адресою <WIKI_URL>/learn-scripts/api.php з анонімним доступом на читання до action=query і action=parse
  • завантажені зображення за шляхом <WIKI_URL>/learn-scripts/images/
  • посилання на статті у формі /learn/<Page>, які модуль перетворює на /learn/latex/<Page> у вашому екземплярі
Ці шляхи жорстко задані в модулі й відповідають структурі wiki за замовчуванням. Свіжа інсталяція MediaWiki використовує інші шляхи, тож задайте таке в її LocalSettings.php (або зіставте шляхи у своєму зворотному проксі):
Сторінки зіставляються так:

Кеш

Завантажені сторінки кешуються в /var/lib/overleaf/data/learnPages всередині контейнера sharelatex. Кешована сторінка оновлюється, коли вона старша за WIKI_MAX_CACHE_AGE мілісекунд (за замовчуванням 300000, 5 хвилин). Якщо wiki недоступна, і далі відображається кешована копія.

Подяки

Реалізація модуля спирається на learn-проксі в overleaf-go від Jakob Ackermann — порті Overleaf на Golang під ліцензією AGPL-3.0, зокрема на його зіставлення сторінок і використання MediaWiki API.
Останнє оновлення 2 листопада 2026 р.