Configuración del Toolkit

Esta página describe las variables de entorno admitidas en el archivo config/overleaf.rc para los despliegues con el Toolkit.

El archivo config/overleaf.rc está formado por definiciones de variables con el formato NAME=value. Las líneas que empiezan por # se tratan como comentarios.

Es necesario volver a crear los contenedores de Docker ejecutando bin/up después de cambiar cualquier cosa en overleaf.rc o variables.env.

​

Contenedor

​

sharelatex

Nombre	Descripción
PROJECT_NAME	Establece el valor de la opción --project-name que se pasa a docker-compose. Resulta útil al ejecutar varias instancias de Overleaf en un mismo host, ya que cada instancia puede tener un nombre de proyecto distinto. - Valor predeterminado: overleaf
OVERLEAF_IMAGE_NAME	Imagen de Docker que usa el contenedor de la aplicación Server Pro/CE. Es solo el nombre de la imagen de Docker; la etiqueta de la imagen se obtiene de config/version. - Valor predeterminado: - Server Pro: ghcr.io/ayaka-notes/overleaf-pro - Community Edition: sharelatex/sharelatex
SERVER_PRO	Cuando se establece en true, indica al Toolkit que use la imagen de Server Pro (ghcr.io/ayaka-notes/overleaf-pro) en lugar de la imagen predeterminada de Server CE (sharelatex/sharelatex). - Valor predeterminado: false
GIT_BRIDGE_ENABLED	Establécela en true para habilitar la función git-bridge (solo Server Pro). Para más información, consulta la documentación de usuario https://www.overleaf.com/learn/how-to/Git_integration. - Valor predeterminado: false
GIT_BRIDGE_IMAGE	Imagen de Docker que usa el contenedor de git-bridge (solo Server Pro). Es solo el nombre de la imagen de Docker; la etiqueta de la imagen se obtiene de config/version. - Valor predeterminado: ghcr.io/ayaka-notes/overleaf-pro/git-bridge
GIT_BRIDGE_DATA_PATH	Establece la ruta del directorio que se montará en el contenedor git-bridge (solo Server Pro) y que se usará para almacenar los repositorios git. Puede ser una ruta completa (que empiece por /) o relativa al directorio base del Toolkit.
GIT_BRIDGE_LOG_LEVEL	Configura el nivel de registro del contenedor git-bridge. Niveles disponibles: TRACE, DEBUG, INFO, WARN, ERROR. - Valor predeterminado: INFO
SIBLING_CONTAINERS_ENABLED	Cuando se establece en true, indica al Toolkit que use la técnica de Sibling Containers para compilar los proyectos en sandboxes independientes, usando un contenedor de Docker distinto para cada proyecto. Consulta la documentación de <server-pro-only-configuration/sandboxed-compiles> para más información. - Requiere: SERVER_PRO=true - Valor predeterminado: true
SIBLING_CONTAINERS_PULL	Cuando se establece en true, indica al Toolkit que descargue automáticamente todas las imágenes de TeX Live definidas mediante ALL_TEX_LIVE_DOCKER_IMAGES en el archivo config/variables.env al usar el comando bin/up. - Valor predeterminado: true
DOCKER_SOCKET_PATH	Establece la ruta del socket de Docker en la máquina host (la máquina que ejecuta el Toolkit). Cuando SIBLING_CONTAINERS_ENABLED es true, el socket se montará en el contenedor para permitir que el servicio de compilación cree nuevos contenedores de Docker en el host. - Requiere: SIBLING_CONTAINERS_ENABLED=true - Valor predeterminado: /var/run/docker.sock
OVERLEAF_DATA_PATH	Establece la ruta del directorio que se montará en el contenedor principal sharelatex y que se usará para almacenar los datos de compilación. Puede ser una ruta completa (que empiece por /) o relativa al directorio base del Toolkit. - Valor predeterminado: data/overleaf
OVERLEAF_LISTEN_IP	Establece la(s) dirección(es) IP del host a la(s) que se vinculará el contenedor. Por ejemplo, si se establece en 0.0.0.0, la interfaz web estará disponible en cualquier dirección IP del host. Para el acceso directo al contenedor, el valor de OVERLEAF_LISTEN_IP debe establecerse en tu dirección IP pública. Establecer OVERLEAF_LISTEN_IP en 0.0.0.0 o en la IP externa de tu host suele provocar errores cuando se usa junto con el . - Valor predeterminado: 127.0.0.1
OVERLEAF_PORT	Establece el puerto del host al que se vinculará el contenedor. Por ejemplo, si se establece en 8099 y OVERLEAF_LISTEN_IP está establecida en 127.0.0.1, la interfaz web estará disponible en http://localhost:8099. - Valor predeterminado: 80
OVERLEAF_LOG_PATH	Establece la ruta del directorio que se montará en el contenedor principal sharelatex y que se usará para que los registros de la aplicación estén disponibles en el host de Docker. Puede ser una ruta completa (que empiece por /) o relativa al directorio base del Toolkit. Elimina esta entrada de configuración para deshabilitar el montaje (bind-mount). Si no se define, los registros se descartarán al volver a crear el contenedor. Consulta para obtener información sobre el registro. - Valor predeterminado: sin definir

