Was ist das Ayakaleaf Toolkit?

Das Ayakaleaf Toolkit ist die empfohlene Bereitstellungsmethode für On-Premises-Installationen der Community Edition und von Ayakaleaf Pro. Es wurde für die gängigste Umgebung konzipiert: einen einzelnen physischen Server oder eine virtuelle Maschine. Das Toolkit verwendet docker compose, um die Docker-Container Ihres Servers zu verwalten, und stellt eine Reihe von Skripten bereit, die docker-Befehle kapseln und Sie bei den eher technischen Aspekten der Verwaltung einer On-Premises-Version von Overleaf unterstützen.

Der Wrapper bin/docker-compose

Das Skript bin/docker-compose ist ein Wrapper um docker compose. Es lädt die Konfiguration aus dem Verzeichnis config/, bevor es docker compose mit den an das Skript übergebenen Argumenten aufruft.

Sie können bin/docker-compose als transparenten Wrapper für das auf Ihrem Rechner installierte Programm docker compose betrachten.

Beispiel:

Check running containers

$ bin/docker-compose ps

Hilfsskripte

Zusätzlich zu bin/docker-compose stellt das Toolkit praktische Skripte für häufige Aufgaben bereit:

• bin/up: Kurzbefehl für bin/docker-compose up
• bin/start: Kurzbefehl für bin/docker-compose start
• bin/stop: Kurzbefehl für bin/docker-compose stop
• bin/shell: startet eine Shell im sharelatex-Container
• bin/doctor: Skript zum Sammeln von Installations- und Bereitstellungsinformationen. Siehe den Abschnitt „Server überprüfen“ weiter unten
• bin/mongo: startet eine Shell im 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: Dienst-Logs anzeigen/verfolgen
• bin/error-logs: Fehler-Logs der Dienste anzeigen/verfolgen
• 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: Hilfsskript, das das Ausführen von Skripten im sharelatex-Container vereinfacht
• bin/upgrade: unterstützt bei Upgrades der Instanz. Das Skript prüft (über git) auf Toolkit-Updates und bietet an, die Änderungen zu übernehmen, prüft auf die neueste Docker-Image-Version und bietet an, diese zu aktualisieren. Es bietet eine schrittweise Bestätigung sowie die Möglichkeit, die aktuelle Konfiguration zu sichern, und übernimmt das Stoppen/Starten der Docker-Dienste. Weitere Informationen finden Sie unter „Upgrading your deployment“: https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment

Wenn Sie Ihre Instanz lieber ausführen möchten, ohne sich an die Docker-Logs anzuhängen, können Sie bin/up -d verwenden, um sie im Detached-Modus zu starten.

Server überprüfen

Das Overleaf Toolkit enthält ein praktisches Skript namens bin/doctor, das einen Bericht erstellt, der auf nicht erfüllte Abhängigkeiten hinweist.

Bevor Sie fortfahren, führen Sie das Skript bin/doctor aus und prüfen Sie, ob alles korrekt funktioniert:

Run Overleaf Doctor

bin/doctor

Beispielausgabe (gekürzt/zur Veranschaulichung):

Beispielausgabe von bin/doctor

====== Overleaf Doctor ======
- Host Information
    - Linux
    - Output of 'lsb_release -a':
            No LSB modules are available.
            Distributor ID:     Ubuntu
            Description:        Ubuntu 22.04.5 LTS
            Release:    22.04
            Codename:   jammy
- Dependencies
    - bash
        - status: present
        - version info: 5.1.16(1)-release
    - docker
        - status: present
        - version info: Docker version 27.3.1, build ce12230
    - realpath
        - status: present
        - version info: realpath (GNU coreutils) 8.32
    - perl
        - status: present
        - version info: 5.034000
    - awk
        - status: present
        - version info: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1)
    - openssl
        - status: present
        - version info: OpenSSL 3.0.2 15 Mar 2022 (Library: OpenSSL 3.0.2 15 Mar 2022)
    - docker compose
        - status: present
        - version info: Docker Compose version v2.29.7
- Docker Daemon
    - status: up
====== Configuration ======
- config/version
    - status: present
    - version: 5.1.1
- config/overleaf.rc
    - status: present
    - values
        - OVERLEAF_DATA_PATH: data/overleaf
        - OVERLEAF_LOG_PATH: data/overleaf/logs
        - SERVER_PRO: true
            - logged in to 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
    - status: present
    - values
        - OVERLEAF_FILESTORE_BACKEND: fs
        - OVERLEAF_HISTORY_BACKEND: fs
====== Warnings ======
- None, all good
====== End ======

Wenn Abhängigkeiten fehlen, gibt der Doctor Warnungen aus. Falls Probleme auftreten, führen Sie zuerst bin/doctor aus und prüfen Sie die Ausgabe auf Warnungen.

• Benutzer der Ayakaleaf Pro Edition können ein Issue auf GitHub eröffnen: https://github.com/ayaka-notes/toolkit/issues

Fügen Sie in jedem Fall die Ausgabe von bin/doctor Ihrer Nachricht bei.