メインコンテンツへスキップ
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 でデプロイしている場合は、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)から継承されたデフォルト値が使用されます。
これは Overleaf Learn ページの基盤となっている Wiki です。インスタンスがこの Wiki にアクセスするには、インターネット接続が必要です。
著作権に注意してください。このモジュールは WIKI_URL で指定された URL からのみ取得します。コンテンツはその Wiki の運営者に帰属します。有効にすると、インスタンスはその Wiki のすべてのページをダウンロードし、サーバー上にコピーを保持します。デフォルトの Wiki は Overleaf が運営しており、そのコンテンツは Ayakaleaf Pro ではなく Overleaf が所有しています。モジュールを有効にする前に、特にインスタンスをサインインしていない訪問者にも公開している場合は、これらのページのダウンロード、保存、配信が Overleaf の規約に準拠していることを確認してください。判断に迷う場合は、自身がコンテンツを所有している、または使用許諾を得ている Wiki を WIKI_URL に指定してください。
代わりに、社内のナレッジベースなど、独自の Wiki を WIKI_URL に指定することもできます。
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(AGPL-3.0 でライセンスされた Overleaf の Golang 移植版)の learn プロキシを参考にしており、そのページマッピングや MediaWiki API の使用方法も含まれます。
最終更新日 2026年11月2日