Filer och platser

Den här sidan beskriver de konfigurationsfiler som Toolkit använder för att konfigurera din lokala driftsättning av Overleaf.

​

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

Containern sharelatex 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 som root 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 katalogen config/.

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 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 premiuminställningar som SSO för användning med Server Pro.

En genomgång av alla tillgängliga miljövariabler finns i avsnittet Miljövariabler.

​

Filen 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.

Mer information finns i dokumentationen för docker-compose.