> ## 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. Machen Sie sich mit dem Toolkit vertraut

### Ein erster Überblick

Da Sie nun eine lokale Kopie des Toolkits haben, sehen wir uns mit dem Befehl `ls` die Struktur des Repositorys an.

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

> [!NOTE]
>
> Der Befehl `ls -l` zeigt eine ausführliche Langansicht des Verzeichnisinhalts an und liefert zusätzliche Dateiinformationen wie Berechtigungen, Eigentümer und Größe.

Wenn alles erfolgreich geklont wurde, sollten Sie etwa Folgendes sehen:

```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]
>
> Alle benutzereigenen Konfigurationsdateien befinden sich im Verzeichnis `config/`. Dieses Verzeichnis ist von der Git-Versionskontrolle **ausgeschlossen** und wird daher durch ein Update des Toolkits nicht verändert.

## Aufbau des Repositorys

| Name | Beschreibung |
| - | - |
| `bin` | Dieser Ordner enthält eine Sammlung von Skripten, die Ihnen bei der Verwaltung Ihrer Overleaf-Serverinstanz helfen. Mehr über diese Skripte erfahren Sie im Abschnitt „Befehle“ weiter unten. |
| `config` | Dieser Ordner enthält Ihre eigenen lokalen Konfigurationsdateien. |
| `lib` | Dieser Ordner enthält die vom Toolkit verwendeten Basis-Konfigurationsdateien. |
| `data` | Standardmäßig enthält dieser Ordner den Speicherort für MongoDb, Redis und Overleaf. Weitere Informationen finden Sie im Abschnitt [Persistente Daten](https://ayakaleaf-pro.mintlify.site/de/on-premises/configuration/overleaf-toolkit/files-and-locations.md#persistent-data) weiter unten. |

> [!WARNING]
>
> Wir empfehlen, Dateien außerhalb des Ordners `/config` **nicht** direkt zu ändern. Wenn Sie Änderungen vornehmen müssen, können Sie dies stattdessen über Umgebungsvariablen in **config/variables.env** oder **config/overleaf.rc** tun.\
> Um beispielsweise das Image des Dienstes `mongo` festzulegen, bearbeiten Sie nicht direkt `lib/docker-compose.mongo.yml`, sondern setzen Sie das Image über die Umgebungsvariable `MONGO_IMAGE` in `config/overleaf.rc`. Weitere Informationen finden Sie auf der Seite [Toolkit-Einstellungen](https://ayakaleaf-pro.mintlify.site/de/on-premises/configuration/overleaf-toolkit/toolkit-settings.md).

> [!NOTE]
>
> Das Toolkit ändert **keine** Daten im Verzeichnis `config/` ohne Ihre Zustimmung.

## Befehle

Führen Sie diese Skripte aus dem Toolkit-Verzeichnis aus. Jedes Skript gibt mit `--help` seine Optionen aus.

| Befehl | Funktion |
| - | - |
| `bin/init` | Erstellt beim ersten Mal die Konfigurationsdateien in `config/`. `bin/init --tls` fügt die Konfiguration für den NGINX-TLS-Proxy hinzu. |
| `bin/up` | Erstellt und startet die Container (`bin/docker-compose up`). Fügen Sie `-d` hinzu, um sie im Hintergrund auszuführen, statt den Logs zu folgen. Führen Sie den Befehl nach jeder Änderung in `config/` aus: Er erstellt die Container neu, deren Konfiguration sich geändert hat. |
| `bin/start` | Startet die vorhandenen Container erneut (`bin/docker-compose start`). Konfigurationsänderungen werden dabei nicht übernommen. |
| `bin/stop` | Stoppt die Container und behält sie bei (`bin/docker-compose stop`). |
| `bin/docker-compose` | Führt `docker compose` mit den Dateien des Toolkit aus, zum Beispiel `bin/docker-compose ps` oder `bin/docker-compose restart sharelatex`. |
| `bin/logs` | Zeigt die Logs eines oder mehrerer Dienste an oder folgt ihnen, zum Beispiel `bin/logs -f web`. |
| `bin/error-logs` | Wie `bin/logs`, zeigt aber nur die Fehler an. |
| `bin/shell` | Öffnet eine Shell im `sharelatex`-Container. |
| `bin/mongo` | Öffnet eine MongoDB-Shell für die Datenbank `sharelatex`. |
| `bin/run-script` | Führt ein Skript aus, das im `sharelatex`-Container mitgeliefert wird. |
| `bin/doctor` | Prüft den Host und die Konfiguration und gibt einen Bericht aus, den Sie teilen können, wenn Sie um Hilfe bitten. |
| `bin/images` | Listet die Overleaf-Docker-Images auf dem Host auf. |
| `bin/backup-config` | Kopiert das Verzeichnis `config/` an einen Sicherungsort (Kopie, zip oder tar). |
| `bin/upgrade` | Aktualisiert das Toolkit und das Overleaf-Image Schritt für Schritt, siehe [Upgrade Ihrer Bereitstellung](https://ayakaleaf-pro.mintlify.site/de/on-premises/maintenance/upgrading-your-deployment.md). |
| `bin/rename-env-vars-5-0`, `bin/rename-rc-vars` | Einmalige Migrationen alter Variablennamen `SHARELATEX_*` zu `OVERLEAF_*`. |

> [!WARNING]
>
> Wenn `bin/up` einen Container neu erstellt, geht alles verloren, was darin geändert wurde, zum Beispiel über `bin/shell` installierte Pakete oder bearbeitete Dateien. Nur die Datenverzeichnisse (standardmäßig `data/`) und `config/` bleiben erhalten. Nehmen Sie dauerhafte Änderungen stattdessen über `config/variables.env`, `config/overleaf.rc` oder `config/docker-compose.override.yml` vor.

> [!NOTE]
>
> Wenn jedes `bin/up` alle Benutzer abmeldet, setzen Sie `OVERLEAF_SESSION_SECRET`. Ohne diese Variable werden die Sitzungscookies mit einem Secret signiert, das bei jeder Neuerstellung des Containers neu erzeugt wird, siehe die Fragen & Antworten unter [Umgebungsvariablen](https://ayakaleaf-pro.mintlify.site/de/on-premises/configuration/overleaf-toolkit/environment-variables.md).


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