Få hjälp

​

Doktorn

Overleaf Toolkit levereras med ett praktiskt doctor-skript som hjälper till vid felsökning. Kör bin/doctor så skriver skriptet ut information om din värdmiljö, din konfiguration och de beroenden som Toolkit behöver. Utdata kan också hjälpa oss att diagnostisera problem i dina Ayakaleaf Pro-installationer.

Användare av Overleaf Pro kan skapa ett ärende på GitHub.

Det är en bra idé att inkludera utdata från skriptet bin/doctor i ditt meddelande.

​

Rådfråga doktorn

Kör doctor-skriptet:

Run doctor

bin/doctor

Du kommer att se utdata som liknar exemplet nedan.

Exempel på fullständig utdata

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

Avsnittet Host Information innehåller information om maskinen som kör Toolkit (till exempel Linux-distribution och version).

Exempel på utdata för värdinformation

- 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

​

Beroenden

Avsnittet Dependencies listar de verktyg som krävs för att Toolkit ska fungera. Om ett verktyg finns listas det som status: present med versionsinformation. Om det saknas listas det som status: MISSING! och en varning läggs till längst ner i utdata från doctor.

Exempel på utdata för beroenden (finns)

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

Exempel på utdata för beroenden (saknas)

- docker
    - status: MISSING!

Om några beroenden saknas kommer Toolkit nästan säkert inte att fungera.

​

Konfiguration

Avsnittet Configuration innehåller information om filerna i katalogen config/. För config/overleaf.rc skriver doktorn ut några viktiga värden. Saknade filer listas som status: MISSING! och en varning läggs till längst ner i utdata från doctor.

Exempel på utdata för 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!

Anmärkningar om exemplet ovan:

• OVERLEAF_DATA_PATH satt till /tmp/overleaf är kanske inte en säker plats för viktiga data.
• MONGO_ENABLED: false innebär att Toolkit inte tillhandahåller en egen MongoDB; se vid behov till att MONGO_URL pekar på en externt hanterad MongoDB.
• config/variables.env saknas i exemplet.

​

Varningar

Avsnittet Warnings sammanfattar problem som doctor-skriptet har upptäckt. Om det inte finns några problem anges det i det här avsnittet.

Exempel på utdata för varningar

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