> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# ヘルプを得る

### Doctor

Overleaf Toolkit には、デバッグに役立つ便利な `doctor` スクリプトが付属しています。`bin/doctor` を実行すると、ホスト環境、設定、Toolkit が必要とする依存関係に関する情報が出力されます。この出力は、Ayakaleaf Pro のインストールに関する問題を私たちが診断する際にも役立ちます。

<Info>
  Overleaf Pro のユーザーは [GitHub で issue を作成](https://github.com/ayaka-notes/overleaf/issues)できます。

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

### Doctor に相談する

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

```bash title="Run doctor" theme={null}
bin/doctor
```

以下の例のような出力が表示されます。

<Accordion title="完全な出力の例">
  ```text theme={null}
  ====== Overleaf Doctor ======
  - Host Information
      - Linux
      - Output of 'lsb_release -a':
              No LSB modules are available.
              Distributor ID:	Ubuntu
              Description:	Ubuntu 22.04.5 LTS
              Release:	22.04
              Codename:	jammy
  - Dependencies
      - bash
          - status: present
          - version info: 5.1.16(1)-release
      - docker
          - status: present
          - version info: Docker version 28.0.4, build b8034c0
      - docker compose
          - status: present
          - version info: Docker Compose version v2.34.0
      - realpath
          - status: present
          - version info: realpath (GNU coreutils) 8.32
      - perl
          - status: present
          - version info: 5.034000
      - awk
          - status: present
          - version info: mawk 1.3.4 20200120
  - Docker Daemon
      - status: up
  ====== Configuration ======
  - config/version
      - status: present
      - version: 5.4.0
  - config/overleaf.rc
      - status: present
      - values
          - OVERLEAF_DATA_PATH: data/overleaf
          - OVERLEAF_LOG_PATH: data/overleaf/logs
          - SERVER_PRO: true
          - SIBLING_CONTAINERS_ENABLED: true
              - logged in to quay.io: true
          - MONGO_ENABLED: true
          - REDIS_ENABLED: true
  - config/variables.env
      - status: present
      - values
          - OVERLEAF_FILESTORE_BACKEND: fs
          - OVERLEAF_HISTORY_BACKEND: fs

  ====== Warnings ======
  - None, all good
  ====== End ======
  ```
</Accordion>

### ホスト情報

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

<Accordion title="Host Information の出力例">
  ```text theme={null}
  - Host Information
      - Linux
      - Output of 'lsb_release -a':
              No LSB modules are available.
              Distributor ID:	Ubuntu
              Description:	Ubuntu 22.04.5 LTS
              Release:	22.04
              Codename:	jammy
  ```
</Accordion>

### 依存関係

`Dependencies` セクションには、Toolkit の動作に必要なツールが一覧表示されます。ツールが存在する場合は、バージョン情報とともに `status: present` と表示されます。存在しない場合は `status: MISSING!` と表示され、`doctor` の出力の末尾に警告が追加されます。

<Accordion title="Dependency の出力例（存在する場合）">
  ```text theme={null}
  - docker
      - status: present
      - version info: Docker version 28.0.4, build b8034c0
  ```
</Accordion>

<Accordion title="Dependency の出力例（存在しない場合）">
  ```text theme={null}
  - docker
      - status: MISSING!
  ```
</Accordion>

依存関係が 1 つでも欠けていると、Toolkit はほぼ確実に動作しません。

### 設定

`Configuration` セクションには、`config/` ディレクトリ内のファイルに関する情報が含まれます。`config/overleaf.rc` については、doctor がいくつかの重要な値を出力します。存在しないファイルは `status: MISSING!` と表示され、`doctor` の出力の末尾に警告が追加されます。

<Accordion title="Configuration の出力例">
  ```text theme={null}
  ====== Configuration ======
  - config/version
      - status: present
      - version: 5.4.0
  - config/overleaf.rc
      - status: present
      - values
          - OVERLEAF_DATA_PATH: /tmp/overleaf
          - SERVER_PRO: false
          - MONGO_ENABLED: false
          - REDIS_ENABLED: true
  - config/variables.env
      - status: MISSING!
  ```
</Accordion>

上の例に関する注意点：

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

### 警告

`Warnings` セクションには、doctor スクリプトが検出した問題がまとめられます。問題がない場合は、このセクションにその旨が表示されます。

<Accordion title="Warnings の出力例">
  ```text theme={null}
  ====== Warnings ======
  - configuration file variables.env not found
  - rc file, OVERLEAF_DATA_PATH not set
  ====== End =======
  ```
</Accordion>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.