> 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/de/erste-schritte/what-is-the-overleaf-toolkit.md). # Was ist das Ayakaleaf Toolkit? Das ayakaleaf-Toolkit ist die empfohlene Bereitstellungsmethode für On-Premises-Installationen der Community Edition, Ayakaleaf Pro; es wurde für die gängigste Umgebung entwickelt: einen einzelnen physischen Server oder eine virtuelle Maschine. Das Toolkit verwendet `docker compose` zur Verwaltung der Docker-Container Ihres Servers und stellt eine Reihe von Skripten bereit, die `docker` -Befehle umhüllen, um bei den technischeren Aspekten der Verwaltung einer On-Premises-Version von Overleaf zu helfen. #### Das `bin/docker-compose` Wrapper Das `bin/docker-compose` -Skript ist ein Wrapper um `docker compose`. Es lädt die Konfiguration aus dem `config/` Verzeichnis, bevor es `docker compose` mit allen Argumenten aufruft, die an das Skript übergeben wurden. Sie können `bin/docker-compose` als transparenten Wrapper für das `docker compose` auf Ihrem Rechner installierte Programm behandeln. Beispiel: {% code title="Laufende Container prüfen" %} ```bash $ bin/docker-compose ps ``` {% endcode %} #### Praktische Hilfsprogramme Zusätzlich zu `bin/docker-compose`stellt das Toolkit praktische Skripte zur Unterstützung häufiger Aufgaben bereit: * `bin/up`: Abkürzung für `bin/docker-compose up` * `bin/start`: Abkürzung für `bin/docker-compose start` * `bin/stop`: Abkürzung für `bin/docker-compose stop` * `bin/shell`: startet eine Shell innerhalb des **sharelatex** Containers * `bin/doctor`: Skript zum Sammeln von Installations- und Bereitstellungsinformationen. Siehe den Abschnitt „Überprüfen Ihres Servers“ unten * `bin/mongo`: startet eine Shell innerhalb des **mongo** Container und wechselt zur richtigen Datenbank (**sharelatex**) * `bin/backup-config`: erstellt eine Kopie (zip oder tar) Ihrer aktuellen Konfiguration und speichert sie in einem Zielverzeichnis Ihrer Wahl * `bin/logs`: Dienstprotokolle anzeigen/anhängen * `bin/error-logs`: Dienst-Fehlerprotokolle anzeigen/anhängen * `bin/rename-env-vars-5-0`: Migrationsskript zum Aktualisieren der Umgebungsvariablen in **config/variables.env** (Umbenennung von ShareLaTeX zu Overleaf) * `bin/rename-rc-vars`: Migrationsskript zum Aktualisieren der Umgebungsvariablen in **config/overleaf.rc** (Umbenennung von ShareLaTeX zu Overleaf) * `bin/run-script`: Hilfsprogramm zum Vereinfachen des Ausführens von Skripten, die im **sharelatex** Containers * `bin/upgrade`: hilft bei Upgrades der Instanz. Das Skript prüft auf Toolkit-Updates (via git) und bietet an, Änderungen zu ziehen, prüft die neueste Docker-Image-Version und bietet an, sie zu aktualisieren. Es bietet schrittweise Bestätigung, die Option, die aktuelle Konfiguration zu sichern, und übernimmt das Stoppen/Starten der Docker-Dienste. Weitere Informationen finden Sie unter Upgrading your deployment: {% hint style="info" %} Wenn Sie Ihre Instanz lieber ohne Anbindung an die Docker-Protokolle ausführen möchten, können Sie `bin/up -d` um im Detached-Modus zu laufen. {% endhint %} #### Überprüfen Ihres Servers Das Overleaf Toolkit enthält ein praktisches Skript namens `bin/doctor` das einen Bericht erstellt, der auf jede nicht erfüllte Abhängigkeit hinweist. Führen Sie vor dem Fortfahren das `bin/doctor` Skript aus und überprüfen Sie, ob alles korrekt funktioniert: {% code title="Overleaf Doctor ausführen" %} ```bash bin/doctor ``` {% endcode %} Beispielausgabe (gekürzt/illustrierend):
Beispielausgabe von bin/doctor ``` ====== Overleaf Doctor ====== - Host-Informationen - Linux - Ausgabe von 'lsb_release -a': Keine LSB-Module verfügbar. - Distributor-ID: Ubuntu - Beschreibung: Ubuntu 22.04.5 LTS - Version: 22.04 - Codename: jammy - Abhängigkeiten - bash - Status: vorhanden - Versionsinfo: 5.1.16(1)-release - docker - Status: vorhanden - Versionsinfo: Docker-Version 27.3.1, Build ce12230 - realpath - Status: vorhanden - Versionsinfo: realpath (GNU coreutils) 8.32 - perl - Status: vorhanden - Versionsinfo: 5.034000 - awk - Status: vorhanden - Versionsinfo: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1) - openssl - Status: vorhanden - Versionsinfo: OpenSSL 3.0.2 15. März 2022 (Bibliothek: OpenSSL 3.0.2 15. März 2022) - docker compose - Status: vorhanden - Versionsinfo: Docker-Compose-Version v2.29.7 - Docker-Daemon - Status: läuft ====== Konfiguration ====== - config/version - Status: vorhanden - Version: 5.1.1 - config/overleaf.rc - Status: vorhanden - Werte - OVERLEAF_DATA_PATH: data/overleaf - OVERLEAF_LOG_PATH: data/overleaf/logs - SERVER_PRO: true - bei quay.io angemeldet: 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: vorhanden - Werte - OVERLEAF_FILESTORE_BACKEND: fs - OVERLEAF_HISTORY_BACKEND: fs ====== Warnungen ====== - Keine, alles in Ordnung ====== Ende ====== ```
Wenn Abhängigkeiten fehlen, gibt der Doctor Warnungen aus. Wenn Sie auf Probleme stoßen, führen Sie zunächst `bin/doctor` aus und prüfen Sie die Ausgabe auf Warnungen. {% hint style="info" %} * Nutzer der Ayakaleaf Pro Edition können ein Issue auf GitHub eröffnen: Fügen Sie in beiden Fällen die Ausgabe von `bin/doctor` in Ihrer Nachricht ein. {% 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/de/erste-schritte/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.