Passer au contenu principal
Ayakaleaf Pro inclut un module qui télécharge les pages d’un site MediaWiki depuis une URL que vous configurez et les sert sous /learn sur votre instance. Ayakaleaf Pro ne fournit, n’héberge ni ne distribue lui-même aucun contenu de wiki. Pour activer le module, ajoutez OVERLEAF_PROXY_LEARN=true à votre fichier config/variables.env dans le Toolkit, puis exécutez la commande bin/up. Les utilisateurs peuvent alors ouvrir les pages du wiki en cliquant sur le bouton Documentation du menu de navigation, sans quitter votre instance.
Par défaut, seuls les utilisateurs connectés peuvent ouvrir /learn. Pour la rendre accessible aux visiteurs non connectés, définissez également OVERLEAF_ALLOW_PUBLIC_ACCESS=true ; voir Accès aux pages.
Pour les déploiements Docker Compose, vous devez ajouter la variable d’environnement OVERLEAF_PROXY_LEARN: true à la section environment du service sharelatex dans votre fichier docker-compose.yml.
Lorsque vous activez cette option pour la première fois et redémarrez votre conteneur Docker Overleaf, le système doit télécharger le wiki correspondant, ce qui peut prendre 5 minutes ou plus. Ce n’est qu’une fois le téléchargement terminé que la page de connexion d’Overleaf s’affichera correctement.

Choisir la source du wiki

Le wiki à relayer est défini par WIKI_URL. Si vous ne la définissez pas, la valeur par défaut héritée de la configuration Overleaf amont (services/web/config/settings.defaults.js) est utilisée :
Il s’agit du wiki derrière les pages Overleaf Learn. Votre instance doit disposer d’un accès à Internet pour l’atteindre.
Attention aux droits d’auteur. Le module récupère uniquement le contenu depuis l’URL définie dans WIKI_URL ; ce contenu appartient à l’exploitant de ce wiki. Lorsque le module est activé, votre instance télécharge toutes les pages de ce wiki et en conserve une copie sur votre serveur. Le wiki par défaut est exploité par Overleaf, et son contenu appartient à Overleaf, et non à Ayakaleaf Pro. Avant d’activer le module, vérifiez que le téléchargement, le stockage et la diffusion de ces pages respectent les conditions d’Overleaf, en particulier si votre instance est ouverte aux visiteurs non connectés. En cas de doute, faites pointer WIKI_URL vers un wiki dont vous possédez le contenu ou pour lequel vous disposez d’une licence d’utilisation.
Vous pouvez à la place faire pointer WIKI_URL vers votre propre wiki, par exemple une base de connaissances interne :
Le wiki doit être un site MediaWiki qui sert :
  • son API à l’adresse <WIKI_URL>/learn-scripts/api.php, avec un accès anonyme en lecture à action=query et action=parse
  • les images téléversées sous <WIKI_URL>/learn-scripts/images/
  • des liens d’articles de la forme /learn/<Page>, que le module réécrit en /learn/latex/<Page> sur votre instance
Ces chemins sont fixés dans le module et suivent la structure du wiki par défaut. Une installation MediaWiki neuve utilise des chemins différents ; définissez donc ce qui suit dans son LocalSettings.php (ou faites correspondre les chemins dans votre reverse proxy) :
Les pages sont mises en correspondance comme suit :

Cache

Les pages récupérées sont mises en cache dans /var/lib/overleaf/data/learnPages à l’intérieur du conteneur sharelatex. Une page en cache est actualisée lorsqu’elle est plus ancienne que WIKI_MAX_CACHE_AGE millisecondes (par défaut 300000, soit 5 minutes). Si le wiki est injoignable, la copie en cache continue d’être servie.

Crédits

L’implémentation du module s’inspire du proxy learn de overleaf-go par Jakob Ackermann, un portage en Golang d’Overleaf sous licence AGPL-3.0, notamment pour sa correspondance des pages et son utilisation de l’API MediaWiki.
Dernière modification le 2 novembre 2026