Uzyskiwanie pomocy

​

Doctor

Overleaf Toolkit zawiera przydatny skrypt doctor, który ułatwia debugowanie. Uruchom bin/doctor, a skrypt wyświetli informacje o środowisku hosta, Twojej konfiguracji oraz zależnościach wymaganych przez Toolkit. Te dane wyjściowe mogą również pomóc nam w diagnozowaniu problemów z Twoimi instalacjami Ayakaleaf Pro.

Użytkownicy Overleaf Pro mogą zgłosić problem na GitHub.

Warto dołączyć do zgłoszenia wynik działania skryptu bin/doctor.

​

Konsultacja z Doctorem

Uruchom skrypt doctor:

Run doctor

bin/doctor

Zobaczysz dane wyjściowe podobne do poniższego przykładu.

Przykład pełnych danych wyjściowych

====== 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 ======

​

Informacje o hoście

Sekcja Host Information zawiera informacje o maszynie, na której działa Toolkit (na przykład dystrybucję i wydanie systemu Linux).

Przykładowe dane wyjściowe sekcji Host Information

- 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

​

Zależności

Sekcja Dependencies zawiera listę narzędzi wymaganych do działania Toolkit. Jeśli narzędzie jest obecne, zostanie oznaczone jako status: present wraz z informacją o wersji. Jeśli go brakuje, zostanie oznaczone jako status: MISSING!, a na końcu danych wyjściowych doctor pojawi się ostrzeżenie.

Przykładowe dane wyjściowe zależności (obecna)

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

Przykładowe dane wyjściowe zależności (brakująca)

- docker
    - status: MISSING!

Jeśli brakuje którejkolwiek zależności, Toolkit niemal na pewno nie będzie działać.

​

Konfiguracja

Sekcja Configuration zawiera informacje o plikach w katalogu config/. W przypadku config/overleaf.rc doctor wyświetla niektóre kluczowe wartości. Brakujące pliki zostaną oznaczone jako status: MISSING!, a na końcu danych wyjściowych doctor pojawi się ostrzeżenie.

Przykładowe dane wyjściowe sekcji Configuration

====== 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!

Uwagi do powyższego przykładu:

• OVERLEAF_DATA_PATH ustawione na /tmp/overleaf może nie być bezpieczną lokalizacją dla ważnych danych.
• MONGO_ENABLED: false oznacza, że Toolkit nie utworzy własnej instancji MongoDB; w razie potrzeby upewnij się, że MONGO_URL wskazuje na zewnętrznie zarządzaną bazę MongoDB.
• W przykładzie brakuje pliku config/variables.env.

​

Ostrzeżenia

Sekcja Warnings podsumowuje problemy wykryte przez skrypt doctor. Jeśli nie ma żadnych problemów, sekcja to zasygnalizuje.

Przykładowe dane wyjściowe sekcji Warnings

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