> For the complete documentation index, see [llms.txt](https://ayakaleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ayakaleaf-pro.ayaka.space/on-premises/ja/sapto/getting-help.md).

# ヘルプを得る

### 医師

Overleaf Toolkit には便利な `doctor` デバッグを支援するスクリプトがあります。実行してください `bin/doctor` すると、このスクリプトはホスト環境、設定、および Toolkit に必要な依存関係に関する情報を出力します。この出力は、Server Pro インストールに関する問題の診断にも Overleaf サポートチームの助けになります。

{% hint style="info" %}
Overleaf Pro のユーザーは [GitHub で issue を開くことができます](https://github.com/ayaka-notes/overleaf/issues).

の出力を含めるとよいでしょう `bin/doctor` スクリプトの出力をメッセージに含めてください。
{% endhint %}

### Doctor への相談 <a href="#consulting-with-the-doctor" id="consulting-with-the-doctor"></a>

doctor スクリプトを実行します:

{% code title="doctor を実行" %}

```bash
bin/doctor
```

{% endcode %}

以下の例に似た出力が表示されます。

<details>

<summary>出力例（完全版）</summary>

```
====== Overleaf Doctor ======
- ホスト情報
    - Linux
    - 'lsb_release -a' の出力:
            利用可能な LSB モジュールはありません。
            配布元 ID:	Ubuntu
            説明:	Ubuntu 22.04.5 LTS
            リリース:	22.04
            コードネーム:	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

====== 警告 ======
- なし、問題ありません
====== 終了 ======
```

</details>

### ホスト情報

次の `ホスト情報` このセクションには、Toolkit を実行しているマシンに関する情報（たとえば Linux ディストリビューションとリリース）が含まれます。

<details>

<summary>ホスト情報の出力例</summary>

```
- ホスト情報
    - Linux
    - 'lsb_release -a' の出力:
            利用可能な LSB モジュールはありません。
            配布元 ID:	Ubuntu
            説明:	Ubuntu 22.04.5 LTS
            リリース:	22.04
            コードネーム:	jammy
```

</details>

### 依存関係

次の `依存関係` このセクションには、Toolkit を動作させるために必要なツールが一覧表示されます。ツールが存在する場合は、次のように表示されます。 `状態: 存在` バージョン情報付きで。存在しない場合は次のように表示されます。 `状態: 不足!` そして警告がの下部に追加されます `doctor` 出力。

<details>

<summary>依存関係の出力例（存在）</summary>

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

</details>

<details>

<summary>依存関係の出力例（不足）</summary>

```
- docker
    - 状態: 不足!
```

</details>

依存関係が1つでも不足している場合、Toolkit はほぼ確実に動作しません。

### 設定

次の `設定` このセクションには、次の `config/` ディレクトリ。 `config/overleaf.rc`については、doctor はいくつかの重要な値を出力します。見つからないファイルは次のように表示されます `状態: 不足!` そして警告がの下部に追加されます `doctor` 出力。

<details>

<summary>設定の出力例</summary>

```
====== 設定 ======
- 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
    - 状態: 不足!
```

</details>

上の例からの注意:

* `OVERLEAF_DATA_PATH` を設定することです `/tmp/overleaf` は重要なデータの保存先として安全ではない可能性があります。
* `MONGO_ENABLED: false` は、Toolkit が独自の MongoDB をプロビジョンしないことを意味します。必要であれば `MONGO_URL` が外部管理の MongoDB を指していることを確認してください。
* `config/variables.env` は例では欠落しています。

### 警告

次の `警告` このセクションには、doctor スクリプトによって見つかった問題の要約が表示されます。問題がなければ、このセクションにその旨が示されます。

<details>

<summary>警告の出力例</summary>

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

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ayakaleaf-pro.ayaka.space/on-premises/ja/sapto/getting-help.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
