Persistente gegevens
De Overleaf Toolkit moet persistente gegevens opslaan, zoals de bestanden die nodig zijn om LaTeX-projecten te compileren en de inhoud van de MongoDB-database. Dit gebeurt door enkele mappen van de hostmachine in de Docker-containers te mounten en de gegevens naar die mappen te schrijven.Gegevensmappen
De containersharelatex heeft een map nodig om gegevens met betrekking tot LaTeX-compilaties op te slaan. Deze map wordt ingesteld met de variabele OVERLEAF_DATA_PATH in config/overleaf.rc.
De container mongo heeft, als deze is ingeschakeld, een map nodig om zijn databasebestanden op te slaan, en hetzelfde geldt voor de container redis. Deze mappen kunnen ook worden geconfigureerd in config/overleaf.rc.
Bestandsrechten
Omdat Docker alsroot draait, worden de gegevensmappen eigendom van de gebruiker root, zelfs als de Toolkit door een niet-root-gebruiker wordt gebruikt. Dit is geen probleem, maar wel goed om te weten als je de persistente gegevens van buiten de containers wilt wijzigen.
Locatie van de configuratiebestanden
Alle configuratiebestanden die van de gebruiker zijn, staan in de mapconfig/.
Deze map is uitgesloten van het git-versiebeheersysteem, zodat ze niet wordt gewijzigd wanneer je de Toolkit-code bijwerkt. De Toolkit wijzigt geen gegevens in de map config/ zonder jouw toestemming.
Wijzigingen in de configuratiebestanden worden niet automatisch toegepast op bestaande containers, zelfs niet als de container wordt gestopt en opnieuw gestart (met
bin/stop en bin/start). Voer bin/up uit om de wijzigingen toe te passen; achter de schermen past docker compose de configuratiewijzigingen dan automatisch toe op een nieuwe container. (Of voer bin/up -d uit als je liever niet aan de Docker-logs gekoppeld wilt zijn.)Het bestand overleaf.rc
Het bestand config/overleaf.rc bevat de belangrijkste configuratie-instellingen op het hoogste niveau die door de Toolkit worden gebruikt. Het bevat statements die variabelen instellen, in de vorm: VARIABLE_NAME=value
Zie onze sectie over instellingen voor een overzicht van alle beschikbare configuratieopties.
Het bestand variables.env
Het bestand config/variables.env bevat omgevingsvariabelen die in de container sharelatex worden geladen en worden gebruikt om de Overleaf-microservices te configureren. Hieronder vallen de naam van de applicatie zoals die in de header van de webinterface wordt weergegeven, instellingen voor het verzenden van e-mails en andere premium-instellingen zoals SSO voor gebruik met Server Pro.
Zie de sectie Omgevingsvariabelen voor een overzicht van alle beschikbare omgevingsvariabelen.
Het bestand version
Het bestand config/version bevat het versienummer van de Docker-image die wordt gebruikt om de draaiende instantie van je Overleaf-server aan te maken.
Wijzigingen in deze configuratiebestanden worden niet automatisch toegepast op bestaande containers, zelfs niet als de container wordt gestopt en opnieuw gestart (met
bin/stop en bin/start). Voer bin/up uit om je wijzigingen toe te passen; de Toolkit maakt dan automatisch een nieuwe container voor je aan met de toegepaste configuratiewijzigingen.Het bestand docker-compose.override.yml
Als het bestand config/docker-compose.override.yml aanwezig is, wordt het meegenomen bij de aanroep van docker compose. Dit is handig om configuratie die specifiek is voor Docker Compose te overschrijven.
Zie de docker-compose-documentatie voor meer details.