5. インスタンスのカスタマイズ

​

インスタンスのカスタマイズ

Overleaf インスタンスを初めて起動する前に、2 つの設定ファイルを独自の情報で更新します。

ファイル	読み込み元	ここで設定する内容
config/overleaf.rc	bin/up などの Toolkit スクリプト	コンテナの実行方法: OVERLEAF_LISTEN_IP、OVERLEAF_PORT、SERVER_PRO、データパス
config/variables.env	コンテナ内のアプリケーション	Overleaf の動作: OVERLEAF_SITE_URL、メール、TeX Live イメージ

1. 変数ファイルを編集する

   お好みのテキストエディターで config/variables.env を開き、以下の環境変数を必要な値に更新します。

2. リッスンアドレスとポート

   デフォルトでは、Toolkit は Web インターフェースを 127.0.0.1:80 で公開するため、サーバー自体のブラウザからしか開けません。他のコンピューターからは「connection refused」や「server not found」エラーになります。これを変更するには、config/overleaf.rc を編集します。

   config/overleaf.rc

   OVERLEAF_LISTEN_IP=0.0.0.0
   OVERLEAF_PORT=8080
   

   OVERLEAF_LISTEN_IP はコンテナがバインドするホストの IP アドレス、OVERLEAF_PORT はホストのポートです。これらを組み合わせて Docker のポートマッピング OVERLEAF_LISTEN_IP:OVERLEAF_PORT:80 が構成されます。環境に合った値を選択してください。

   構成	OVERLEAF_LISTEN_IP	OVERLEAF_PORT	ブラウザで開くアドレス
   このマシンからのみ(デフォルト)	127.0.0.1	80	http://localhost
   LAN またはインターネット上の他のコンピューターから直接接続する	0.0.0.0、またはサーバーの IP のいずれか	80、または任意の空きポート	http://<server-ip>:<port>
   同じホスト上の独自のリバースプロキシ(NGINX、Caddy、Cloudflare Tunnel)の背後	127.0.0.1	任意の空きポート	プロキシの URL
   Toolkit の TLS プロキシの背後	127.0.0.1	80	https://<your-domain>

   ホスト上でポート 80 がすでに他の Web サーバーなどによって使用されている場合は、OVERLEAF_PORT を 8080 などの空きポートに設定してください。そうしないと、bin/up が bind: address already in use で失敗します。

   Docker で公開されたポートは、ufw や firewalld などのホストのファイアウォールをバイパスします。0.0.0.0 を指定すると、サーバーが接続しているすべてのネットワークからインスタンスにアクセスできるようになります。クラウドサーバーでは、プロバイダーのセキュリティグループでもポートを許可する必要があります。インスタンスをインターネットに公開する前に HTTPS を使用してください。TLS プロキシを参照してください。

   まずはデフォルトのまま、localhost でインスタンスを開いてもかまいません。後で他のコンピューターからのアクセスを許可するには、config/overleaf.rc のこれら 2 つの変数と config/variables.env の OVERLEAF_SITE_URL を変更し、bin/up を再度実行してコンテナを再作成します。

3. 必須の環境変数

   config/variables.env の次の変数を更新します。

   名前	説明	例
   OVERLEAF_SITE_URL	Overleaf インスタンスが公開されている場所。公開リンクや WebSocket 接続で使用されるため、正しく設定する必要があります！	https://overleaf.lilliput.com
   OVERLEAF_EMAIL_FROM_ADDRESS	このメールアドレスは、すべての送信メールの from アドレスとして使用されます。	[e-mail]
   OVERLEAF_ADMIN_EMAIL	ユーザーがサイトの運営者に連絡するためのメールアドレス。	[e-mail]

   OVERLEAF_SITE_URL は、リッスンアドレスではなく、ユーザーがブラウザに入力するアドレスです。ポートが 80(HTTP)または 443(HTTPS)でない場合は、http://192.168.1.20:8080 のようにポートを含めてください。http://0.0.0.0 は使用しないでください。OVERLEAF_SITE_URL がブラウザのアドレスと一致しない場合、エディターは接続に失敗し、メール内のリンクや OAuth コールバックが誤った場所を指します。

   メールサーバーがない場合は、OVERLEAF_EMAIL_FROM_ADDRESS を未設定のままにしてください。その場合、Overleaf はメールを送信しないため、新しいユーザーにはアクティベーションリンクを自分で渡すことができます。パブリックアクセスの Q&A を参照してください。

   また、OVERLEAF_SESSION_SECRET に openssl rand -hex 32 で生成した値を設定してください。これがない場合、コンテナを再作成する bin/up やアップグレードのたびに、すべてのユーザーがログアウトされます。環境変数の Q&A を参照してください。

   これらの環境変数を更新したら、保存して終了します。

4. Sandbox Compile をセットアップする

   次に、sandboxed-compiles.md 用に TeX Live Full を設定します。config/variables.env を開き、次の環境変数を更新します。

   config/variables.env

   ALL_TEX_LIVE_DOCKER_IMAGES=ghcr.io/ayaka-notes/texlive-full:2026.1, ghcr.io/ayaka-notes/texlive-full:2025.1
   ALL_TEX_LIVE_DOCKER_IMAGE_NAMES=Texlive 2026, Texlive 2025
   TEX_LIVE_DOCKER_IMAGE=ghcr.io/ayaka-notes/texlive-full:2026.1
   
5. インスタンスを起動する

   インスタンスを起動するには、次を実行します。

   Start the instance

   bin/up
   

   このコマンドは、texlive を含む必要なイメージをダウンロードし、（カスタマイズした設定で）コンテナを作成して、インスタンスを起動します。各 Docker コンテナのログ出力が表示されるはずです。

   後で（ログ出力にアタッチせずに）再度起動するには、次を実行します。

   Start without attaching to logs

   bin/start
   

Toolkit は docker compose を使用して Overleaf の Docker コンテナを管理します。Toolkit には docker compose をラップする一連のスクリプトが用意されており、細かい作業のほとんどを代わりに処理してくれます。

すべて順調であれば、ブラウザで http://127.0.0.1/ または http://localhost/ にアクセスすると、新しい Overleaf インスタンスのログインページが表示されるはずです。OVERLEAF_LISTEN_IP または OVERLEAF_PORT を変更した場合は、代わりに リッスンアドレスとポート のステップにある表のアドレス(例: http://<server-ip>:8080)を開いてください。

Web インターフェースが公開されているアドレスとポートを確認するには、次を実行します。

Show the published port

bin/docker-compose port sharelatex 80

出力(例: 0.0.0.0:8080)には、使用中のホストの IP アドレスとポートが表示されます。127.0.0.1 と表示される場合、インスタンスにはサーバー自体からしかアクセスできません。

ネットワーク構成や Overleaf インスタンスのホスト場所によっては、追加の設定変更が必要になる場合があります。詳しくは Toolkit の設定を参照してください：toolkit-settings.md