Saltar para o conteúdo principal
O Ayakaleaf Pro inclui um módulo que baixa páginas de um site MediaWiki em uma URL configurada por você e as disponibiliza em /learn na sua instância. O Ayakaleaf Pro não inclui, hospeda nem distribui nenhum conteúdo de wiki por conta própria. Para habilitar o módulo, adicione OVERLEAF_PROXY_LEARN=true ao arquivo config/variables.env do Toolkit e execute o comando bin/up. Os usuários poderão então abrir as páginas da wiki clicando no botão Documentation do menu de navegação, sem sair da sua instância.
Por padrão, apenas usuários conectados podem abrir /learn. Para disponibilizá-lo a visitantes não conectados, defina também OVERLEAF_ALLOW_PUBLIC_ACCESS=true; consulte Page Access.
Em implantações com Docker Compose, você precisará adicionar a variável de ambiente OVERLEAF_PROXY_LEARN: true à seção environment do serviço sharelatex no seu arquivo docker-compose.yml.
Quando você habilitar essa opção pela primeira vez e reiniciar o Docker do Overleaf, o sistema precisará baixar a Wiki correspondente, o que pode levar 5 minutos ou mais. Somente após a conclusão do download você conseguirá ver a página de login do Overleaf.

Escolher a origem da wiki

A wiki a ser usada pelo proxy é definida com WIKI_URL. Se você não a definir, será usado o padrão herdado da configuração upstream do Overleaf (services/web/config/settings.defaults.js):
Essa é a wiki por trás das páginas do Overleaf Learn. Sua instância precisa de acesso à internet para alcançá-la.
Atenção aos direitos autorais. O módulo apenas busca conteúdo da URL em WIKI_URL; o conteúdo pertence a quem mantém essa wiki. Quando ele está habilitado, sua instância baixa todas as páginas dessa wiki e mantém uma cópia no seu servidor. A wiki padrão é mantida pelo Overleaf, e seu conteúdo pertence ao Overleaf, não ao Ayakaleaf Pro. Antes de habilitar o módulo, verifique se baixar, armazenar e disponibilizar essas páginas está de acordo com os termos do Overleaf, especialmente se sua instância estiver aberta a visitantes não conectados. Em caso de dúvida, aponte WIKI_URL para uma wiki cujo conteúdo seja seu ou que você tenha licença para usar.
Em vez disso, você pode apontar WIKI_URL para a sua própria wiki, por exemplo uma base de conhecimento interna:
A wiki precisa ser um site MediaWiki que disponibilize:
  • sua API em <WIKI_URL>/learn-scripts/api.php, com acesso de leitura anônimo a action=query e action=parse
  • imagens enviadas em <WIKI_URL>/learn-scripts/images/
  • links de artigos no formato /learn/<Page>, que o módulo reescreve para /learn/latex/<Page> na sua instância
Esses caminhos são fixos no módulo e seguem a estrutura da wiki padrão. Uma instalação nova do MediaWiki usa caminhos diferentes, então defina o seguinte no LocalSettings.php dela (ou mapeie os caminhos no seu proxy reverso):
As páginas são mapeadas da seguinte forma:

Cache

As páginas buscadas são armazenadas em cache em /var/lib/overleaf/data/learnPages dentro do contêiner sharelatex. Uma página em cache é atualizada quando tem mais de WIKI_MAX_CACHE_AGE milissegundos (padrão 300000, 5 minutos). Se a wiki estiver inacessível, a cópia em cache continua sendo disponibilizada.

Créditos

A implementação do módulo usa como referência o proxy de learn do overleaf-go, de Jakob Ackermann, um port do Overleaf em Golang licenciado sob AGPL-3.0, incluindo seu mapeamento de páginas e seu uso da API do MediaWiki.
Última modificação em 2 de novembro de 2026