/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_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 にアクセスできない場合は、キャッシュされたコピーが引き続き配信されます。

