Obtener ayuda

​

El Doctor

El Overleaf Toolkit incluye un práctico script doctor que ayuda a depurar problemas. Ejecuta bin/doctor y el script mostrará información sobre tu entorno anfitrión, tu configuración y las dependencias que necesita el Toolkit. Esta salida también puede ayudarnos a diagnosticar problemas en tus instalaciones de Ayakaleaf Pro.

Los usuarios de Overleaf Pro pueden abrir un issue en GitHub.

Es buena idea incluir la salida del script bin/doctor en tu mensaje.

​

Consultar al Doctor

Ejecuta el script doctor:

Run doctor

bin/doctor

Verás una salida similar al siguiente ejemplo.

Ejemplo de salida completa

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

​

Información del host

La sección Host Information contiene información sobre la máquina que ejecuta el Toolkit (por ejemplo, la distribución y la versión de Linux).

Ejemplo de salida de 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

​

Dependencias

La sección Dependencies enumera las herramientas necesarias para que el Toolkit funcione. Si una herramienta está presente, aparecerá como status: present junto con la información de su versión. Si falta, aparecerá como status: MISSING! y se añadirá una advertencia al final de la salida de doctor.

Ejemplo de salida de Dependency (presente)

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

Ejemplo de salida de Dependency (ausente)

- docker
    - status: MISSING!

Si falta alguna dependencia, es casi seguro que el Toolkit no funcionará.

​

Configuración

La sección Configuration contiene información sobre los archivos del directorio config/. Para config/overleaf.rc, el doctor muestra algunos valores clave. Los archivos que falten aparecerán como status: MISSING! y se añadirá una advertencia al final de la salida de doctor.

Ejemplo de salida de 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!

Notas sobre el ejemplo anterior:

• Un OVERLEAF_DATA_PATH establecido en /tmp/overleaf puede no ser una ubicación segura para datos importantes.
• MONGO_ENABLED: false significa que el Toolkit no aprovisionará su propio MongoDB; si es necesario, asegúrate de que MONGO_URL apunta a un MongoDB gestionado externamente.
• En el ejemplo falta config/variables.env.

​

Advertencias

La sección Warnings resume los problemas detectados por el script doctor. Si no hay problemas, esta sección lo indicará.

Ejemplo de salida de Warnings

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