Získání pomoci

​

Doktor

Overleaf Toolkit obsahuje praktický skript doctor, který pomáhá s laděním. Spusťte bin/doctor a skript vypíše informace o vašem hostitelském prostředí, vaší konfiguraci a závislostech, které Toolkit potřebuje. Tento výstup nám také může pomoci diagnostikovat problémy s vašimi instalacemi Ayakaleaf Pro.

Uživatelé Overleaf Pro mohou založit issue na GitHubu.

Je dobré do zprávy přiložit výstup skriptu bin/doctor.

​

Konzultace s Doktorem

Spusťte skript doctor:

Run doctor

bin/doctor

Zobrazí se výstup podobný níže uvedenému příkladu.

Příklad úplného výstupu

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

​

Informace o hostiteli

Sekce Host Information obsahuje informace o stroji, na kterém Toolkit běží (například distribuci a vydání Linuxu).

Příklad výstupu 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

​

Závislosti

Sekce Dependencies uvádí nástroje, které Toolkit ke své činnosti potřebuje. Pokud je nástroj k dispozici, bude uveden jako status: present spolu s informací o verzi. Pokud chybí, bude uveden jako status: MISSING! a na konec výstupu doctor se přidá varování.

Příklad výstupu závislosti (k dispozici)

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

Příklad výstupu závislosti (chybí)

- docker
    - status: MISSING!

Pokud některé závislosti chybí, Toolkit téměř jistě nebude fungovat.

​

Konfigurace

Sekce Configuration obsahuje informace o souborech v adresáři config/. Pro config/overleaf.rc vypíše doctor některé klíčové hodnoty. Chybějící soubory budou uvedeny jako status: MISSING! a na konec výstupu doctor se přidá varování.

Příklad výstupu 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!

Poznámky k výše uvedenému příkladu:

• OVERLEAF_DATA_PATH nastavená na /tmp/overleaf nemusí být bezpečným umístěním pro důležitá data.
• MONGO_ENABLED: false znamená, že Toolkit nezřídí vlastní MongoDB; v případě potřeby zajistěte, aby MONGO_URL odkazovala na externě spravovanou MongoDB.
• V příkladu chybí config/variables.env.

​

Varování

Sekce Warnings shrnuje problémy zjištěné skriptem doctor. Pokud žádné problémy nejsou, tato sekce to uvede.

Příklad výstupu Warnings

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