Skip to main content
Ayakaleaf Pro includes a module that downloads pages from a MediaWiki site at a URL you configure and serves them under /learn on your instance. Ayakaleaf Pro does not ship, host or distribute any wiki content itself. To enable the module, add OVERLEAF_PROXY_LEARN=true to your config/variables.env file in the Toolkit and run the bin/up command. Users can then open the wiki pages by clicking the Documentation button in the navigation menu, without leaving your instance.
By default only logged-in users can open /learn. To make it available to signed-out visitors, also set OVERLEAF_ALLOW_PUBLIC_ACCESS=true, see Page Access.
For Docker Compose deployments, you’ll need to add the environment variable OVERLEAF_PROXY_LEARN: true to the environment section of the sharelatex service in to your docker-compose.yml file.
When you firstly enable this option and reboot your Overleaf docker, the system needs to download the relevant Wiki, which may take up to 5 minutes or more. Only after the download is complete will you be able to successfully see your Overleaf login page.

Choosing the wiki source

The wiki to proxy is set with WIKI_URL. If you leave it unset, the default inherited from the upstream Overleaf configuration (services/web/config/settings.defaults.js) is used:
This is the wiki behind the Overleaf Learn pages. Your instance needs internet access to reach it.
Mind the copyright. The module only fetches from the URL in WIKI_URL; the content belongs to whoever runs that wiki. When it is enabled, your instance downloads every page of that wiki and keeps a copy on your server. The default wiki is run by Overleaf, and its content is owned by Overleaf, not by Ayakaleaf Pro. Before enabling the module, check that downloading, storing and serving those pages complies with Overleaf’s terms, especially if your instance is open to signed-out visitors. If in doubt, point WIKI_URL at a wiki whose content you own or are licensed to use.
You can point WIKI_URL at your own wiki instead, for example an internal knowledge base:
The wiki must be a MediaWiki site that serves:
  • its API at <WIKI_URL>/learn-scripts/api.php, with anonymous read access to action=query and action=parse
  • uploaded images under <WIKI_URL>/learn-scripts/images/
  • article links of the form /learn/<Page>, which the module rewrites to /learn/latex/<Page> on your instance
These paths are fixed in the module and follow the layout of the default wiki. A fresh MediaWiki install uses different ones, so set the following in its LocalSettings.php (or map the paths in your reverse proxy):
Pages are mapped as follows:

Cache

Fetched pages are cached in /var/lib/overleaf/data/learnPages inside the sharelatex container. A cached page is refreshed when it is older than WIKI_MAX_CACHE_AGE milliseconds (default 300000, 5 minutes). If the wiki is unreachable, the cached copy keeps being served.

Credits

The module’s implementation references the learn proxy in overleaf-go by Jakob Ackermann, a Golang port of Overleaf licensed under AGPL-3.0, including its page mapping and its use of the MediaWiki API.
Last modified on November 2, 2026