Filer og plasseringer

Denne siden beskriver konfigurasjonsfilene som Toolkit bruker til å konfigurere den lokale Overleaf-installasjonen din.

​

Persistente data

Overleaf Toolkit må lagre persistente data, for eksempel filene som kreves for å kompilere LaTeX-prosjekter og innholdet i MongoDB-databasen. Dette oppnås ved å montere noen kataloger fra vertsmaskinen inn i Docker-containerne og skrive dataene til disse katalogene.

​

Datakataloger

sharelatex-containeren trenger en katalog for å lagre data knyttet til LaTeX-kompileringer. Denne katalogen angis med variabelen OVERLEAF_DATA_PATH i config/overleaf.rc.

mongo-containeren trenger, hvis den er aktivert, en katalog for å lagre databasefilene sine, og det samme gjelder redis-containeren. Disse katalogene kan også konfigureres i config/overleaf.rc.

​

Filtillatelser

Fordi Docker kjører som root, vil datakatalogene ende opp med å eies av brukeren root, selv om Toolkit brukes av en bruker som ikke er root. Dette er ikke et problem, men det er verdt å være klar over hvis du har tenkt å endre de persistente dataene utenfra containerne.

​

Plassering av konfigurasjonsfiler

Alle konfigurasjonsfiler som eies av brukeren, ligger i katalogen config/.

Denne katalogen er ekskludert fra versjonskontrollsystemet git, så den blir ikke endret når Toolkit-koden oppdateres. Toolkit vil ikke endre noen data i katalogen config/ uten din tillatelse.

Endringer i konfigurasjonsfilene blir ikke automatisk tatt i bruk i eksisterende containere, selv om containeren stoppes og startes på nytt (med bin/stop og bin/start). For å ta i bruk endringene kjører du bin/up, og i bakgrunnen vil docker compose automatisk bruke konfigurasjonsendringene på en ny container. (Eller kjør bin/up -d hvis du foretrekker å ikke koble deg til Docker-loggene.)

​

Filen overleaf.rc

Filen config/overleaf.rc inneholder de viktigste konfigurasjonsinnstillingene på øverste nivå som Toolkit bruker. Den inneholder setninger som setter variabler, i formatet: VARIABLE_NAME=value

For en oversikt over alle tilgjengelige konfigurasjonsalternativer, se innstillingsdelen vår.

​

Filen variables.env

Filen config/variables.env inneholder miljøvariabler som lastes inn i sharelatex-containeren og brukes til å konfigurere Overleaf-mikrotjenestene. Disse omfatter navnet på applikasjonen slik det vises i toppteksten i webgrensesnittet, innstillinger for sending av e-post og andre premium-innstillinger, som SSO for bruk med Server Pro.

For en oversikt over alle tilgjengelige miljøvariabler, se delen Miljøvariabler.

​

Filen version

Filen config/version inneholder versjonsnummeret til Docker-imaget som skal brukes til å opprette den kjørende instansen av Overleaf-serveren din.

Endringer i disse konfigurasjonsfilene blir ikke automatisk tatt i bruk i eksisterende containere, selv om containeren stoppes og startes på nytt (med bin/stop og bin/start). For å ta i bruk endringene kjører du bin/up, så oppretter Toolkit automatisk en ny container med konfigurasjonsendringene tatt i bruk.

​

Filen docker-compose.override.yml

Hvis filen config/docker-compose.override.yml finnes, blir den inkludert når docker compose kalles. Dette er nyttig for å overstyre konfigurasjon som er spesifikk for Docker Compose.

Se dokumentasjonen for docker-compose for flere detaljer.