Få hjælp

​

Doktoren

Overleaf Toolkit leveres med et praktisk doctor-script, der hjælper med fejlfinding. Kør bin/doctor, og scriptet udskriver oplysninger om dit værtsmiljø, din konfiguration og de afhængigheder, som Toolkit har brug for. Dette output kan også hjælpe os med at diagnosticere problemer med dine Ayakaleaf Pro-installationer.

Brugere af Overleaf Pro kan oprette et issue på GitHub.

Det er en god idé at inkludere outputtet fra scriptet bin/doctor i din besked.

​

Konsultation hos doktoren

Kør doctor-scriptet:

Run doctor

bin/doctor

Du vil se et output, der ligner eksemplet nedenfor.

Eksempel på fuldt output

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

​

Værtsoplysninger

Afsnittet Host Information indeholder oplysninger om den maskine, der kører Toolkit (for eksempel Linux-distribution og -udgave).

Eksempel på output for værtsoplysninger

- 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

​

Afhængigheder

Afsnittet Dependencies viser de værktøjer, der kræves, for at Toolkit kan fungere. Hvis et værktøj er til stede, vises det som status: present med versionsoplysninger. Hvis det mangler, vises det som status: MISSING!, og der tilføjes en advarsel nederst i outputtet fra doctor.

Eksempel på output for afhængigheder (til stede)

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

Eksempel på output for afhængigheder (mangler)

- docker
    - status: MISSING!

Hvis nogen afhængigheder mangler, vil Toolkit næsten med sikkerhed ikke fungere.

​

Konfiguration

Afsnittet Configuration indeholder oplysninger om filerne i mappen config/. For config/overleaf.rc udskriver doctor nogle centrale værdier. Manglende filer vises som status: MISSING!, og der tilføjes en advarsel nederst i outputtet fra doctor.

Eksempel på konfigurationsoutput

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

Bemærkninger til eksemplet ovenfor:

• OVERLEAF_DATA_PATH sat til /tmp/overleaf er muligvis ikke en sikker placering til vigtige data.
• MONGO_ENABLED: false betyder, at Toolkit ikke opretter sin egen MongoDB; sørg for, at MONGO_URL peger på en eksternt administreret MongoDB, hvis det er nødvendigt.
• config/variables.env mangler i eksemplet.

​

Advarsler

Afsnittet Warnings opsummerer de problemer, som doctor-scriptet har fundet. Hvis der ikke er nogen problemer, angiver dette afsnit det.

Eksempel på output for advarsler

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