/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)的默认值:
WIKI_URL 指向你自己的 Wiki,例如内部知识库:
-
位于
<WIKI_URL>/learn-scripts/api.php的 API,且允许匿名读取action=query和action=parse -
位于
<WIKI_URL>/learn-scripts/images/下的已上传图片 -
/learn/<Page>形式的文章链接,模块会将其重写为你实例上的/learn/latex/<Page>
LocalSettings.php 中进行如下设置(或在反向代理中映射这些路径):
缓存
获取的页面缓存在sharelatex 容器内的 /var/lib/overleaf/data/learnPages 中。当缓存页面的存在时间超过 WIKI_MAX_CACHE_AGE 毫秒(默认 300000,即 5 分钟)时会被刷新。如果 Wiki 无法访问,将继续提供缓存的副本。

