概要

Overleaf は、Docker ネットワーク内で HTTP を使って互いを呼び出す複数のサービスとして動作します。このセクションのページでは、これらの内部 API を説明します。内容は、各サービスのコードから作成された develop/hoppscotch/openapi/ の OpenAPI ファイルに基づいています。

これらの API はいずれも公開されていません。Docker ネットワーク内からのみアクセスでき、ほとんどは認証がありません。

​

サービス

サービス	アドレス	役割
web	http://web:3000	メインアプリ。そのプライベート API は他のサービスとイメージの cron スクリプトから呼び出されます
document-updater	http://document-updater:3003	エディターで開かれている文書を Redis に保持し、編集を適用して Mongo に書き戻します
docstore	http://docstore:3016	すべてのプロジェクトのすべての文書を Mongo の docs コレクションに保存します
real-time	http://real-time:3026	エディターの socket.io 接続を保持し、ブラウザーとサービスの間で編集を中継します
chat	http://chat:3010	プロジェクトのチャットとコメントスレッドを保存します
project-history	http://project-history:3054	キューの編集を履歴の変更に変換して history-v1 に送り、ラベルを保持します
history-v1	http://history-v1:3100	すべてのプロジェクトの完全な履歴とファイルの内容を blob として保存します
filestore	http://filestore:3009	テンプレートファイルと、読み取り専用で history-v1 が書き込む blob を配信します
clsi	http://clsi:3013	プロジェクトをコンパイルし、SyncTeX と単語数カウントを実行し、文書を変換します
notifications	http://notifications:3042	プロジェクト一覧に表示される通知を保存します
linked-url-proxy	http://linked-url-proxy:3066	web のために外部 URL を取得し、内部アドレスを拒否します
third-party-datastore	http://third-party-datastore:3002	ユーザーごとに 1 つのジョブキューでプロジェクトを Dropbox と同期します

​

認証

• web: WEB_API_USER と WEB_API_PASSWORD による HTTP Basic 認証。git-bridge のルートでは代わりに個人用アクセストークンを使います。
• history-v1: STAGING_PASSWORD を使った staging としての HTTP Basic 認証、または JWT。
• その他すべてのサービス: なし。

​

試してみる

開発環境では Hoppscotch が http://localhost:9170 で動作し、Docker のアドレスでサービスに到達するプロキシが付いています。プロキシの設定と OpenAPI ファイルのインポート方法は README を参照してください。