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

# Ayakaleaf Toolkit nedir?

Ayakaleaf toolkit, Community Edition ve Ayakaleaf Pro'nun şirket içi kurulumları için önerilen dağıtım yöntemidir; en yaygın ortam olan tek bir fiziksel sunucu veya sanal makineyle çalışacak şekilde tasarlanmıştır. Toolkit şunu kullanır `docker compose` sunucunuzun Docker kapsayıcılarını yönetmek için kullanır ve `docker` komutlarını sarmalayarak, şirket içi bir Overleaf sürümünü yönetmenin daha teknik tarafında yardımcı olan bir dizi betik sağlar.

#### Bu `bin/docker-compose` sarmalayıcı

Bu `bin/docker-compose` betiği, `docker compose`. Yapılandırmayı `config/` dizininden yükler, `docker compose` betiğe iletilen tüm argümanlarla birlikte çağırmadan önce.

Şunu `bin/docker-compose` için şeffaf bir sarmalayıcı olarak değerlendirebilirsiniz `docker compose` makinenize kurulmuş program.

Örnek:

{% code title="Çalışan kapsayıcıları kontrol edin" %}

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

{% endcode %}

#### Kullanışlı yardımcılar

Buna ek olarak `bin/docker-compose`, Toolkit yaygın görevlerde yardımcı olmak için kullanışlı betikler sağlar:

* `bin/up`: için kısayol `bin/docker-compose up`
* `bin/start`: için kısayol `bin/docker-compose start`
* `bin/stop`: için kısayol `bin/docker-compose stop`
* `bin/shell`: içinde bir kabuk başlatır **sharelatex** kapsayıcısı
* `bin/doctor`: kurulum ve dağıtım bilgilerini toplamak için kullanılan betik. Aşağıdaki "Sunucunuzu kontrol etme" bölümüne bakın
* `bin/mongo`: içinde bir kabuk başlatır **mongo** kapsayıcısı ve doğru veritabanına geçer (**sharelatex**)
* `bin/backup-config`: geçerli yapılandırmanızın bir kopyasını (zip veya tar) oluşturur ve bunu seçtiğiniz bir hedef dizinde saklar
* `bin/logs`: hizmet günlüklerini görüntüle/sonunu izle
* `bin/error-logs`: hizmet hata günlüklerini görüntüle/sonunu izle
* `bin/rename-env-vars-5-0`: içindeki ortam değişkenlerini güncellemek için geçiş betiği **config/variables.env** (ShareLaTeX'ten Overleaf'e yeniden markalama)
* `bin/rename-rc-vars`: içindeki ortam değişkenlerini güncellemek için geçiş betiği **config/overleaf.rc** (ShareLaTeX'ten Overleaf'e yeniden markalama)
* `bin/run-script`: içinde depolanan betiklerin çalıştırılmasını kolaylaştıran yardımcı **sharelatex** kapsayıcısı
* `bin/upgrade`: örnek kurulum yükseltmelerinde yardımcı olur. Betik, Toolkit güncellemelerini (git aracılığıyla) kontrol eder ve değişiklikleri çekmeyi teklif eder, en son Docker imaj sürümünü kontrol eder ve onu güncellemeyi teklif eder. Adım adım onay, mevcut yapılandırmayı yedekleme seçeneği sunar ve Docker hizmetlerini durdurma/başlatma işlemlerini yönetir. Daha fazla bilgi için Dağıtımınızı yükseltme bölümüne bakın: <https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment>

{% hint style="info" %}
Örneğinizi Docker günlüklerine bağlanmadan çalıştırmayı tercih ediyorsanız şunu çalıştırabilirsiniz `bin/up -d` ayrık modda çalıştırmak için.
{% endhint %}

#### Sunucunuzu kontrol etme

Overleaf Toolkit, `bin/doctor` adlı kullanışlı bir betik içerir

Devam etmeden önce, `bin/doctor` betiğini çalıştırın ve her şeyin doğru çalıştığını kontrol edin:

{% code title="Overleaf Doctor'ı çalıştırın" %}

```bash
bin/doctor
```

{% endcode %}

Örnek çıktı (kırpılmış/temsili):

<details>

<summary>bin/doctor'dan örnek çıktı</summary>

```
====== Overleaf Doctor ======
- Ana Bilgi
    - Linux
    - 'lsb_release -a' çıktısı:
            Kullanılabilir LSB modülü yok.
            Distributor ID:     Ubuntu
            Description:        Ubuntu 22.04.5 LTS
            Release:    22.04
            Codename:   jammy
- Bağımlılıklar
    - bash
        - durum: mevcut
        - sürüm bilgisi: 5.1.16(1)-release
    - docker
        - durum: mevcut
        - sürüm bilgisi: Docker sürümü 27.3.1, build ce12230
    - realpath
        - durum: mevcut
        - sürüm bilgisi: realpath (GNU coreutils) 8.32
    - perl
        - durum: mevcut
        - sürüm bilgisi: 5.034000
    - awk
        - durum: mevcut
        - sürüm bilgisi: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1)
    - openssl
        - durum: mevcut
        - sürüm bilgisi: OpenSSL 3.0.2 15 Mar 2022 (Kütüphane: OpenSSL 3.0.2 15 Mar 2022)
    - docker compose
        - durum: mevcut
        - sürüm bilgisi: Docker Compose sürümü v2.29.7
- Docker Daemonu
    - durum: çalışıyor
====== Yapılandırma ======
- config/version
    - durum: mevcut
    - sürüm: 5.1.1
- config/overleaf.rc
    - durum: mevcut
    - değerler
        - OVERLEAF_DATA_PATH: data/overleaf
        - OVERLEAF_LOG_PATH: data/overleaf/logs
        - SERVER_PRO: true
            - quay.io'ya giriş yapılmış: 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
    - durum: mevcut
    - değerler
        - OVERLEAF_FILESTORE_BACKEND: fs
        - OVERLEAF_HISTORY_BACKEND: fs
====== Uyarılar ======
- Yok, her şey yolunda
====== Son ======
```

</details>

Herhangi bir bağımlılık eksikse, doctor uyarılar yazdırır. Sorunlarla karşılaşırsanız, önce `bin/doctor` ve çıktısını uyarılar açısından kontrol edin.

{% hint style="info" %}

* Ayakaleaf Pro Sürümü kullanıcıları GitHub'da bir sorun açabilir: <https://github.com/ayaka-notes/toolkit/issues>

Her iki durumda da, `bin/doctor` mesajınızda çıktısını ekleyin.
{% 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/tr/baslarken/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.
