Co je Ayakaleaf Toolkit?

Ayakaleaf toolkit je doporučený způsob nasazení pro on-premises instalace Community Edition a Ayakaleaf Pro. Byl navržen pro nejběžnější prostředí: jeden fyzický server nebo virtuální stroj. Toolkit používá docker compose ke správě Docker kontejnerů vašeho serveru a poskytuje sadu skriptů, které obalují příkazy docker a pomáhají s technickou stránkou správy on-premises verze Overleafu.

Obal bin/docker-compose

Skript bin/docker-compose je obalem kolem docker compose. Načte konfiguraci z adresáře config/ a poté spustí docker compose se všemi argumenty, které byly skriptu předány.

S bin/docker-compose můžete zacházet jako s transparentním obalem programu docker compose nainstalovaného na vašem stroji.

Příklad:

Check running containers

$ bin/docker-compose ps

Pomocné skripty

Kromě bin/docker-compose poskytuje Toolkit praktické skripty, které pomáhají s běžnými úkoly:

• bin/up: zkratka pro bin/docker-compose up
• bin/start: zkratka pro bin/docker-compose start
• bin/stop: zkratka pro bin/docker-compose stop
• bin/shell: spustí shell uvnitř kontejneru sharelatex
• bin/doctor: skript pro shromáždění informací o instalaci a nasazení. Viz část „Kontrola serveru“ níže
• bin/mongo: spustí shell uvnitř kontejneru mongo a přepne se do správné databáze (sharelatex)
• bin/backup-config: vytvoří kopii (zip nebo tar) vaší aktuální konfigurace a uloží ji do zvoleného cílového adresáře
• bin/logs: zobrazení/sledování logů služeb
• bin/error-logs: zobrazení/sledování chybových logů služeb
• bin/rename-env-vars-5-0: migrační skript pro aktualizaci proměnných prostředí v config/variables.env (přejmenování ze ShareLaTeX na Overleaf)
• bin/rename-rc-vars: migrační skript pro aktualizaci proměnných prostředí v config/overleaf.rc (přejmenování ze ShareLaTeX na Overleaf)
• bin/run-script: pomocník, který zjednodušuje spouštění skriptů uložených v kontejneru sharelatex
• bin/upgrade: pomáhá s upgradem instance. Skript zkontroluje aktualizace Toolkitu (přes git) a nabídne stažení změn, zkontroluje nejnovější verzi Docker image a nabídne její aktualizaci. Poskytuje potvrzování krok za krokem, možnost zálohovat aktuální konfiguraci a zajišťuje zastavení/spuštění služeb Dockeru. Více informací najdete v části Upgrade nasazení: https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment

Pokud chcete instanci provozovat bez připojení k logům Dockeru, můžete ji spustit v odpojeném režimu pomocí bin/up -d.

Kontrola serveru

Overleaf Toolkit obsahuje užitečný skript bin/doctor, který vytvoří zprávu upozorňující na jakékoli nesplněné závislosti.

Než budete pokračovat, spusťte skript bin/doctor a zkontrolujte, že vše funguje správně:

Run Overleaf Doctor

bin/doctor

Ukázkový výstup (zkrácený/ilustrativní):

Ukázkový výstup z bin/doctor

====== 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 ======

Pokud nějaké závislosti chybí, doctor vypíše varování. Pokud narazíte na problémy, nejprve spusťte bin/doctor a zkontrolujte, zda jeho výstup neobsahuje varování.

• Uživatelé edice Ayakaleaf Pro mohou založit issue na GitHubu: https://github.com/ayaka-notes/toolkit/issues

V obou případech přiložte ke zprávě výstup bin/doctor.