Få hjelp

​

Doctor

Overleaf Toolkit leveres med et praktisk doctor-skript som hjelper med feilsøking. Kjør bin/doctor, så skriver skriptet ut informasjon om vertsmiljøet ditt, konfigurasjonen din og avhengighetene Toolkit trenger. Denne utdataen kan også hjelpe oss med å diagnostisere problemer i Ayakaleaf Pro-installasjonene dine.

Brukere av Overleaf Pro kan opprette en issue på GitHub.

Det er lurt å inkludere utdataen fra bin/doctor-skriptet i meldingen din.

​

Konsultere Doctor

Kjør doctor-skriptet:

Run doctor

bin/doctor

Du vil se utdata som ligner på eksempelet nedenfor.

Eksempel på fullstendig 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 ======

​

Vertsinformasjon

Delen Host Information inneholder informasjon om maskinen som kjører Toolkit (for eksempel Linux-distribusjon og -versjon).

Eksempel på utdata for 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

​

Avhengigheter

Delen Dependencies viser verktøyene som kreves for at Toolkit skal fungere. Hvis et verktøy finnes, vises det som status: present med versjonsinformasjon. Hvis det mangler, vises det som status: MISSING!, og en advarsel legges til nederst i utdataen fra doctor.

Eksempel på utdata for avhengigheter (finnes)

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

Eksempel på utdata for avhengigheter (mangler)

- docker
    - status: MISSING!

Hvis noen avhengigheter mangler, vil Toolkit nesten helt sikkert ikke fungere.

​

Konfigurasjon

Delen Configuration inneholder informasjon om filene i katalogen config/. For config/overleaf.rc skriver doctor ut noen sentrale verdier. Manglende filer vises som status: MISSING!, og en advarsel legges til nederst i utdataen fra doctor.

Eksempel på utdata for 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!

Merknader til eksempelet ovenfor:

• OVERLEAF_DATA_PATH satt til /tmp/overleaf er kanskje ikke et trygt sted for viktige data.
• MONGO_ENABLED: false betyr at Toolkit ikke vil klargjøre sin egen MongoDB; sørg for at MONGO_URL peker til en eksternt administrert MongoDB ved behov.
• config/variables.env mangler i eksempelet.

​

Advarsler

Delen Warnings oppsummerer problemer som doctor-skriptet har oppdaget. Hvis det ikke finnes noen problemer, vil denne delen angi det.

Eksempel på utdata for Warnings

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