Toolkit-indstillinger

Denne side beskriver de miljøvariabler, der understøttes i filen config/overleaf.rc ved Toolkit-udrulninger.

Filen config/overleaf.rc består af variabeldefinitioner i formen NAME=value. Linjer, der begynder med #, behandles som kommentarer.

Det er nødvendigt at genoprette Docker-containerne ved at køre bin/up, efter at du har ændret noget i overleaf.rc eller variables.env.

​

Container

​

sharelatex

Navn	Beskrivelse
PROJECT_NAME	Sætter værdien af flaget --project-name, der gives til docker-compose. Det er nyttigt, når der kører flere Overleaf-instanser på én vært, da hver instans kan have sit eget projektnavn. - Standard: overleaf
OVERLEAF_IMAGE_NAME	Docker-image, der bruges af Server Pro/CE-applikationscontaineren. Dette er kun navnet på Docker-imaget; Docker-image-tagget hentes fra config/version. - Standard: - Server Pro: ghcr.io/ayaka-notes/overleaf-pro - Community Edition: sharelatex/sharelatex
SERVER_PRO	Når den er sat til true, får Toolkit besked på at bruge Server Pro-imaget (ghcr.io/ayaka-notes/overleaf-pro) i stedet for standard-Server CE-imaget (sharelatex/sharelatex). - Standard: false
GIT_BRIDGE_ENABLED	Sæt til true for at aktivere git-bridge-funktionen (kun Server Pro). Se brugerdokumentationen https://www.overleaf.com/learn/how-to/Git_integration for flere oplysninger. - Standard: false
GIT_BRIDGE_IMAGE	Docker-image, der bruges af git-bridge-containeren (kun Server Pro). Dette er kun navnet på Docker-imaget; Docker-image-tagget hentes fra config/version. - Standard: ghcr.io/ayaka-notes/overleaf-pro/git-bridge
GIT_BRIDGE_DATA_PATH	Sætter stien til den mappe, der monteres i git-bridge-containeren (kun Server Pro) og bruges til at gemme git-repositorierne. Det kan enten være en fuld sti (der begynder med /) eller en sti relativ til Toolkits basismappe.
GIT_BRIDGE_LOG_LEVEL	Konfigurerer logniveauet for git-bridge-containeren. Tilgængelige niveauer: TRACE, DEBUG, INFO, WARN, ERROR. - Standard: INFO
SIBLING_CONTAINERS_ENABLED	Når den er sat til true, får Toolkit besked på at bruge teknikken Sibling Containers til at kompilere projekter i separate sandboxes med en separat Docker-container for hvert projekt. Se dokumentationen <server-pro-only-configuration/sandboxed-compiles> for flere oplysninger. - Kræver: SERVER_PRO=true - Standard: true
SIBLING_CONTAINERS_PULL	Når den er sat til true, får Toolkit besked på automatisk at hente alle TeX Live-images, der er angivet med ALL_TEX_LIVE_DOCKER_IMAGES i filen config/variables.env, når kommandoen bin/up bruges. - Standard: true
DOCKER_SOCKET_PATH	Sætter stien til Docker-socket på værtsmaskinen (den maskine, der kører Toolkit). Når SIBLING_CONTAINERS_ENABLED er true, monteres socket i containeren, så kompileringstjenesten kan starte nye Docker-containere på værten. - Kræver: SIBLING_CONTAINERS_ENABLED=true - Standard: /var/run/docker.sock
OVERLEAF_DATA_PATH	Sætter stien til den mappe, der monteres i hovedcontaineren sharelatex og bruges til at gemme kompileringsdata. Det kan enten være en fuld sti (der begynder med /) eller en sti relativ til Toolkits basismappe. - Standard: data/overleaf
OVERLEAF_LISTEN_IP	Sætter den eller de IP-adresser på værten, som containeren binder til. Hvis den f.eks. er sat til 0.0.0.0, vil webgrænsefladen være tilgængelig på alle værtens IP-adresser. Ved direkte adgang til containeren skal værdien af OVERLEAF_LISTEN_IP sættes til din offentlige IP-adresse. Hvis OVERLEAF_LISTEN_IP sættes til enten 0.0.0.0 eller værtens eksterne IP, vil det typisk give fejl, når den bruges sammen med . - Standard: 127.0.0.1
OVERLEAF_PORT	Sætter den port på værten, som containeren binder til. Hvis den f.eks. er sat til 8099, og OVERLEAF_LISTEN_IP er sat til 127.0.0.1, vil webgrænsefladen være tilgængelig på http://localhost:8099. - Standard: 80
OVERLEAF_LOG_PATH	Sætter stien til den mappe, der monteres i hovedcontaineren sharelatex og bruges til at gøre applikationslogfiler tilgængelige på Docker-værten. Det kan enten være en fuld sti (der begynder med /) eller en sti relativ til Toolkits basismappe. Fjern konfigurationsposten for at deaktivere bind-mounten. Hvis den ikke er sat, kasseres logfilerne, når containeren genoprettes. Se for oplysninger om logning. - Standard: ikke sat

