> For the complete documentation index, see [llms.txt](https://overleaf-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://overleaf-pro.ayaka.space/on-premises/on-premises-cs/zaciname/what-is-the-overleaf-toolkit.md). # Co je Overleaf Toolkit? Overleaf Toolkit je doporučený způsob nasazení pro lokální instalace Community Edition, Server Pro nebo Overleaf Pro; byl navržen tak, aby fungoval v nejběžnějším prostředí: na jediném fyzickém serveru nebo virtuálním počítači. Toolkit používá `docker compose` ke správě Docker kontejnerů vašeho serveru a poskytuje sadu skriptů, které obalují `docker` příkazy a pomáhají s techničtější stránkou správy lokální verze Overleafu. #### Ten `bin/docker-compose` obal Ten `bin/docker-compose` skript je obalem pro `docker compose`. Načítá konfiguraci z `adresáře config/` před spuštěním `docker compose` s libovolnými argumenty, které byly skriptu předány. Můžete považovat `bin/docker-compose` za průhledný obal pro `docker compose` program nainstalovaný ve vašem počítači. Příklad: {% code title="Zkontrolujte běžící kontejnery" %} ```bash $ bin/docker-compose ps ``` {% endcode %} #### Praktické pomocné skripty Kromě `bin/docker-compose`Toolkit poskytuje 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ř **sharelatex** kontejneru * `bin/doctor`: skript používaný ke shromažďování informací o instalaci a nasazení. Viz níže sekci „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 (zip nebo tar) vaší aktuální konfigurace a uloží ji do cílového adresáře podle vašeho výběru * `bin/logs`: zobrazit/načítat logy služby * `bin/error-logs`: zobrazit/načítat chybové logy služby * `bin/rename-env-vars-5-0`: migrační skript pro aktualizaci proměnných prostředí v **config/variables.env** (přeznačení ze ShareLaTeX na Overleaf) * `bin/rename-rc-vars`: migrační skript pro aktualizaci proměnných prostředí v **config/overleaf.rc** (přeznačení ze ShareLaTeX na Overleaf) * `bin/run-script`: pomocník, který usnadňuje spouštění skriptů uložených v **sharelatex** kontejneru * `bin/upgrade`: pomáhá s aktualizacemi instance. Skript zkontroluje aktualizace Toolkitu (přes git) a nabídne stažení změn, zkontroluje nejnovější verzi Docker obrazu a nabídne jeho aktualizaci. Poskytuje potvrzení po jednotlivých krocích, možnost zálohovat aktuální konfiguraci a zajišťuje zastavení/spuštění služeb Dockeru. Další informace viz Aktualizace vašeho nasazení: {% hint style="info" %} Pokud preferujete provozovat instanci bez připojení k Docker logům, můžete spustit `bin/up -d` pro spuštění na pozadí. {% endhint %} #### Kontrola vašeho serveru Overleaf Toolkit obsahuje šikovný skript s názvem `bin/doctor` který vygeneruje zprávu ukazují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': Nejsou k dispozici žádné moduly LSB. ID distribuce: Ubuntu Popis: Ubuntu 22.04.5 LTS Verze: 22.04 Kódové označení: jammy - Závislosti - bash - stav: přítomen - informace o verzi: 5.1.16(1)-release - docker - stav: přítomen - informace o verzi: Docker verze 27.3.1, build ce12230 - realpath - stav: přítomen - informace o verzi: realpath (GNU coreutils) 8.32 - perl - stav: přítomen - informace o verzi: 5.034000 - awk - stav: přítomen - informace o verzi: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1) - openssl - stav: přítomen - informace o verzi: OpenSSL 3.0.2 15 Mar 2022 (Knihovna: OpenSSL 3.0.2 15 Mar 2022) - docker compose - stav: přítomen - informace o verzi: Docker Compose verze v2.29.7 - Docker Daemon - stav: běží ====== Konfigurace ====== - config/version - stav: přítomen - verze: 5.1.1 - config/overleaf.rc - stav: přítomen - 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řítomen - hodnoty - OVERLEAF_FILESTORE_BACKEND: fs - OVERLEAF_HISTORY_BACKEND: fs ====== Varování ====== - Žádné, vše je 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é bezplatné Community Edition by měli nahlásit problém na GitHubu: * Uživatelé Server Pro by měli kontaktovat podporu: mailto: V obou případech přiložte výstup z `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://overleaf-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.