Overleaf Toolkit とは何ですか？

Overleaf Toolkit は、Community Edition、Server Pro、または Overleaf Pro のオンプレミス導入に推奨される展開方法であり、単一の物理サーバーまたは仮想マシンといった最も一般的な環境で動作するように設計されています。Toolkit は docker compose を使用してサーバーの Docker コンテナを管理し、オンプレミス版 Overleaf の運用で技術的な側面を支援するための docker コマンドをラップするスクリプト群を提供します。

この bin/docker-compose ラッパー

この bin/docker-compose スクリプトは docker composeのラッパーです。スクリプトは config/ ディレクトリから構成を読み込み、渡された引数を使って docker compose を呼び出します。

あなたは bin/docker-compose をマシンにインストールされている docker compose プログラムの透過的なラッパーとして扱うことができます。

例：

実行中のコンテナを確認する

$ bin/docker-compose ps

便利なヘルパー

に加えて bin/docker-compose、Toolkit は一般的な作業を支援する便利なスクリプトを提供します：

• bin/up：のショートカット bin/docker-compose up

• bin/start：のショートカット bin/docker-compose start

• bin/stop：のショートカット bin/docker-compose stop

• bin/shell：は sharelatex コンテナ内でシェルを起動します

• bin/doctor：インストールと展開情報を収集するためのスクリプト。以下の「サーバーのチェック」セクションを参照してください

• bin/mongo：は mongo コンテナに入り、正しいデータベースに切り替えます（sharelatex)

• bin/backup-config：現在の構成のコピー（zip または tar）を作成し、任意の宛先ディレクトリに保存します

• bin/logs：サービスログの表示／追跡（tail）

• bin/error-logs：サービスのエラーログの表示／追跡（tail）

• bin/rename-env-vars-5-0：config/variables.env 内の環境変数を更新するための移行スクリプト（ config/variables.env ）（ShareLaTeX から Overleaf へのリブランディング）

• bin/rename-rc-vars：config/variables.env 内の環境変数を更新するための移行スクリプト（ config/overleaf.rc ）（ShareLaTeX から Overleaf へのリブランディング）

• bin/run-script：に保存されたスクリプトの実行を簡素化するためのヘルパー sharelatex コンテナ内でシェルを起動します

• bin/upgrade：インスタンスのアップグレードを支援します。スクリプトは Toolkit の更新（git 経由）を確認して変更を取得するかを提案し、最新の Docker イメージのバージョンを確認して更新を提案します。ステップごとの確認、現在の構成のバックアップオプション、Docker サービスの停止／起動の処理を提供します。詳細は「Upgrading your deployment」を参照してください： https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment

Docker のログにアタッチせずにインスタンスを実行したい場合は、 bin/up -d でデタッチドモードで実行できます。

サーバーのチェック

Overleaf Toolkit には便利なスクリプト bin/doctor が含まれており、満たされていない依存関係を指摘するレポートを生成します。

先に進む前に、 bin/doctor スクリプトを実行して、すべてが正しく動作しているか確認してください：

Overleaf Doctor を実行する

bin/doctor

出力例（省略／説明用）：

bin/doctor の出力サンプル

====== Overleaf Doctor ======
- ホスト情報
    - Linux
    - 'lsb_release -a' の出力：
            利用可能な LSB モジュールはありません。
            Distributor ID:     Ubuntu
            Description:        Ubuntu 22.04.5 LTS
            Release:    22.04
            Codename:   jammy
- 依存関係
    - bash
        - ステータス：存在
        - バージョン情報：5.1.16(1)-release
    - docker
        - ステータス：存在
        - バージョン情報：Docker version 27.3.1, build ce12230
    - realpath
        - ステータス：存在
        - バージョン情報：realpath (GNU coreutils) 8.32
    - perl
        - ステータス：存在
        - バージョン情報：5.034000
    - awk
        - ステータス：存在
        - バージョン情報：GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1)
    - openssl
        - ステータス：存在
        - バージョン情報：OpenSSL 3.0.2 15 Mar 2022 (Library: OpenSSL 3.0.2 15 Mar 2022)
    - docker compose
        - ステータス：存在
        - バージョン情報：Docker Compose version v2.29.7
- Docker デーモン
    - ステータス：稼働中
====== 設定 ======
- config/version
    - ステータス：存在
    - バージョン：5.1.1
- config/overleaf.rc
    - ステータス：存在
    - 値
        - OVERLEAF_DATA_PATH: data/overleaf
        - OVERLEAF_LOG_PATH: data/overleaf/logs
        - SERVER_PRO: true
            - quay.io へのログイン：true
        - SIBLING_CONTAINERS_ENABLED: true
        - OVERLEAF_LISTEN_IP: 0.0.0.0
        - OVERLEAF_PORT: 80
        - MONGO_ENABLED: true
        - MONGO_IMAGE: mongo
        - MONGO_VERSION: 6.0
        - MONGO_DATA_PATH: data/mongo
        - REDIS_ENABLED: true
        - REDIS_IMAGE: redis:6.2
        - REDIS_DATA_PATH: data/redis
- config/variables.env
    - ステータス：存在
    - 値
        - OVERLEAF_FILESTORE_BACKEND: fs
        - OVERLEAF_HISTORY_BACKEND: fs
====== 警告 ======
- なし、すべて良好
====== 終了 ======

依存関係が不足している場合、doctor は警告を表示します。問題が発生した場合は、まず bin/doctor を実行してその出力に警告がないか確認してください。

• 無料の Community Edition のユーザーは GitHub で issue を開いてください： https://github.com/overleaf/toolkit/issues

• Server Pro のユーザーはサポートに連絡してください： mailto:[email protected]

どちらの場合も、メッセージに bin/doctor の出力を含めてください。