Persistente data
Overleaf Toolkit skal gemme persistente data, såsom de filer der kræves for at kompilere LaTeX-projekter, og indholdet af MongoDB-databasen. Det opnås ved at montere nogle få mapper fra værtsmaskinen ind i Docker-containerne og skrive data til disse mapper.Datamapper
sharelatex-containeren kræver en mappe, hvor data relateret til LaTeX-kompileringer kan gemmes. Denne mappe angives med variablen OVERLEAF_DATA_PATH i config/overleaf.rc.
mongo-containeren kræver, hvis den er aktiveret, en mappe til sine databasefiler, og det samme gælder for redis-containeren. Disse mapper kan også konfigureres i config/overleaf.rc.
Filrettigheder
Fordi Docker kører somroot, ender datamapperne med at være ejet af brugeren root, selv hvis Toolkit bruges af en bruger, der ikke er root. Det er ikke et problem, men det er værd at være opmærksom på, hvis du har tænkt dig at ændre de persistente data uden for containerne.
Placering af konfigurationsfiler
Alle brugerejede konfigurationsfiler findes i mappenconfig/.
Denne mappe er udelukket fra git-versionsstyringen, så den bliver ikke ændret, når Toolkit-koden opdateres. Toolkit ændrer ikke nogen data i mappen config/ uden din tilladelse.
Ændringer i konfigurationsfilerne anvendes ikke automatisk på eksisterende containere, heller ikke selvom containeren stoppes og genstartes (med
bin/stop og bin/start). For at anvende ændringerne skal du køre bin/up, hvorefter docker compose bag kulisserne automatisk anvender konfigurationsændringerne på en ny container. (Eller kør bin/up -d, hvis du foretrækker ikke at blive tilknyttet Docker-loggene.)Filen overleaf.rc
Filen config/overleaf.rc indeholder de vigtigste overordnede konfigurationsindstillinger, som Toolkit bruger. Den indeholder sætninger, der angiver variabler, i formatet: VARIABLE_NAME=value
Se vores afsnit om indstillinger for en oversigt over alle tilgængelige konfigurationsmuligheder.
Filen variables.env
Filen config/variables.env indeholder miljøvariabler, der indlæses i sharelatex-containeren og bruges til at konfigurere Overleafs mikrotjenester. Det omfatter applikationens navn, som det vises i webgrænsefladens header, indstillinger for afsendelse af e-mails og andre premiumindstillinger såsom SSO til brug med Server Pro.
Se afsnittet Miljøvariabler for en oversigt over alle tilgængelige miljøvariabler.
Filen version
Filen config/version indeholder versionsnummeret på det Docker-image, der bruges til at oprette den kørende instans af din Overleaf-server.
Ændringer i disse konfigurationsfiler anvendes ikke automatisk på eksisterende containere, heller ikke selvom containeren stoppes og genstartes (med
bin/stop og bin/start). For at anvende dine ændringer skal du køre bin/up, hvorefter Toolkit automatisk opretter en ny container til dig med konfigurationsændringerne anvendt.Filen docker-compose.override.yml
Hvis filen config/docker-compose.override.yml findes, bliver den inkluderet, når docker compose kaldes. Det er nyttigt til at tilsidesætte konfiguration, der er specifik for Docker Compose.
Se docker-compose-dokumentationen for flere detaljer.