Hilfe erhalten

​

Der Doctor

Das Overleaf Toolkit enthält ein praktisches doctor-Skript, das bei der Fehlersuche hilft. Führen Sie bin/doctor aus, und das Skript gibt Informationen über Ihre Host-Umgebung, Ihre Konfiguration und die vom Toolkit benötigten Abhängigkeiten aus. Diese Ausgabe kann uns auch helfen, Probleme mit Ihren Ayakaleaf Pro-Installationen zu diagnostizieren.

Nutzerinnen und Nutzer von Overleaf Pro können ein Issue auf GitHub eröffnen.

Es empfiehlt sich, die Ausgabe des Skripts bin/doctor in Ihre Nachricht aufzunehmen.

​

Den Doctor befragen

Führen Sie das Doctor-Skript aus:

Run doctor

bin/doctor

Sie sehen eine Ausgabe ähnlich dem folgenden Beispiel.

Beispiel für die vollständige Ausgabe

====== 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 28.0.4, build b8034c0
    - docker compose
        - status: present
        - version info: Docker Compose version v2.34.0
    - realpath
        - status: present
        - version info: realpath (GNU coreutils) 8.32
    - perl
        - status: present
        - version info: 5.034000
    - awk
        - status: present
        - version info: mawk 1.3.4 20200120
- Docker Daemon
    - status: up
====== Configuration ======
- config/version
    - status: present
    - version: 5.4.0
- config/overleaf.rc
    - status: present
    - values
        - OVERLEAF_DATA_PATH: data/overleaf
        - OVERLEAF_LOG_PATH: data/overleaf/logs
        - SERVER_PRO: true
        - SIBLING_CONTAINERS_ENABLED: true
            - logged in to quay.io: true
        - MONGO_ENABLED: true
        - REDIS_ENABLED: true
- config/variables.env
    - status: present
    - values
        - OVERLEAF_FILESTORE_BACKEND: fs
        - OVERLEAF_HISTORY_BACKEND: fs

====== Warnings ======
- None, all good
====== End ======

​

Host-Informationen

Der Abschnitt Host Information enthält Informationen über den Rechner, auf dem das Toolkit läuft (zum Beispiel Linux-Distribution und Release).

Beispiel für die Ausgabe der Host-Informationen

- 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

​

Abhängigkeiten

Der Abschnitt Dependencies listet die Werkzeuge auf, die das Toolkit zum Funktionieren benötigt. Ist ein Werkzeug vorhanden, wird es mit status: present und Versionsinformationen aufgeführt. Fehlt es, wird es mit status: MISSING! aufgeführt, und am Ende der doctor-Ausgabe wird eine Warnung hinzugefügt.

Beispiel für die Ausgabe einer Abhängigkeit (vorhanden)

- docker
    - status: present
    - version info: Docker version 28.0.4, build b8034c0

Beispiel für die Ausgabe einer Abhängigkeit (fehlend)

- docker
    - status: MISSING!

Fehlen Abhängigkeiten, wird das Toolkit mit ziemlicher Sicherheit nicht funktionieren.

​

Konfiguration

Der Abschnitt Configuration enthält Informationen über die Dateien im Verzeichnis config/. Für config/overleaf.rc gibt der Doctor einige wichtige Werte aus. Fehlende Dateien werden mit status: MISSING! aufgeführt, und am Ende der doctor-Ausgabe wird eine Warnung hinzugefügt.

Beispiel für die Ausgabe der Konfiguration

====== Configuration ======
- config/version
    - status: present
    - version: 5.4.0
- config/overleaf.rc
    - status: present
    - values
        - OVERLEAF_DATA_PATH: /tmp/overleaf
        - SERVER_PRO: false
        - MONGO_ENABLED: false
        - REDIS_ENABLED: true
- config/variables.env
    - status: MISSING!

Anmerkungen zum obigen Beispiel:

• OVERLEAF_DATA_PATH mit dem Wert /tmp/overleaf ist möglicherweise kein sicherer Speicherort für wichtige Daten.
• MONGO_ENABLED: false bedeutet, dass das Toolkit keine eigene MongoDB bereitstellt; stellen Sie bei Bedarf sicher, dass MONGO_URL auf eine extern verwaltete MongoDB verweist.
• config/variables.env fehlt im Beispiel.

​

Warnungen

Der Abschnitt Warnings fasst die vom Doctor-Skript gefundenen Probleme zusammen. Gibt es keine Probleme, wird dies in diesem Abschnitt angezeigt.

Beispiel für die Ausgabe der Warnungen

====== Warnings ======
- configuration file variables.env not found
- rc file, OVERLEAF_DATA_PATH not set
====== End =======