> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 2. Familiarízate con el Toolkit

### Echando un vistazo

Ahora que tienes una copia local del Toolkit, echemos un vistazo a la estructura del repositorio con el comando `ls`.

```bash title="Run this" theme={null}
ls -l
```

> [!NOTE]
>
> El comando `ls -l` muestra una vista detallada en formato largo del contenido de un directorio, con información adicional de los archivos, como permisos, propietario y tamaño.

Si todo se ha clonado correctamente, deberías ver algo como esto:

```text theme={null}
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 bin
-rw-r--r-- 1 fry fry  6465 Aug 30 14:16 CHANGELOG.md
drwxr-xr-x 2 fry fry  4096 Sep  6 12:43 config
drwxr-xr-x 5 fry fry  4096 Aug 30 14:22 data
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 doc
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 lib
-rw-r--r-- 1 fry fry 34520 Aug 30 14:16 LICENSE
-rw-r--r-- 1 fry fry  1178 Aug 30 14:16 README.md
```

> [!NOTE]
>
> Todos los archivos de configuración propios del usuario se encuentran en el directorio `config/`. Este directorio está **excluido** del sistema de control de versiones git, por lo que no se modificará al actualizar el Toolkit.

## Estructura del repositorio

| Nombre | Descripción |
| - | - |
| `bin` | Esta carpeta contiene una colección de scripts que te ayudan a gestionar tu instancia del servidor de Overleaf. Puedes leer más sobre estos scripts en la sección Comandos más abajo. |
| `config` | Esta carpeta contiene tus propios archivos de configuración locales. |
| `lib` | Esta carpeta contiene los archivos de configuración base que utiliza el Toolkit. |
| `data` | Por defecto, esta carpeta contiene la ubicación de almacenamiento de MongoDb, Redis y Overleaf. Para más información, consulta la sección [Datos persistentes](https://ayakaleaf-pro.mintlify.site/es/on-premises/configuration/overleaf-toolkit/files-and-locations.md#persistent-data) más abajo. |

> [!WARNING]
>
> Recomendamos **no** modificar directamente los archivos fuera de la carpeta `/config`. Si necesitas hacer cambios, puedes realizarlos mediante variables de entorno definidas en **config/variables.env** o en **config/overleaf.rc**.\
> Por ejemplo, para establecer la imagen del servicio `mongo`, en lugar de editar directamente `lib/docker-compose.mongo.yml`, establece la imagen mediante la variable de entorno `MONGO_IMAGE` en `config/overleaf.rc`. Para más información, consulta la página [Ajustes del Toolkit](https://ayakaleaf-pro.mintlify.site/es/on-premises/configuration/overleaf-toolkit/toolkit-settings.md).

> [!NOTE]
>
> El Toolkit **no** modificará ningún dato del directorio `config/` sin tu permiso.

## Comandos

Ejecuta estos scripts desde el directorio del Toolkit. Cada uno muestra sus opciones con `--help`.

| Comando | Qué hace |
| - | - |
| `bin/init` | Crea los archivos de configuración en `config/` la primera vez. `bin/init --tls` añade la configuración del proxy TLS de NGINX. |
| `bin/up` | Crea e inicia los contenedores (`bin/docker-compose up`). Añade `-d` para ejecutarlos en segundo plano en lugar de seguir los registros. Ejecútalo después de cada cambio en `config/`: vuelve a crear los contenedores cuya configuración haya cambiado. |
| `bin/start` | Vuelve a iniciar los contenedores existentes (`bin/docker-compose start`). No aplica los cambios de configuración. |
| `bin/stop` | Detiene los contenedores y los conserva (`bin/docker-compose stop`). |
| `bin/docker-compose` | Ejecuta `docker compose` con los archivos del Toolkit, por ejemplo `bin/docker-compose ps` o `bin/docker-compose restart sharelatex`. |
| `bin/logs` | Muestra o sigue los registros de uno o varios servicios, por ejemplo `bin/logs -f web`. |
| `bin/error-logs` | Como `bin/logs`, pero muestra solo los errores. |
| `bin/shell` | Abre una shell dentro del contenedor `sharelatex`. |
| `bin/mongo` | Abre una shell de MongoDB en la base de datos `sharelatex`. |
| `bin/run-script` | Ejecuta un script incluido dentro del contenedor `sharelatex`. |
| `bin/doctor` | Comprueba el host y la configuración, e imprime un informe para compartir cuando pidas ayuda. |
| `bin/images` | Muestra las imágenes de Docker de Overleaf que hay en el host. |
| `bin/backup-config` | Copia el directorio `config/` a una ubicación de copia de seguridad (copia, zip o tar). |
| `bin/upgrade` | Actualiza el Toolkit y la imagen de Overleaf paso a paso; consulta [Actualizar tu despliegue](https://ayakaleaf-pro.mintlify.site/es/on-premises/maintenance/upgrading-your-deployment.md). |
| `bin/rename-env-vars-5-0`, `bin/rename-rc-vars` | Migraciones puntuales de los antiguos nombres de variables `SHARELATEX_*` a `OVERLEAF_*`. |

> [!WARNING]
>
> Cuando `bin/up` vuelve a crear un contenedor, se pierde todo lo que se haya cambiado dentro de él, por ejemplo paquetes instalados o archivos editados mediante `bin/shell`. Solo se conservan los directorios de datos (`data/` por defecto) y `config/`. Realiza los cambios permanentes mediante `config/variables.env`, `config/overleaf.rc` o `config/docker-compose.override.yml`.

> [!NOTE]
>
> Si cada `bin/up` cierra la sesión de todos los usuarios, establece `OVERLEAF_SESSION_SECRET`. Sin ella, las cookies de sesión se firman con un secreto que se vuelve a generar cada vez que se crea de nuevo el contenedor; consulta las preguntas y respuestas de [Variables de entorno](https://ayakaleaf-pro.mintlify.site/es/on-premises/configuration/overleaf-toolkit/environment-variables.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.