> For the complete documentation index, see [llms.txt](https://ayakaleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ayakaleaf-pro.ayaka.space/on-premises/es/primeros-pasos/what-is-the-overleaf-toolkit.md). # ¿Qué es el Kit de herramientas de Ayakaleaf? El toolkit de ayakaleaf es el método de implementación recomendado para las instalaciones locales de la Community Edition, Ayakaleaf Pro; ha sido diseñado para funcionar con el entorno más común: un único servidor físico o una máquina virtual. El Toolkit usa `docker compose` para gestionar los contenedores Docker de su servidor y proporciona un conjunto de scripts que envuelven `docker` comandos para ayudar con el aspecto más técnico de gestionar una versión local de Overleaf. #### El `bin/docker-compose` envoltorio El `bin/docker-compose` script es un envoltorio de `docker compose`. Carga la configuración desde el `config/` directorio, antes de invocar `docker compose` con los argumentos que se hayan pasado al script. Puede tratar `bin/docker-compose` como un envoltorio transparente para el `docker compose` programa instalado en su máquina. Ejemplo: {% code title="Comprobar contenedores en ejecución" %} ```bash $ bin/docker-compose ps ``` {% endcode %} #### Utilidades prácticas Además de `bin/docker-compose`, el Toolkit proporciona scripts prácticos para ayudar con tareas comunes: * `bin/up`: acceso directo a `bin/docker-compose up` * `bin/start`: acceso directo a `bin/docker-compose start` * `bin/stop`: acceso directo a `bin/docker-compose stop` * `bin/shell`: abre una shell dentro del **sharelatex** contenedor * `bin/doctor`: script utilizado para recopilar información de instalación y despliegue. Consulte la sección "Comprobación de su servidor" más abajo * `bin/mongo`: abre una shell dentro del **mongo** contenedor y cambia a la base de datos correcta (**sharelatex**) * `bin/backup-config`: crea una copia (zip o tar) de su configuración actual y la guarda en un directorio de destino de su elección * `bin/logs`: ver/seguir los registros del servicio * `bin/error-logs`: ver/seguir los registros de errores del servicio * `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`: ayuda para simplificar la ejecución de scripts almacenados en el **sharelatex** contenedor * `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/iniciar los servicios de Docker. Consulte Actualización de su despliegue para más información: {% hint style="info" %} Si prefiere ejecutar su instancia sin adjuntarse a los registros de Docker, puede ejecutar `bin/up -d` para ejecutarla en modo desacoplado. {% endhint %} #### Comprobación de su servidor El Overleaf Toolkit incluye un útil script llamado `bin/doctor` que genera un informe que señala cualquier dependencia no cumplida. Antes de continuar, ejecute el `bin/doctor` script y compruebe que todo funciona correctamente: {% code title="Ejecutar Overleaf Doctor" %} ```bash bin/doctor ``` {% endcode %} Ejemplo de salida (recortada/ilustrativa):
Salida de ejemplo de bin/doctor ``` ====== Overleaf Doctor ====== - Información del host - Linux - Salida de 'lsb_release -a': No hay módulos LSB disponibles. ID del distribuidor: Ubuntu Descripción: Ubuntu 22.04.5 LTS Versión: 22.04 Nombre en clave: jammy - Dependencias - bash - estado: presente - información de versión: 5.1.16(1)-release - docker - estado: presente - información de versión: Docker version 27.3.1, build ce12230 - realpath - estado: presente - información de versión: realpath (GNU coreutils) 8.32 - perl - estado: presente - información de versión: 5.034000 - awk - estado: presente - información de versión: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1) - openssl - estado: presente - información de versión: OpenSSL 3.0.2 15 Mar 2022 (Biblioteca: OpenSSL 3.0.2 15 Mar 2022) - docker compose - estado: presente - información de versión: Docker Compose versión v2.29.7 - Demonio de Docker - estado: en ejecución ====== Configuración ====== - config/version - estado: presente - versión: 5.1.1 - config/overleaf.rc - estado: presente - valores - OVERLEAF_DATA_PATH: data/overleaf - OVERLEAF_LOG_PATH: data/overleaf/logs - SERVER_PRO: true - sesión iniciada en 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 - estado: presente - valores - OVERLEAF_FILESTORE_BACKEND: fs - OVERLEAF_HISTORY_BACKEND: fs ====== Advertencias ====== - Ninguna, todo bien ====== Fin ====== ```
Si falta alguna dependencia, el doctor mostrará advertencias. Si tiene problemas, primero ejecute `bin/doctor` y compruebe si su salida contiene advertencias. {% hint style="info" %} * Los usuarios de la edición Ayakaleaf Pro pueden abrir un problema en GitHub: En ambos casos, incluya la salida de `bin/doctor` en su mensaje. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://ayakaleaf-pro.ayaka.space/on-premises/es/primeros-pasos/what-is-the-overleaf-toolkit.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.