/learn 路徑下提供這些頁面。Ayakaleaf Pro 本身不附帶、託管或散布任何 wiki 內容。若要啟用此模組,請在 Toolkit 的 config/variables.env 檔案中加入 OVERLEAF_PROXY_LEARN=true,並執行 bin/up 指令。
之後,使用者只要點選導覽選單中的 Documentation 按鈕,就能開啟 wiki 頁面,無需離開您的執行個體。
預設情況下,只有已登入的使用者可以開啟
/learn。若要讓未登入的訪客也能使用,請同時設定 OVERLEAF_ALLOW_PUBLIC_ACCESS=true,請參閱頁面存取。若使用 Docker Compose 部署,您需要在
docker-compose.yml 檔案中 sharelatex 服務的 environment 區段加入環境變數 OVERLEAF_PROXY_LEARN: true。當您第一次啟用此選項並重新啟動 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 無法連線,系統會繼續提供快取的副本。

