ヘルプを得る方法

ドクター

Overleaf ツールキットには便利な ドクター デバッグに役立つスクリプトが付属しています。実行するには bin/doctor とすると、スクリプトはホスト環境、設定、およびツールキットが必要とする依存関係に関する情報を出力します。この出力は、Server Pro インストールの問題を診断するために Overleaf サポートチームが利用する際にも役立ちます。

Overleaf Pro のユーザーは GitHub に issue を開く.

メッセージに bin/doctor スクリプトの出力を含めることをおすすめします。

ドクターに相談する

doctor スクリプトを実行してください：

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 28.0.4, build b8034c0
    - docker compose
        - 状態: 存在
        - バージョン情報: Docker Compose version v2.34.0
    - realpath
        - 状態: 存在
        - バージョン情報: realpath (GNU coreutils) 8.32
    - perl
        - 状態: 存在
        - バージョン情報: 5.034000
    - awk
        - 状態: 存在
        - バージョン情報: mawk 1.3.4 20200120
- Docker デーモン
    - 状態: 起動中
====== 設定 ======
- config/version
    - 状態: 存在
    - バージョン: 5.4.0
- config/overleaf.rc
    - 状態: 存在
    - 値
        - OVERLEAF_DATA_PATH: data/overleaf
        - OVERLEAF_LOG_PATH: data/overleaf/logs
        - SERVER_PRO: true
        - SIBLING_CONTAINERS_ENABLED: true
            - quay.io にログイン済み: true
        - MONGO_ENABLED: true
        - REDIS_ENABLED: true
- config/variables.env
    - 状態: 存在
    - 値
        - OVERLEAF_FILESTORE_BACKEND: fs
        - OVERLEAF_HISTORY_BACKEND: fs

====== 警告 ======
- なし、すべて正常です
====== 終了 ======

ホスト情報

この ホスト情報 セクションにはツールキットを実行しているマシンに関する情報（例: Linux の配布/リリース）が含まれます。

ホスト情報の出力例

- ホスト情報
    - Linux
    - 'lsb_release -a' の出力：
            利用可能な LSB モジュールはありません。
            Distributor ID:	Ubuntu
            Description:	Ubuntu 22.04.5 LTS
            Release:	22.04
            Codename:	jammy

依存関係

この 依存関係 セクションはツールキットが動作するために必要なツールを一覧表示します。ツールが存在する場合は次のように表示されます 状態: 存在 とともにバージョン情報が表示されます。欠如している場合は次のように表示されます 状態: 欠如! そして警告が出力の下部に追加されます。 ドクター 出力。

依存関係出力の例（存在する場合）

- docker
    - 状態: 存在
    - バージョン情報: Docker version 28.0.4, build b8034c0

依存関係出力の例（欠如している場合）

- docker
    - 状態: 欠如!

依存関係が欠けている場合、ツールキットはほぼ確実に動作しません。

設定

この 設定 セクションには config/ ディレクトリ内のファイルに関する情報が含まれます。例えば config/overleaf.rcについて、doctor はいくつかの主要な値を出力します。欠落しているファイルは次のように表示されます 状態: 欠如! そして警告が出力の下部に追加されます。 ドクター 出力。

設定出力の例

====== 設定 ======
- config/version
    - 状態: 存在
    - バージョン: 5.4.0
- config/overleaf.rc
    - 状態: 存在
    - 値
        - OVERLEAF_DATA_PATH: /tmp/overleaf
        - SERVER_PRO: false
        - MONGO_ENABLED: false
        - REDIS_ENABLED: true
- config/variables.env
    - 状態: 欠如!

上の例からの注意点：

• OVERLEAF_DATA_PATH に設定されている /tmp/overleaf は重要なデータの保存場所として安全ではない可能性があります。

• MONGO_ENABLED: false はツールキットが自前の MongoDB をプロビジョニングしないことを意味します。必要な場合は MONGO_URL が外部管理の MongoDB を指すようにしてください。

• config/variables.env は上の例では欠落しています。

警告

この 警告 セクションは doctor スクリプトによって検出された問題を要約します。問題がなければこのセクションはその旨を示します。

警告の出力例

====== 警告 ======
- 設定ファイル variables.env が見つかりません
- rc ファイル、OVERLEAF_DATA_PATH が設定されていません
====== 終了 =======