> 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/on-premises-cs/zaciname/what-is-the-overleaf-toolkit.md). # Co je Ayakaleaf Toolkit? Nástrojová sada ayakaleaf je doporučený způsob nasazení pro instalace Community Edition a Ayakaleaf Pro v místním prostředí; byla navržena pro práci s nejběžnějším prostředím: jedním fyzickým serverem nebo virtuálním strojem. Toolkit používá `docker compose` ke správě Docker kontejnerů vašeho serveru a poskytuje sadu skriptů, které obalují `docker` příkazy, které pomáhají s techničtější částí správy místní verze Overleaf. #### Skript `bin/docker-compose` obal Skript `bin/docker-compose` skript je obalem kolem `docker compose`. Načítá konfiguraci z `adresáře config/` před spuštěním `docker compose` s libovolnými argumenty předanými skriptu. Můžete považovat `bin/docker-compose` za transparentní obal pro `docker compose` program nainstalovaný ve vašem počítači. Příklad: {% code title="Zkontrolujte spuštěné kontejnery" %} ```bash $ bin/docker-compose ps ``` {% endcode %} #### Užiteční pomocníci Kromě `bin/docker-compose`poskytuje Toolkit pohodlné skripty pro běžné úlohy: * `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ř **sharelatex** kontejneru * `bin/doctor`: skript používaný ke shromažďování informací o instalaci a nasazení. Viz níže část „Kontrola vašeho serveru“ * `bin/mongo`: spustí shell uvnitř **mongo** kontejneru a přepne na správnou databázi (**sharelatex**) * `bin/backup-config`: vytvoří kopii vaší aktuální konfigurace (zip nebo tar) a uloží ji do cílového adresáře dle vašeho výběru * `bin/logs`: zobrazit/sledovat logy služeb * `bin/error-logs`: zobrazit/sledovat chybové logy 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 pro zjednodušení spouštění skriptů uložených v **sharelatex** kontejneru * `bin/upgrade`: pomáhá s upgrady instance. Skript zkontroluje aktualizace Toolkit (přes git) a nabídne stažení změn, zkontroluje nejnovější verzi Docker image a nabídne její aktualizaci. Zajišťuje potvrzení krok za krokem, možnost zálohovat aktuální konfiguraci a řeší zastavení/spuštění služeb Dockeru. Další informace viz Upgrady vašeho nasazení: {% hint style="info" %} Pokud raději spouštíte svou instanci bez připojování k Docker logům, můžete spustit `bin/up -d` pro spuštění v odděleném režimu. {% endhint %} #### Kontrola vašeho serveru Toolkit Overleaf obsahuje užitečný skript nazvaný `bin/doctor` který vytvoří report upozorňující na jakoukoli nesplněnou závislost. Než budete pokračovat, spusťte `bin/doctor` skript a zkontrolujte, že vše funguje správně: {% code title="Spusťte Overleaf Doctor" %} ```bash bin/doctor ``` {% endcode %} Ukázkový výstup (zkrácený/ilustrativní):
Ukázkový výstup z bin/doctor ``` ====== Overleaf Doctor ====== - Informace o hostiteli - Linux - Výstup příkazu 'lsb_release -a': Nebyly k dispozici žádné moduly LSB. ID distributora: Ubuntu Popis: Ubuntu 22.04.5 LTS Vydání: 22.04 Kódové jméno: jammy - Závislosti - bash - stav: přítomno - informace o verzi: 5.1.16(1)-release - docker - stav: přítomno - informace o verzi: Docker version 27.3.1, build ce12230 - realpath - stav: přítomno - informace o verzi: realpath (GNU coreutils) 8.32 - perl - stav: přítomno - informace o verzi: 5.034000 - awk - stav: přítomno - informace o verzi: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1) - openssl - stav: přítomno - informace o verzi: OpenSSL 3.0.2 15 Mar 2022 (Knihovna: OpenSSL 3.0.2 15 Mar 2022) - docker compose - stav: přítomno - informace o verzi: Docker Compose verze v2.29.7 - Docker Daemon - stav: spuštěn ====== Konfigurace ====== - config/version - stav: přítomno - verze: 5.1.1 - config/overleaf.rc - stav: přítomno - hodnoty - OVERLEAF_DATA_PATH: data/overleaf - OVERLEAF_LOG_PATH: data/overleaf/logs - SERVER_PRO: true - přihlášení do 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 - stav: přítomno - hodnoty - OVERLEAF_FILESTORE_BACKEND: fs - OVERLEAF_HISTORY_BACKEND: fs ====== Varování ====== - Žádná, vše v pořádku ====== Konec ====== ```
Pokud některé závislosti chybí, doctor vypíše varování. Pokud narazíte na problémy, nejprve spusťte `bin/doctor` a zkontrolujte jeho výstup kvůli varováním. {% hint style="info" %} * Uživatelé edice Ayakaleaf Pro mohou otevřít issue na GitHubu: V obou případech přiložte výstup `bin/doctor` ve své zprávě. {% 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/on-premises-cs/zaciname/what-is-the-overleaf-toolkit.md?ask=&goal= ``` `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.