Ottenere aiuto

​

Il Doctor

L’Overleaf Toolkit include un comodo script doctor per aiutare nel debug. Esegui bin/doctor e lo script stamperà informazioni sul tuo ambiente host, sulla tua configurazione e sulle dipendenze necessarie al Toolkit. Questo output può anche aiutarci a diagnosticare i problemi delle tue installazioni di Ayakaleaf Pro.

Gli utenti di Overleaf Pro possono aprire una issue su GitHub.

È una buona idea includere nel tuo messaggio l’output dello script bin/doctor.

​

Consultare il Doctor

Esegui lo script doctor:

Run doctor

bin/doctor

Vedrai un output simile all’esempio seguente.

Esempio di output completo

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

​

Informazioni sull’host

La sezione Host Information contiene informazioni sulla macchina che esegue il Toolkit (ad esempio, distribuzione Linux e release).

Esempio di output delle informazioni sull'host

- 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

​

Dipendenze

La sezione Dependencies elenca gli strumenti necessari al funzionamento del Toolkit. Se uno strumento è presente, verrà indicato come status: present con le informazioni sulla versione. Se manca, verrà indicato come status: MISSING! e verrà aggiunto un avviso in fondo all’output di doctor.

Esempio di output delle dipendenze (presente)

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

Esempio di output delle dipendenze (mancante)

- docker
    - status: MISSING!

Se mancano delle dipendenze, il Toolkit quasi certamente non funzionerà.

​

Configurazione

La sezione Configuration contiene informazioni sui file nella directory config/. Per config/overleaf.rc, il doctor stampa alcuni valori chiave. I file mancanti verranno indicati come status: MISSING! e verrà aggiunto un avviso in fondo all’output di doctor.

Esempio di output della configurazione

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

Note sull’esempio precedente:

• OVERLEAF_DATA_PATH impostato su /tmp/overleaf potrebbe non essere una posizione sicura per dati importanti.
• MONGO_ENABLED: false significa che il Toolkit non predisporrà un proprio MongoDB; assicurati che MONGO_URL punti a un MongoDB gestito esternamente, se necessario.
• Nell’esempio manca config/variables.env.

​

Avvisi

La sezione Warnings riassume i problemi rilevati dallo script doctor. Se non ci sono problemi, questa sezione lo indicherà.

Esempio di output degli avvisi

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