Ayakaleaf Toolkit nedir?

Ayakaleaf toolkit, Community Edition ve Ayakaleaf Pro’nun şirket içi (on-premises) kurulumları için önerilen dağıtım yöntemidir ve en yaygın ortamla çalışacak şekilde tasarlanmıştır: tek bir fiziksel sunucu veya sanal makine. Toolkit, sunucunuzun Docker konteynerlerini yönetmek için docker compose kullanır ve Overleaf’in şirket içi bir sürümünü yönetmenin daha teknik yönlerinde yardımcı olmak için docker komutlarını saran bir dizi betik sağlar.

bin/docker-compose sarmalayıcısı

bin/docker-compose betiği, docker compose etrafında bir sarmalayıcıdır. Betiğe iletilen argümanlarla docker compose komutunu çağırmadan önce yapılandırmayı config/ dizininden yükler.

bin/docker-compose betiğini, makinenizde kurulu docker compose programı için şeffaf bir sarmalayıcı olarak düşünebilirsiniz.

Örnek:

Check running containers

$ bin/docker-compose ps

Kolaylık sağlayan yardımcılar

bin/docker-compose betiğine ek olarak Toolkit, yaygın görevlere yardımcı olan kullanışlı betikler sağlar:

• bin/up: bin/docker-compose up için kısayol
• bin/start: bin/docker-compose start için kısayol
• bin/stop: bin/docker-compose stop için kısayol
• bin/shell: sharelatex konteyneri içinde bir kabuk başlatır
• 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: mongo konteyneri içinde bir kabuk başlatır ve doğru veritabanına (sharelatex) geçer
• bin/backup-config: mevcut yapılandırmanızın bir kopyasını (zip veya tar) oluşturur ve seçtiğiniz bir hedef dizinde saklar
• bin/logs: servis günlüklerini görüntüler/takip eder
• bin/error-logs: servis hata günlüklerini görüntüler/takip eder
• bin/rename-env-vars-5-0: config/variables.env içindeki ortam değişkenlerini güncellemek için geçiş betiği (ShareLaTeX’ten Overleaf’e yeniden markalama)
• bin/rename-rc-vars: config/overleaf.rc içindeki ortam değişkenlerini güncellemek için geçiş betiği (ShareLaTeX’ten Overleaf’e yeniden markalama)
• bin/run-script: sharelatex konteyneri içinde saklanan betiklerin çalıştırılmasını kolaylaştıran yardımcı
• bin/upgrade: örnek yükseltmelerine yardımcı olur. Betik, Toolkit güncellemelerini (git aracılığıyla) kontrol eder ve değişiklikleri çekmeyi önerir, en son Docker imajı sürümünü kontrol eder ve güncellemeyi önerir. Adım adım onay, mevcut yapılandırmayı yedekleme seçeneği sunar ve Docker servislerinin durdurulup başlatılmasını yönetir. Daha fazla bilgi için Dağıtımınızı yükseltme sayfasına bakın: https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment

Örneğinizi Docker günlüklerine bağlanmadan çalıştırmayı tercih ederseniz, ayrık (detached) modda çalıştırmak için bin/up -d komutunu kullanabilirsiniz.

Sunucunuzu kontrol etme

Overleaf Toolkit, karşılanmamış bağımlılıkları gösteren bir rapor üreten 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:

Run Overleaf Doctor

bin/doctor

Örnek çıktı (kısaltılmış/açıklayıcı):

bin/doctor örnek çıktısı

====== 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 27.3.1, build ce12230
    - realpath
        - status: present
        - version info: realpath (GNU coreutils) 8.32
    - perl
        - status: present
        - version info: 5.034000
    - awk
        - status: present
        - version info: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1)
    - openssl
        - status: present
        - version info: OpenSSL 3.0.2 15 Mar 2022 (Library: OpenSSL 3.0.2 15 Mar 2022)
    - docker compose
        - status: present
        - version info: Docker Compose version v2.29.7
- Docker Daemon
    - status: up
====== Configuration ======
- config/version
    - status: present
    - version: 5.1.1
- config/overleaf.rc
    - status: present
    - values
        - OVERLEAF_DATA_PATH: data/overleaf
        - OVERLEAF_LOG_PATH: data/overleaf/logs
        - SERVER_PRO: true
            - logged in to 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
    - status: present
    - values
        - OVERLEAF_FILESTORE_BACKEND: fs
        - OVERLEAF_HISTORY_BACKEND: fs
====== Warnings ======
- None, all good
====== End ======

Herhangi bir bağımlılık eksikse doctor uyarılar yazdırır. Sorunla karşılaşırsanız önce bin/doctor komutunu çalıştırın ve çıktısında uyarı olup olmadığını kontrol edin.

• Ayakaleaf Pro Edition kullanıcıları GitHub’da bir issue açabilir: https://github.com/ayaka-notes/toolkit/issues

Her iki durumda da mesajınıza bin/doctor çıktısını ekleyin.