Hulp krijgen

​

De Doctor

De Overleaf Toolkit wordt geleverd met een handig doctor-script dat helpt bij het debuggen. Voer bin/doctor uit en het script toont informatie over je hostomgeving, je configuratie en de afhankelijkheden die de Toolkit nodig heeft. Deze uitvoer kan ons ook helpen problemen met je Ayakaleaf Pro-installaties te diagnosticeren.

Gebruikers van Overleaf Pro kunnen een issue openen op GitHub.

Het is een goed idee om de uitvoer van het script bin/doctor in je bericht op te nemen.

​

De Doctor raadplegen

Voer het doctor-script uit:

Run doctor

bin/doctor

Je ziet uitvoer die lijkt op het onderstaande voorbeeld.

Voorbeeld van volledige uitvoer

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

​

Hostinformatie

De sectie Host Information bevat informatie over de machine waarop de Toolkit draait (bijvoorbeeld de Linux-distributie en release).

Voorbeeld van uitvoer van 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

​

Afhankelijkheden

De sectie Dependencies toont de tools die nodig zijn om de Toolkit te laten werken. Als een tool aanwezig is, wordt deze vermeld als status: present met versie-informatie. Als deze ontbreekt, wordt deze vermeld als status: MISSING! en wordt er onderaan de doctor-uitvoer een waarschuwing toegevoegd.

Voorbeeld van uitvoer van Dependencies (aanwezig)

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

Voorbeeld van uitvoer van Dependencies (ontbrekend)

- docker
    - status: MISSING!

Als er afhankelijkheden ontbreken, werkt de Toolkit vrijwel zeker niet.

​

Configuratie

De sectie Configuration bevat informatie over bestanden in de map config/. Voor config/overleaf.rc toont de doctor enkele belangrijke waarden. Ontbrekende bestanden worden vermeld als status: MISSING! en er wordt onderaan de doctor-uitvoer een waarschuwing toegevoegd.

Voorbeeld van uitvoer van 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!

Opmerkingen bij het bovenstaande voorbeeld:

• OVERLEAF_DATA_PATH ingesteld op /tmp/overleaf is mogelijk geen veilige locatie voor belangrijke gegevens.
• MONGO_ENABLED: false betekent dat de Toolkit geen eigen MongoDB inricht; zorg er zo nodig voor dat MONGO_URL naar een extern beheerde MongoDB verwijst.
• config/variables.env ontbreekt in het voorbeeld.

​

Waarschuwingen

De sectie Warnings vat de problemen samen die door het doctor-script zijn gevonden. Als er geen problemen zijn, wordt dat in deze sectie aangegeven.

Voorbeeld van uitvoer van Warnings

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