Toolkit-inställningar

Den här sidan beskriver de miljövariabler som stöds i filen config/overleaf.rc för Toolkit-driftsättningar.

Filen config/overleaf.rc består av variabeldefinitioner på formen NAME=value. Rader som börjar med # behandlas som kommentarer.

Du måste återskapa Docker-containrarna genom att köra bin/up efter att du har ändrat något i overleaf.rc eller variables.env.

​

Containrar

​

sharelatex

Namn	Beskrivning
PROJECT_NAME	Anger värdet för flaggan --project-name som skickas till docker-compose. Detta är användbart när flera instanser av Overleaf körs på samma värd, eftersom varje instans kan ha ett eget projektnamn. - Standard: overleaf
OVERLEAF_IMAGE_NAME	Docker-avbildningen som används av applikationscontainern för Server Pro/CE. Detta är bara namnet på Docker-avbildningen; taggen för Docker-avbildningen hämtas från config/version. - Standard: - Server Pro: ghcr.io/ayaka-notes/overleaf-pro - Community Edition: sharelatex/sharelatex
SERVER_PRO	När den är satt till true använder Toolkit Server Pro-avbildningen (ghcr.io/ayaka-notes/overleaf-pro) i stället för standardavbildningen för Server CE (sharelatex/sharelatex). - Standard: false
GIT_BRIDGE_ENABLED	Ange true för att aktivera funktionen git-bridge (endast Server Pro). Mer information finns i användardokumentationen https://www.overleaf.com/learn/how-to/Git_integration. - Standard: false
GIT_BRIDGE_IMAGE	Docker-avbildningen som används av git-bridge-containern (endast Server Pro). Detta är bara namnet på Docker-avbildningen; taggen för Docker-avbildningen hämtas från config/version. - Standard: ghcr.io/ayaka-notes/overleaf-pro/git-bridge
GIT_BRIDGE_DATA_PATH	Anger sökvägen till katalogen som monteras i containern git-bridge (endast Server Pro) och används för att lagra git-repositoryn. Detta kan vara antingen en fullständig sökväg (som börjar med /) eller en sökväg relativ till Toolkits baskatalog.
GIT_BRIDGE_LOG_LEVEL	Konfigurerar loggnivån för containern git-bridge. Tillgängliga nivåer: TRACE, DEBUG, INFO, WARN, ERROR. - Standard: INFO
SIBLING_CONTAINERS_ENABLED	När den är satt till true använder Toolkit tekniken Sibling Containers för att kompilera projekt i separata sandlådor, med en separat Docker-container för varje projekt. Se dokumentationen <server-pro-only-configuration/sandboxed-compiles> för mer information. - Kräver: SERVER_PRO=true - Standard: true
SIBLING_CONTAINERS_PULL	När den är satt till true hämtar Toolkit automatiskt alla TeX Live-avbildningar som anges med ALL_TEX_LIVE_DOCKER_IMAGES i filen config/variables.env när kommandot bin/up används. - Standard: true
DOCKER_SOCKET_PATH	Anger sökvägen till Docker-socketen på värddatorn (datorn som kör Toolkit). När SIBLING_CONTAINERS_ENABLED är true monteras socketen i containern så att kompileringstjänsten kan starta nya Docker-containrar på värden. - Kräver: SIBLING_CONTAINERS_ENABLED=true - Standard: /var/run/docker.sock
OVERLEAF_DATA_PATH	Anger sökvägen till katalogen som monteras i huvudcontainern sharelatex och används för att lagra kompileringsdata. Detta kan vara antingen en fullständig sökväg (som börjar med /) eller en sökväg relativ till Toolkits baskatalog. - Standard: data/overleaf
OVERLEAF_LISTEN_IP	Anger den eller de IP-adresser på värden som containern binder till. Om detta till exempel är satt till 0.0.0.0 blir webbgränssnittet tillgängligt på alla värdens IP-adresser. För direkt åtkomst till containern måste OVERLEAF_LISTEN_IP sättas till din offentliga IP-adress. Att sätta OVERLEAF_LISTEN_IP till antingen 0.0.0.0 eller värdens externa IP-adress orsakar vanligtvis fel när det används tillsammans med . - Standard: 127.0.0.1
OVERLEAF_PORT	Anger den port på värden som containern binder till. Om detta till exempel är satt till 8099 och OVERLEAF_LISTEN_IP är satt till 127.0.0.1 blir webbgränssnittet tillgängligt på http://localhost:8099. - Standard: 80
OVERLEAF_LOG_PATH	Anger sökvägen till katalogen som monteras i huvudcontainern sharelatex och används för att göra applikationsloggar tillgängliga på Docker-värden. Detta kan vara antingen en fullständig sökväg (som börjar med /) eller en sökväg relativ till Toolkits baskatalog. Ta bort konfigurationsposten för att inaktivera bind-monteringen. Om den inte är satt kasseras loggarna när containern återskapas. Se för information om loggning. - Standard: not set

