/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 withWIKI_URL. If you leave it unset, the default inherited from the upstream Overleaf configuration (services/web/config/settings.defaults.js) is used:
WIKI_URL at your own wiki instead, for example an internal knowledge base:
-
its API at
<WIKI_URL>/learn-scripts/api.php, with anonymous read access toaction=queryandaction=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
LocalSettings.php (or map the paths in your reverse proxy):
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.

