前提条件
Overleaf はマイクロサービスアーキテクチャを採用した典型的なオープンソースプロジェクトで、すべてのサービスが Docker 上で動作します。- 公式の Community Edition のソースコードは GitHub Overleaf Official にあります。
- Overleaf-CEP のソースコードは GitHub Yu-i-i/Overleaf で公開されています。
- Ayakaleaf Pro は GitHub ayaka-notes/ayakaleaf-pro で公開されています。
8 コア以上の CPU を備えたサーバーは一般に高価なため、開発にはローカルのコンピューターを使用することを強くおすすめします。
- 開発用の高性能なサーバー/デスクトップ
- 最新かつ安定した Ubuntu LTS(例:Ubuntu 24.04)
- Docker と Git の環境
設定チュートリアル
ここでは Ayakaleaf Pro を例に、Overleaf の開発環境をセットアップする方法を説明します。特に断りがない限り、以下のコマンドはすべてdevelop ディレクトリで実行します。
1
ソースコードを取得する
まず、リポジトリをクローンします。
bash
2
yarn.lock を同期する
このリポジトリは Yarn 4 を使用しており(ルートの
package.json の packageManager)、yarn.lock が package.json ファイルと同期していないことがあります。初回のクローン後と、package.json を変更した後に同期してください。bash
bin/sync は node:24.18.1 コンテナ内で yarn install --mode=update-lockfile を実行するため、ホストに Node.js は不要です。変更された yarn.lock はコミットしないでください。3
開発用イメージをビルドする
サービスをビルドします。
bash
サービスを並列でビルドしている間に Docker のメモリが不足する場合は、このディレクトリに
COMPOSE_PARALLEL_LIMIT=1 を含む .env ファイルを作成してください。4
翻訳を適用する
Ayakaleaf Pro のモジュールは翻訳を ホストに
services/web/locales/locales_patches/ に保持しており、コミット済みのロケールファイルには含まれていません。初回起動前に一度適用してください。適用しないと、これらのモジュールのページにはテキストの代わりに about_to_permanently_delete_accounts のようなキーが表示されます。bash
jq が必要です。翻訳を追加したりブランチを切り替えたりした後は再度実行してください。i18n 翻訳の更新を参照してください。5
すべてのマイクロサービスを起動する
次にサービスを起動します。サービスが起動したら、http://localhost/launchpad を開いて最初の管理者アカウントを作成します。
bash
OVERLEAF_PORT を変更した場合はポートを追加してください(後述)。LDAP はデフォルトで有効です(
dev.rc の LDAP_ENABLED=true)。この場合、Launchpad には LDAP 管理者フォームが表示されます。メールアドレスだけを入力し、その管理者はその後 LDAP でログインします。たとえば professor / professor(professor@planetexpress.com)です。テストユーザーは develop/authentication/README.md に記載されています。代わりにパスワード付きのローカル管理者を作成するには、LDAP_ENABLED=false と SAML_ENABLED=false を設定してください。develop/dev.env ではすでに ADMIN_PRIVILEGE_AVAILABLE=true が設定されているため、管理者は追加の設定なしで管理パネルを開けます。設定(dev.rc)
dev.env の隣にある develop/dev.rc には、Overleaf Toolkit の overleaf.rc のように開発環境のスイッチがまとめられています。値を変更したら bin/dev を再実行して反映してください。オフにした機能はそのコンテナも停止します。
各機能は
docker-compose.yml などのファイルを専用のフォルダーに持っています:authentication/ldap、authentication/saml、mail、s3、hoppscotch、grafana。環境変数のない web の設定が必要な機能は /etc/overleaf/settings.d/ にファイルをマウントし、develop/settings.dev-env.cjs がそれらをすべてマージします。すべての bin/* スクリプトは、有効な機能のファイルを追加する bin/docker-compose を経由します。自分で compose コマンドを実行する場合も、docker compose ではなく bin/docker-compose を使ってください。
ポート
サイト、RustFS コンソール、Hoppscotch はホストの127.0.0.1 で待ち受けます。リモートマシンでは、まずそれらのポートを転送してください(例:ssh -L 9001:localhost:9001 <host>)。サイトは dev.rc の OVERLEAF_PORT を使うため、変更した場合は以下のアドレスにポートを追加してください。
Mailpit、Grafana、Mongo Express、RedisInsight は webpack-dev-server を通じてサイトの専用パスで提供されるため、専用のポートは不要です。ログイン後は、サイトのナビゲーションバーにある Dev tools メニューからリンクされます。
dev.rc で機能がオフになっているページは表示されません。各ツールの役割は開発ツールのセットアップを参照してください。
S3 API(ポート 9000)と SMTP(ポート 1025)には Docker ネットワーク内からしかアクセスできません。Mongo(27017)、Redis(6379)、Mongo Express(8081)、RedisInsight(5540)、git-bridge(8000)はホストの 127.0.0.1 にのみ公開されます。
TeX Live
Sandbox Compiles はデフォルトで有効です。develop/dev.env が SANDBOXED_COMPILES=true と、イメージ ghcr.io/ayaka-notes/texlive-full:2026.1 および ghcr.io/ayaka-notes/texlive-full:2025.1 を設定しています。clsi は自分でイメージを pull しないため、一度 pull してください。
dev.env は PANDOC_IMAGE=overleaf-pandoc:local で Pandoc 変換も有効にします。リポジトリのルートから、そのイメージを一度ビルドしてください。
develop ディレクトリに DOCKER_SOCKET_PATH=/var/run/docker.sock.raw を含む .env ファイルを作成して、Docker ソケットのパスを上書きする必要がある場合があります。
開発
コードを変更するたびにbin/build && bin/up を実行しなくて済むよう、Overleaf Community Edition を 開発モード で実行できます。このモードでは、コードの変更に応じてサービスが自動的に更新されます。
これを行うには、付属の bin/dev スクリプトを使用します。
node --watch で起動され、コードが自動的に監視されて必要に応じてサービスが再起動されます。 dev.rc を変更した後は再度実行してください。
パフォーマンスを向上させるため、bin/dev スクリプトにスペース区切りのリストを渡して、一部のサービスのみを開発モードで起動することもできます。
web サービスを 開発モード で起動した場合、バックエンドのコードが変更されたときにのみ web サービスが更新されます。フロントエンドのコードも自動的に更新されるようにするには、webpack サービスも 開発モード で起動してください。bin/i18n を実行してください。i18n 翻訳の更新を参照してください。
デバッグ
開発モード で実行すると、ほとんどのサービスがデバッグポートを公開します。Chrome の Dev Tools のインスペクターや IDE に統合されたデバッガーをアタッチできます。次の表は、各サービスについてホストマシン の127.0.0.1 で公開されるポートです。
Chrome の リモートデバッグ を使ってサービスにアタッチするには、chrome://inspect/ にアクセスし、Discover network targets にチェックが入っていることを確認します。次に Configure… をクリックし、デバッガーをアタッチしたい各サービスについて
localhost:[service port] のエントリを追加します。
エントリを追加すると、そのサービスが Remote Target として表示され、検査やデバッグができるようになります。
ログ
スクリプトbin/logs はログを追跡し、bunyan で整形します。また ggrep も必要です。これは macOS で Homebrew からインストールした GNU grep の名前で、Ubuntu には ggrep コマンドはありません。
dev.rc の機能のサービス(mailpit、rustfs、ldap、saml、hoppscotch、および Prometheus、Loki、エクスポーター付きの grafana)も見つかるように、docker compose ではなく bin/docker-compose を使ってください。
GRAFANA_ENABLED=true の場合、すべてのコンテナのログは Grafana にもあり、サービス、レベル、テキストで絞り込めます。開発ツールのセットアップを参照してください。