---

​

mongo

Namn	Beskrivning
MONGO_ENABLED	När den är satt till true skapar Toolkit en MongoDB-container som är värd för databasen. När den är satt till false skapas inte denna container, och systemet använder i stället den MongoDB-databas som anges i MONGO_URL. - Standard: true
MONGO_URL	Anger den MongoDB-anslutnings-URL som ska användas när MONGO_ENABLED är false. - Standard: inte satt
MONGO_DATA_PATH	Anger sökvägen till katalogen som monteras i containern mongo och används för att lagra MongoDB-databasen. Detta kan vara antingen en fullständig sökväg (som börjar med /) eller en sökväg relativ till Toolkits baskatalog. Det här alternativet påverkar endast den lokala containern mongo som skapas när MONGO_ENABLED är true. - Standard: data/mongo
MONGO_IMAGE	Docker-avbildningen som används av MongoDB-containern. Detta är bara namnet på Docker-avbildningen; taggen för Docker-avbildningen ska anges i MONGO_VERSION (se nedan). - Standard: mongo
MONGO_VERSION	MongoDB-versionen som används av MongoDB-containern. Värdet måste börja med MongoDB:s huvudversion och en punkt, t.ex. 6.0 eller 6.0-with-suffix. - Standard: 6.0

---

​

redis

Namn	Beskrivning
REDIS_ENABLED	När den är satt till true skapar Toolkit en Redis-container som är värd för redis-databasen. När den är satt till false skapas inte denna container, och systemet använder i stället den Redis-databas som anges i REDIS_HOST och REDIS_PORT. - Standard: true
REDIS_HOST	Anger den Redis-värd som ska användas när REDIS_ENABLED är false. - Standard: inte satt
REDIS_PORT	Anger den Redis-port som ska användas när REDIS_ENABLED är false. - Standard: inte satt
REDIS_DATA_PATH	Anger sökvägen till katalogen som monteras i containern redis och används för att lagra Redis-databasen. Detta kan vara antingen en fullständig sökväg (som börjar med /) eller en sökväg relativ till Toolkits baskatalog. Det här alternativet påverkar endast den lokala containern redis som skapas när REDIS_ENABLED är true. - Standard: data/redis
REDIS_AOF_PERSISTENCE	Aktiverar AOF-persistens (Append Only File) för Redis. Detta är den rekommenderade konfigurationen för Redis-persistens. Mer information finns i avsnittet <../../../maintenance/data-and-backups#aof-append-only-file> i <../../maintenance/data-and-backups>. - Standard: true

---

​

nginx

Namn	Beskrivning
NGINX_ENABLED	När den är satt till true skapar Toolkit en NGINX-container som fungerar som TLS-proxy. - Standard: false
NGINX_CONFIG_PATH	Sökväg till den NGINX-konfigurationsfil som ska användas för TLS-proxyn. - Standard: config/nginx/nginx.conf
NGINX_TLS_LISTEN_IP	Anger den eller de IP-adresser på värden som TLS-proxycontainern binder till för HTTPS. Om detta till exempel är satt till 0.0.0.0 blir HTTPS-webbgränssnittet tillgängligt på alla värdens IP-adresser. Vanligtvis bör detta sättas till värdens externa IP-adress. - Standard: 127.0.1.1
NGINX_HTTP_LISTEN_IP	Anger den eller de IP-adresser på värden som TLS-proxycontainern binder till för HTTP-omdirigering. Om detta till exempel är satt till 127.0.1.1 omdirigeras HTTP-anslutningar till 127.0.1.1 till HTTPS-webbgränssnittet. Vanligtvis bör detta sättas till värdens externa IP-adress. Sätt det inte till 0.0.0.0, eftersom det vanligtvis orsakar en konflikt med OVERLEAF_LISTEN_IP. - Standard: 127.0.1.1
NGINX_HTTP_PORT	Anger den port på värden som TLS-proxycontainern binder till för HTTP. - Standard: 80
TLS_PORT	Anger den port på värden som TLS-proxycontainern binder till för HTTPS. - Standard: 443
TLS_PRIVATE_KEY_PATH	Sökväg till den privata nyckel som ska användas för TLS-proxyn. - Standard: config/nginx/certs/overleaf_key.pem
TLS_CERTIFICATE_PATH	Sökväg till det offentliga certifikat som ska användas för TLS-proxyn. - Standard: config/nginx/certs/overleaf_certificate.pem