Beständiga data
Overleaf Toolkit behöver lagra beständiga data, till exempel de filer som krävs för att kompilera LaTeX-projekt och innehållet i MongoDB-databasen. Detta åstadkoms genom att några kataloger från värddatorn monteras i Docker-containrarna och data skrivs till dessa kataloger.Datakataloger
Containernsharelatex kräver en katalog där data som rör LaTeX-kompileringar lagras. Katalogen anges med variabeln OVERLEAF_DATA_PATH i config/overleaf.rc.
Containern mongo kräver, om den är aktiverad, en katalog där dess databasfiler lagras, och detsamma gäller för containern redis. Även dessa kataloger kan konfigureras i config/overleaf.rc.
Filbehörigheter
Eftersom Docker körs somroot kommer datakatalogerna att ägas av användaren root, även om Toolkit används av en användare som inte är root. Detta är inget problem, men det är bra att känna till om du tänker ändra beständiga data utanför containrarna.
Konfigurationsfilernas plats
Alla konfigurationsfiler som ägs av användaren finns i katalogenconfig/.
Den här katalogen är undantagen från versionshanteringssystemet git, så den ändras inte när Toolkit-koden uppdateras. Toolkit ändrar inte några data i katalogen config/ utan ditt tillstånd.
Ändringar i konfigurationsfilerna tillämpas inte automatiskt på befintliga containrar, inte ens om containern stoppas och startas om (med
bin/stop och bin/start). Kör bin/up för att tillämpa ändringarna, så tillämpar docker compose automatiskt konfigurationsändringarna på en ny container i bakgrunden. (Eller kör bin/up -d om du föredrar att inte ansluta till Docker-loggarna.)Filen config/overleaf.rc
Filen config/overleaf.rc innehåller de viktigaste konfigurationsinställningarna på toppnivå som Toolkit använder. Den innehåller satser som sätter variabler i formatet: VARIABLE_NAME=value
En genomgång av alla tillgängliga konfigurationsalternativ finns i vårt avsnitt om inställningar.
Filen variables.env
Filen config/variables.env innehåller miljövariabler som läses in i containern sharelatex och används för att konfigurera Overleafs mikrotjänster. Dessa omfattar bland annat applikationens namn som visas i webbgränssnittets sidhuvud, inställningar för att skicka e-post och andra inställningar som SSO.
En genomgång av alla tillgängliga miljövariabler finns i avsnittet Miljövariabler.
Filen config/version
Filen config/version innehåller versionsnumret för den Docker-avbild som används för att skapa den körande instansen av din Overleaf-server.
Ändringar i dessa konfigurationsfiler tillämpas inte automatiskt på befintliga containrar, inte ens om containern stoppas och startas om (med
bin/stop och bin/start). Kör bin/up för att tillämpa dina ändringar, så skapar Toolkit automatiskt en ny container åt dig med konfigurationsändringarna tillämpade.Filen docker-compose.override.yml
Om filen config/docker-compose.override.yml finns inkluderas den i anropet till docker compose. Det är användbart för att åsidosätta konfiguration som är specifik för Docker Compose.
config/variables.env läses inte in i containrarna mongo och redis. För att sätta en miljövariabel där lägger du till den här och kör bin/up -d, till exempel:
Frågor och svar
Vilket filsystem ska datakatalogerna använda? Kan jag använda btrfs, copy-on-write eller zstd-komprimering?
Vilket filsystem ska datakatalogerna använda? Kan jag använda btrfs, copy-on-write eller zstd-komprimering?
Svar: Toolkit kontrollerar inte filsystemet. Det är MongoDB som har krav, så valet spelar störst roll för
data/mongo (MONGO_DATA_PATH). MongoDB:s produktionsanteckningar anger att XFS eller ext4 ska användas på Linux och rekommenderar starkt XFS med WiredTiger, den lagringsmotor som används. De tar inte upp btrfs eller andra copy-on-write-filsystem. Om ditt rotfilsystem är btrfs kan du montera en XFS-volym och peka MONGO_DATA_PATH till den. Filsystemet måste också stödja fsync() på kataloger, vilket HGFS och delade mappar i VirtualBox inte gör.Filsystemkomprimering sparar lite för data/mongo: WiredTiger komprimerar redan samlingar med snappy och index med prefixkomprimering. För NFS, se Felsökning.
