2. Bekanta dig med Toolkit

​

En titt runt omkring

Nu när du har en lokal kopia av Toolkit tar vi en titt på repositoryts struktur med kommandot ls.

Run this

ls -l

Kommandot ls -l visar en detaljerad lång listning av innehållet i en katalog, med ytterligare filinformation såsom behörigheter, ägarskap och storlek.

Om allt klonades korrekt bör du se något liknande detta:

drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 bin
-rw-r--r-- 1 fry fry  6465 Aug 30 14:16 CHANGELOG.md
drwxr-xr-x 2 fry fry  4096 Sep  6 12:43 config
drwxr-xr-x 5 fry fry  4096 Aug 30 14:22 data
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 doc
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 lib
-rw-r--r-- 1 fry fry 34520 Aug 30 14:16 LICENSE
-rw-r--r-- 1 fry fry  1178 Aug 30 14:16 README.md

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

​

Repositoryts struktur

Namn	Beskrivning
bin	Den här mappen innehåller en samling skript som hjälper dig att hantera din Overleaf-serverinstans. Du kan läsa mer om skripten i avsnittet Kommandon nedan.
config	Den här mappen innehåller dina egna lokala konfigurationsfiler.
lib	Den här mappen innehåller baskonfigurationsfiler som används av Toolkit.
data	Som standard innehåller den här mappen lagringsplatsen för MongoDb, Redis och Overleaf. Mer information finns i avsnittet Persistent data nedan.

Vi rekommenderar att du inte ändrar filer utanför mappen /config direkt. Om du behöver göra ändringar kan de i stället göras via miljövariabler som anges i antingen config/variables.env eller config/overleaf.rc.
Om du till exempel vill ange avbildningen för tjänsten mongo ska du, i stället för att redigera lib/docker-compose.mongo.yml direkt, ange avbildningen med miljövariabeln MONGO_IMAGE i config/overleaf.rc. Mer information finns på sidan Toolkit-inställningar.

Toolkit ändrar inte några data i katalogen config/ utan ditt tillstånd.

​

Kommandon

Kör dessa skript från Toolkit-katalogen. Vart och ett skriver ut sina alternativ med --help.

Kommando	Vad det gör
bin/init	Skapar konfigurationsfilerna i config/ första gången. bin/init --tls lägger till konfigurationen för NGINX TLS-proxyn.
bin/up	Skapar och startar containrarna (bin/docker-compose up). Lägg till -d för att köra i bakgrunden i stället för att följa loggarna. Kör det efter varje ändring i config/: det återskapar de containrar vars konfiguration har ändrats.
bin/start	Startar de befintliga containrarna igen (bin/docker-compose start). Det tillämpar inte konfigurationsändringar.
bin/stop	Stoppar containrarna och behåller dem (bin/docker-compose stop).
bin/docker-compose	Kör docker compose med Toolkits filer, till exempel bin/docker-compose ps eller bin/docker-compose restart sharelatex.
bin/logs	Visar eller följer loggarna för en eller flera tjänster, till exempel bin/logs -f web.
bin/error-logs	Som bin/logs, men visar bara felen.
bin/shell	Öppnar ett skal i containern sharelatex.
bin/mongo	Öppnar ett MongoDB-skal mot databasen sharelatex.
bin/run-script	Kör ett skript som levereras i containern sharelatex.
bin/doctor	Kontrollerar värden och konfigurationen och skriver ut en rapport som du kan dela när du ber om hjälp.
bin/images	Listar Overleafs Docker-images på värden.
bin/backup-config	Kopierar katalogen config/ till en plats för säkerhetskopior (kopia, zip eller tar).
bin/upgrade	Uppdaterar Toolkit och Overleaf-imagen steg för steg, se Uppgradera din driftsättning.
bin/rename-env-vars-5-0, bin/rename-rc-vars	Engångsmigreringar av gamla variabelnamn SHARELATEX_* till OVERLEAF_*.

När bin/up återskapar en container går allt som ändrats i den förlorat, till exempel paket som installerats eller filer som redigerats via bin/shell. Endast datakatalogerna (data/ som standard) och config/ behålls. Gör bestående ändringar via config/variables.env, config/overleaf.rc eller config/docker-compose.override.yml i stället.

Om varje bin/up loggar ut alla användare anger du OVERLEAF_SESSION_SECRET. Utan den signeras sessionscookies med en hemlighet som genereras på nytt varje gång containern återskapas, se Frågor och svar i Miljövariabler.