---

​

mongo

Navn	Beskrivelse
MONGO_ENABLED	Når den er sat til true, får Toolkit besked på at oprette en MongoDB-container til databasen. Når den er sat til false, oprettes denne container ikke, og systemet bruger i stedet den MongoDB-database, der er angivet med MONGO_URL. - Standard: true
MONGO_URL	Angiver den MongoDB-forbindelses-URL, der skal bruges, når MONGO_ENABLED er false. - Standard: ikke sat
MONGO_DATA_PATH	Sætter stien til den mappe, der monteres i mongo-containeren og bruges til at gemme MongoDB-databasen. Det kan enten være en fuld sti (der begynder med /) eller en sti relativ til toolkittets basismappe. Denne indstilling påvirker kun den lokale mongo-container, der oprettes, når MONGO_ENABLED er true. - Standard: data/mongo
MONGO_IMAGE	Docker-image, der bruges af MongoDB-containeren. Dette er kun navnet på Docker-imaget; Docker-image-tagget skal angives i MONGO_VERSION (se nedenfor). - Standard: mongo
MONGO_VERSION	MongoDB-version, der bruges af MongoDB-containeren. Værdien skal begynde med MongoDB-hovedversionen og et punktum, f.eks. 6.0 eller 6.0-with-suffix. - Standard: 6.0

---

​

redis

Navn	Beskrivelse
REDIS_ENABLED	Når den er sat til true, får Toolkit besked på at oprette en Redis-container til Redis-databasen. Når den er sat til false, oprettes denne container ikke, og systemet bruger i stedet den Redis-database, der er angivet med REDIS_HOST og REDIS_PORT. - Standard: true
REDIS_HOST	Angiver den Redis-vært, der skal bruges, når REDIS_ENABLED er false. - Standard: ikke sat
REDIS_PORT	Angiver den Redis-port, der skal bruges, når REDIS_ENABLED er false. - Standard: ikke sat
REDIS_DATA_PATH	Sætter stien til den mappe, der monteres i redis-containeren og bruges til at gemme Redis-databasen. Det kan enten være en fuld sti (der begynder med /) eller en sti relativ til Toolkits basismappe. Denne indstilling påvirker kun den lokale redis-container, der oprettes, når REDIS_ENABLED er true. - Standard: data/redis
REDIS_AOF_PERSISTENCE	Slår AOF-persistens (Append Only File) til for Redis. Dette er den anbefalede konfiguration for Redis-persistens. Se afsnittet <../../../maintenance/data-and-backups#aof-append-only-file> i <../../maintenance/data-and-backups> for flere detaljer. - Standard: true

---

​

nginx

Navn	Beskrivelse
NGINX_ENABLED	Når den er sat til true, får Toolkit besked på at oprette en NGINX-container, der fungerer som TLS-proxy. - Standard: false
NGINX_CONFIG_PATH	Sti til den NGINX-konfigurationsfil, der skal bruges til TLS-proxyen. - Standard: config/nginx/nginx.conf
NGINX_TLS_LISTEN_IP	Sætter den eller de IP-adresser på værten, som TLS-proxycontaineren binder til for HTTPS. Hvis den f.eks. er sat til 0.0.0.0, vil HTTPS-webgrænsefladen være tilgængelig på alle værtens IP-adresser. Typisk bør den sættes til værtens eksterne IP. - Standard: 127.0.1.1
NGINX_HTTP_LISTEN_IP	Sætter den eller de IP-adresser på værten, som TLS-proxycontaineren binder til for HTTP-omdirigering. Hvis den f.eks. er sat til 127.0.1.1, vil HTTP-forbindelser til 127.0.1.1 blive omdirigeret til HTTPS-webgrænsefladen. Typisk bør den sættes til værtens eksterne IP. Sæt den ikke til 0.0.0.0, da det typisk vil give en konflikt med OVERLEAF_LISTEN_IP. - Standard: 127.0.1.1
NGINX_HTTP_PORT	Sætter den port på værten, som TLS-proxycontaineren binder til for HTTP. - Standard: 80
TLS_PORT	Sætter den port på værten, som TLS-proxycontaineren binder til for HTTPS. - Standard: 443
TLS_PRIVATE_KEY_PATH	Sti til den private nøgle, der skal bruges til TLS-proxyen. - Standard: config/nginx/certs/overleaf_key.pem
TLS_CERTIFICATE_PATH	Sti til det offentlige certifikat, der skal bruges til TLS-proxyen. - Standard: config/nginx/certs/overleaf_certificate.pem