Перейти к основному содержанию
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 г.