---

​

mongo

Nombre	Descripción
MONGO_ENABLED	Cuando se establece en true, indica al Toolkit que cree un contenedor de MongoDB para alojar la base de datos. Cuando se establece en false, este contenedor no se creará y el sistema usará en su lugar la base de datos de MongoDB especificada en MONGO_URL. - Valor predeterminado: true
MONGO_URL	Especifica la URL de conexión de MongoDB que se usará cuando MONGO_ENABLED sea false. - Valor predeterminado: sin definir
MONGO_DATA_PATH	Establece la ruta del directorio que se montará en el contenedor mongo y que se usará para almacenar la base de datos de MongoDB. Puede ser una ruta completa (que empiece por /) o relativa al directorio base del Toolkit. Esta opción solo afecta al contenedor local mongo que se crea cuando MONGO_ENABLED es true. - Valor predeterminado: data/mongo
MONGO_IMAGE	Imagen de Docker que usa el contenedor de MongoDB. Es solo el nombre de la imagen de Docker; la etiqueta de la imagen debe indicarse en MONGO_VERSION (ver más abajo). - Valor predeterminado: mongo
MONGO_VERSION	Versión de MongoDB que usa el contenedor de MongoDB. El valor debe empezar por la versión principal de MongoDB seguida de un punto, p. ej. 6.0 o 6.0-with-suffix. - Valor predeterminado: 6.0

---

​

redis

Nombre	Descripción
REDIS_ENABLED	Cuando se establece en true, indica al Toolkit que cree un contenedor de Redis para alojar la base de datos de Redis. Cuando se establece en false, este contenedor no se creará y el sistema usará en su lugar la base de datos de Redis especificada en REDIS_HOST y REDIS_PORT. - Valor predeterminado: true
REDIS_HOST	Especifica el host de Redis que se usará cuando REDIS_ENABLED sea false. - Valor predeterminado: sin definir
REDIS_PORT	Especifica el puerto de Redis que se usará cuando REDIS_ENABLED sea false. - Valor predeterminado: sin definir
REDIS_DATA_PATH	Establece la ruta del directorio que se montará en el contenedor redis y que se usará para almacenar la base de datos de Redis. Puede ser una ruta completa (que empiece por /) o relativa al directorio base del Toolkit. Esta opción solo afecta al contenedor local redis que se crea cuando REDIS_ENABLED es true. - Valor predeterminado: data/redis
REDIS_AOF_PERSISTENCE	Activa la persistencia AOF (Append Only File) para Redis. Es la configuración recomendada para la persistencia de Redis. Para más detalles, consulta la sección <../../../maintenance/data-and-backups#aof-append-only-file> en <../../maintenance/data-and-backups>. - Valor predeterminado: true

---

​

nginx

Nombre	Descripción
NGINX_ENABLED	Cuando se establece en true, indica al Toolkit que cree un contenedor de NGINX que actúe como proxy TLS. - Valor predeterminado: false
NGINX_CONFIG_PATH	Ruta del archivo de configuración de NGINX que se usará para el proxy TLS. - Valor predeterminado: config/nginx/nginx.conf
NGINX_TLS_LISTEN_IP	Establece la(s) dirección(es) IP del host a la(s) que se vinculará el contenedor del proxy TLS para HTTPS. Por ejemplo, si se establece en 0.0.0.0, la interfaz web HTTPS estará disponible en cualquier dirección IP del host. Normalmente debería establecerse en la IP externa de tu host. - Valor predeterminado: 127.0.1.1
NGINX_HTTP_LISTEN_IP	Establece la(s) dirección(es) IP del host a la(s) que se vinculará el contenedor del proxy TLS para la redirección HTTP. Por ejemplo, si se establece en 127.0.1.1, las conexiones HTTP a 127.0.1.1 se redirigirán a la interfaz web HTTPS. Normalmente debería establecerse en la IP externa de tu host. No la establezcas en 0.0.0.0, ya que normalmente provocará un conflicto con OVERLEAF_LISTEN_IP. - Valor predeterminado: 127.0.1.1
NGINX_HTTP_PORT	Establece el puerto del host al que se vinculará el contenedor del proxy TLS para HTTP. - Valor predeterminado: 80
TLS_PORT	Establece el puerto del host al que se vinculará el contenedor del proxy TLS para HTTPS. - Valor predeterminado: 443
TLS_PRIVATE_KEY_PATH	Ruta de la clave privada que se usará para el proxy TLS. - Valor predeterminado: config/nginx/certs/overleaf_key.pem
TLS_CERTIFICATE_PATH	Ruta del certificado público que se usará para el proxy TLS. - Valor predeterminado: config/nginx/certs/overleaf_certificate.pem