> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 2. Seznamte se s Toolkitem

### Rozhlédněte se

Nyní, když máte místní kopii Toolkitu, se podívejme na strukturu repozitáře pomocí příkazu `ls`.

```bash title="Run this" theme={null}
ls -l
```

> [!NOTE]
>
> Příkaz `ls -l` zobrazí podrobný dlouhý výpis obsahu adresáře s dalšími informacemi o souborech, jako jsou oprávnění, vlastnictví a velikost.

Pokud se vše úspěšně naklonovalo, měli byste vidět něco takového:

```text theme={null}
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 bin
-rw-r--r-- 1 fry fry  6465 Aug 30 14:16 CHANGELOG.md
drwxr-xr-x 2 fry fry  4096 Sep  6 12:43 config
drwxr-xr-x 5 fry fry  4096 Aug 30 14:22 data
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 doc
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 lib
-rw-r--r-- 1 fry fry 34520 Aug 30 14:16 LICENSE
-rw-r--r-- 1 fry fry  1178 Aug 30 14:16 README.md
```

> [!NOTE]
>
> Všechny konfigurační soubory vlastněné uživatelem se nacházejí v adresáři `config/`. Tento adresář je **vyloučen** ze systému správy revizí git, takže se při aktualizaci Toolkitu nezmění.

## Struktura repozitáře

| Název | Popis |
| - | - |
| `bin` | Tato složka obsahuje sadu skriptů, které vám pomáhají spravovat vaši instanci serveru Overleaf. Více o těchto skriptech si můžete přečíst v části Příkazy níže. |
| `config` | Tato složka obsahuje vaše vlastní místní konfigurační soubory. |
| `lib` | Tato složka obsahuje základní konfigurační soubory používané Toolkitem. |
| `data` | Ve výchozím nastavení tato složka obsahuje úložiště pro MongoDb, Redis a Overleaf. Více informací najdete v části [Trvalá data](https://ayakaleaf-pro.mintlify.site/cs/on-premises/configuration/overleaf-toolkit/files-and-locations.md#persistent-data) níže. |

> [!WARNING]
>
> Doporučujeme **neměnit** soubory mimo složku `/config` přímo. Pokud potřebujete provést změny, můžete je místo toho provést pomocí proměnných prostředí nastavených buď v **config/variables.env**, nebo v **config/overleaf.rc**.\
> Chcete-li například nastavit obraz služby `mongo`, neupravujte přímo `lib/docker-compose.mongo.yml`, ale nastavte obraz pomocí proměnné prostředí `MONGO_IMAGE` v `config/overleaf.rc`. Více informací najdete na stránce [Nastavení Toolkitu](https://ayakaleaf-pro.mintlify.site/cs/on-premises/configuration/overleaf-toolkit/toolkit-settings.md).

> [!NOTE]
>
> Toolkit **nezmění** žádná data v adresáři `config/` bez vašeho svolení.

## Příkazy

Tyto skripty spouštějte z adresáře Toolkitu. Každý z nich vypíše své volby pomocí `--help`.

| Příkaz | Co dělá |
| - | - |
| `bin/init` | Při prvním spuštění vytvoří konfigurační soubory v `config/`. `bin/init --tls` přidá konfiguraci TLS proxy NGINX. |
| `bin/up` | Vytvoří a spustí kontejnery (`bin/docker-compose up`). Přidáním `-d` je spustíte na pozadí místo sledování logů. Spusťte jej po každé změně v `config/`: znovu vytvoří kontejnery, jejichž konfigurace se změnila. |
| `bin/start` | Znovu spustí existující kontejnery (`bin/docker-compose start`). Změny konfigurace nepoužije. |
| `bin/stop` | Zastaví kontejnery a ponechá je (`bin/docker-compose stop`). |
| `bin/docker-compose` | Spustí `docker compose` se soubory Toolkitu, například `bin/docker-compose ps` nebo `bin/docker-compose restart sharelatex`. |
| `bin/logs` | Zobrazí nebo sleduje logy jedné či více služeb, například `bin/logs -f web`. |
| `bin/error-logs` | Jako `bin/logs`, ale zobrazí pouze chyby. |
| `bin/shell` | Otevře shell uvnitř kontejneru `sharelatex`. |
| `bin/mongo` | Otevře shell MongoDB nad databází `sharelatex`. |
| `bin/run-script` | Spustí skript dodávaný uvnitř kontejneru `sharelatex`. |
| `bin/doctor` | Zkontroluje hostitele a konfiguraci a vypíše zprávu, kterou můžete sdílet, když žádáte o pomoc. |
| `bin/images` | Vypíše Docker image Overleafu na hostiteli. |
| `bin/backup-config` | Zkopíruje adresář `config/` do umístění zálohy (kopie, zip nebo tar). |
| `bin/upgrade` | Krok za krokem aktualizuje Toolkit a image Overleafu, viz [Upgrade nasazení](https://ayakaleaf-pro.mintlify.site/cs/on-premises/maintenance/upgrading-your-deployment.md). |
| `bin/rename-env-vars-5-0`, `bin/rename-rc-vars` | Jednorázové migrace starých názvů proměnných `SHARELATEX_*` na `OVERLEAF_*`. |

> [!WARNING]
>
> Když `bin/up` kontejner znovu vytvoří, ztratí se vše, co se v něm změnilo, například balíčky nainstalované nebo soubory upravené přes `bin/shell`. Zachovají se pouze datové adresáře (ve výchozím nastavení `data/`) a `config/`. Trvalé změny proto provádějte přes `config/variables.env`, `config/overleaf.rc` nebo `config/docker-compose.override.yml`.

> [!NOTE]
>
> Pokud každé `bin/up` odhlásí všechny uživatele, nastavte `OVERLEAF_SESSION_SECRET`. Bez něj se session cookies podepisují tajemstvím, které se vygeneruje znovu při každém novém vytvoření kontejneru, viz otázky a odpovědi v části [Proměnné prostředí](https://ayakaleaf-pro.mintlify.site/cs/on-premises/configuration/overleaf-toolkit/environment-variables.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.