¿Qué es el Ayakaleaf Toolkit?

El Ayakaleaf Toolkit es el método de despliegue recomendado para instalaciones locales de Community Edition y Ayakaleaf Pro, y se ha diseñado para funcionar en el entorno más común: un único servidor físico o máquina virtual. El Toolkit usa docker compose para gestionar los contenedores de Docker de tu servidor y ofrece un conjunto de scripts que envuelven comandos de docker para ayudarte con la parte más técnica de la gestión de una versión local de Overleaf.

El wrapper bin/docker-compose

El script bin/docker-compose es un wrapper de docker compose. Carga la configuración del directorio config/ antes de invocar docker compose con los argumentos que se hayan pasado al script.

Puedes tratar bin/docker-compose como un wrapper transparente del programa docker compose instalado en tu máquina.

Ejemplo:

Check running containers

$ bin/docker-compose ps

Scripts auxiliares

Además de bin/docker-compose, el Toolkit ofrece scripts prácticos para ayudarte con tareas habituales:

• bin/up: atajo de bin/docker-compose up
• bin/start: atajo de bin/docker-compose start
• bin/stop: atajo de bin/docker-compose stop
• bin/shell: inicia una shell dentro del contenedor sharelatex
• bin/doctor: script que recopila información sobre la instalación y el despliegue. Consulta la sección “Comprobar tu servidor” más abajo
• bin/mongo: inicia una shell dentro del contenedor mongo y cambia a la base de datos correcta (sharelatex)
• bin/backup-config: crea una copia (zip o tar) de tu configuración actual y la guarda en el directorio de destino que elijas
• bin/logs: ver/seguir los registros de los servicios
• bin/error-logs: ver/seguir los registros de errores de los servicios
• bin/rename-env-vars-5-0: script de migración para actualizar las variables de entorno en config/variables.env (cambio de marca de ShareLaTeX a Overleaf)
• bin/rename-rc-vars: script de migración para actualizar las variables de entorno en config/overleaf.rc (cambio de marca de ShareLaTeX a Overleaf)
• bin/run-script: utilidad para simplificar la ejecución de scripts almacenados dentro del contenedor sharelatex
• bin/upgrade: ayuda con las actualizaciones de la instancia. El script comprobará si hay actualizaciones del Toolkit (mediante git) y ofrecerá descargar los cambios, comprobará la última versión de la imagen de Docker y ofrecerá actualizarla. Proporciona confirmación paso a paso, la opción de hacer una copia de seguridad de la configuración actual y se encarga de detener e iniciar los servicios de Docker. Consulta Actualizar tu despliegue para más información: https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment

Si prefieres ejecutar tu instancia sin conectarte a los registros de Docker, puedes ejecutar bin/up -d para usar el modo desacoplado (detached).

Comprobar tu servidor

El Overleaf Toolkit incluye un práctico script llamado bin/doctor que genera un informe señalando cualquier dependencia no satisfecha.

Antes de continuar, ejecuta el script bin/doctor y comprueba que todo funciona correctamente:

Run Overleaf Doctor

bin/doctor

Salida de ejemplo (truncada/ilustrativa):

Salida de ejemplo de bin/doctor

====== 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 27.3.1, build ce12230
    - realpath
        - status: present
        - version info: realpath (GNU coreutils) 8.32
    - perl
        - status: present
        - version info: 5.034000
    - awk
        - status: present
        - version info: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1)
    - openssl
        - status: present
        - version info: OpenSSL 3.0.2 15 Mar 2022 (Library: OpenSSL 3.0.2 15 Mar 2022)
    - docker compose
        - status: present
        - version info: Docker Compose version v2.29.7
- Docker Daemon
    - status: up
====== Configuration ======
- config/version
    - status: present
    - version: 5.1.1
- config/overleaf.rc
    - status: present
    - values
        - OVERLEAF_DATA_PATH: data/overleaf
        - OVERLEAF_LOG_PATH: data/overleaf/logs
        - SERVER_PRO: true
            - logged in to quay.io: true
        - SIBLING_CONTAINERS_ENABLED: true
        - OVERLEAF_LISTEN_IP: 0.0.0.0
        - OVERLEAF_PORT: 80
        - MONGO_ENABLED: true
        - MONGO_IMAGE: mongo
        - MONGO_VERSION: 6.0
        - MONGO_DATA_PATH: data/mongo
        - REDIS_ENABLED: true
        - REDIS_IMAGE: redis:6.2
        - REDIS_DATA_PATH: data/redis
- config/variables.env
    - status: present
    - values
        - OVERLEAF_FILESTORE_BACKEND: fs
        - OVERLEAF_HISTORY_BACKEND: fs
====== Warnings ======
- None, all good
====== End ======

Si falta alguna dependencia, doctor mostrará advertencias. Si tienes problemas, ejecuta primero bin/doctor y revisa si su salida contiene advertencias.

• Los usuarios de Ayakaleaf Pro Edition pueden abrir una incidencia en GitHub: https://github.com/ayaka-notes/toolkit/issues

En ambos casos, incluye la salida de bin/doctor en tu mensaje.