跳转到主要内容
Ayakaleaf Pro 包含一个模块,可从你配置的 URL 处的 MediaWiki 站点下载页面,并在你的实例的 /learn 路径下提供这些页面。Ayakaleaf Pro 本身不附带、托管或分发任何 Wiki 内容。要启用该模块,请在 Toolkit 的 config/variables.env 文件中添加 OVERLEAF_PROXY_LEARN=true,然后运行 bin/up 命令。 之后,用户点击导航菜单中的 Documentation 按钮即可打开 Wiki 页面,而无需离开你的实例。
默认情况下,只有已登录用户可以打开 /learn。若要让未登录的访客也能访问,还需设置 OVERLEAF_ALLOW_PUBLIC_ACCESS=true,参见页面访问。
对于 Docker Compose 部署,你需要将环境变量 OVERLEAF_PROXY_LEARN: true 添加到 docker-compose.yml 文件中 sharelatex 服务的 environment 部分。
首次启用此选项并重启 Overleaf Docker 时,系统需要下载相关的 Wiki,这可能需要 5 分钟甚至更长时间。只有在下载完成后,你才能正常看到 Overleaf 登录页面。

选择 Wiki 来源

要代理的 Wiki 通过 WIKI_URL 设置。如果不设置,将使用继承自上游 Overleaf 配置(services/web/config/settings.defaults.js)的默认值:
这是 Overleaf Learn 页面背后的 Wiki。你的实例需要能够访问互联网才能访问它。
注意版权。该模块只从 WIKI_URL 中的 URL 获取内容;内容归运营该 Wiki 的一方所有。启用后,你的实例会下载该 Wiki 的所有页面,并在你的服务器上保留一份副本。默认 Wiki 由 Overleaf 运营,其内容归 Overleaf 所有,而非 Ayakaleaf Pro。在启用该模块之前,请确认下载、存储和提供这些页面符合 Overleaf 的条款,尤其是当你的实例对未登录访客开放时。如有疑问,请将 WIKI_URL 指向你拥有内容或已获授权使用的 Wiki。
你也可以将 WIKI_URL 指向你自己的 Wiki,例如内部知识库:
该 Wiki 必须是一个 MediaWiki 站点,并提供:
  • 位于 <WIKI_URL>/learn-scripts/api.php 的 API,且允许匿名读取 action=query 和 action=parse
  • 位于 <WIKI_URL>/learn-scripts/images/ 下的已上传图片
  • /learn/<Page> 形式的文章链接,模块会将其重写为你实例上的 /learn/latex/<Page>
这些路径在模块中是固定的,遵循默认 Wiki 的布局。全新安装的 MediaWiki 使用不同的路径,因此请在其 LocalSettings.php 中进行如下设置(或在反向代理中映射这些路径):
页面映射关系如下:

缓存

获取的页面缓存在 sharelatex 容器内的 /var/lib/overleaf/data/learnPages 中。当缓存页面的存在时间超过 WIKI_MAX_CACHE_AGE 毫秒(默认 300000,即 5 分钟)时会被刷新。如果 Wiki 无法访问,将继续提供缓存的副本。

致谢

该模块的实现参考了 Jakob Ackermann 的 overleaf-go 中的 learn 代理(一个采用 AGPL-3.0 许可的 Overleaf Golang 移植版),包括其页面映射方式以及对 MediaWiki API 的使用。
最后修改于 2026年11月2日