> 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/hajimeni/what-is-the-overleaf-toolkit.md).

# Ayakaleaf Toolkit とは何ですか？

Ayakaleaf Toolkit は、Community Edition および Ayakaleaf Pro のオンプレミスインストールに推奨される導入方法です。これは、最も一般的な環境、つまり 1 台の物理サーバーまたは仮想マシンで動作するよう設計されています。Toolkit は `docker compose` を使用してサーバーの Docker コンテナを管理し、 `docker` コマンドをラップした一連のスクリプトを提供して、オンプレミス版 Overleaf の管理のうち、より技術的な側面を支援します。

#### この `bin/docker-compose` ラッパー

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

〜を `bin/docker-compose` 透過的なラッパーとして `docker compose` お使いのマシンにインストールされているプログラム

例:

{% code title="実行中のコンテナを確認" %}

```bash
$ bin/docker-compose ps
```

{% endcode %}

#### 便利なヘルパー

それに加えて `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 コンテナ内でシェルを起動します **sharelatex** コンテナ
* `bin/doctor`：インストールとデプロイに関する情報を収集するためのスクリプトです。以下の「サーバーの確認」セクションを参照してください
* `bin/mongo`：sharelatex コンテナ内でシェルを起動します **mongo** コンテナに入り、正しいデータベース（**sharelatex**)
* `bin/backup-config`：現在の設定のコピー（zip または tar）を作成し、任意の保存先ディレクトリに保存します
* `bin/logs`：サービスのログを表示/追跡します
* `bin/error-logs`：サービスのエラーログを表示/追跡します
* `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 サービスの停止/開始を処理します。詳細は「デプロイのアップグレード」を参照してください: <https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment>

{% hint style="info" %}
Docker のログに接続せずにインスタンスを実行したい場合は `bin/up -d` を使ってデタッチドモードで実行できます。
{% endhint %}

#### サーバーの確認

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

先に `bin/doctor` スクリプトを実行し、すべてが正しく動作していることを確認してください:

{% code title="Overleaf Doctor を実行する" %}

```bash
bin/doctor
```

{% endcode %}

出力例（省略/説明用）:

<details>

<summary>bin/doctor のサンプル出力</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 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 2022年3月15日 (Library: OpenSSL 3.0.2 2022年3月15日)
    - 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
====== 警告 ======
- なし、すべて良好
====== 終了 ======
```

</details>

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

{% hint style="info" %}

* Ayakaleaf Pro Edition のユーザーは GitHub で issue を開くことができます: <https://github.com/ayaka-notes/toolkit/issues>

の場合も、 `bin/doctor` の出力をメッセージに含めてください。
{% endhint %}


---

# 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/hajimeni/what-is-the-overleaf-toolkit.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.