2. Bliv fortrolig med Toolkit

​

Et kig rundt

Nu hvor du har en lokal kopi af Toolkit, så lad os se på repositoriets struktur ved hjælp af kommandoen ls.

Run this

ls -l

Kommandoen ls -l viser en detaljeret, lang oversigt over indholdet i en mappe med yderligere filoplysninger som rettigheder, ejerskab og størrelse.

Hvis alt blev klonet korrekt, bør du se noget i stil med dette:

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

Alle brugerejede konfigurationsfiler findes i mappen config/. Denne mappe er udelukket fra git-versionsstyringen, så den bliver ikke ændret, når Toolkit opdateres.

​

Repositoriets opbygning

Navn	Beskrivelse
bin	Denne mappe indeholder en samling scripts, der hjælper dig med at administrere din Overleaf-serverinstans. Du kan læse mere om disse scripts i afsnittet Kommandoer nedenfor.
config	Denne mappe indeholder dine egne lokale konfigurationsfiler.
lib	Denne mappe indeholder de grundlæggende konfigurationsfiler, som Toolkit bruger.
data	Som standard indeholder denne mappe lagerplaceringen for MongoDb, Redis og Overleaf. Se afsnittet Persistente data nedenfor for at få flere oplysninger.

Vi anbefaler, at du ikke ændrer filer uden for mappen /config direkte. Hvis du har brug for at foretage ændringer, kan de i stedet laves via miljøvariabler, der sættes i enten config/variables.env eller config/overleaf.rc.
Hvis du for eksempel vil angive imaget til mongo-tjenesten, skal du i stedet for at redigere lib/docker-compose.mongo.yml direkte angive imaget med miljøvariablen MONGO_IMAGE i config/overleaf.rc. Se siden Toolkit-indstillinger for at få flere oplysninger.

Toolkit ændrer ikke nogen data i mappen config/ uden din tilladelse.

​

Kommandoer

Kør disse scripts fra Toolkit-mappen. Hvert script viser sine indstillinger med --help.

Kommando	Hvad den gør
bin/init	Opretter konfigurationsfilerne i config/ første gang. bin/init --tls tilføjer konfigurationen til NGINX TLS-proxyen.
bin/up	Opretter og starter containerne (bin/docker-compose up). Tilføj -d for at køre i baggrunden i stedet for at følge logfilerne. Kør den efter hver ændring i config/: den genopretter de containere, hvis konfiguration er ændret.
bin/start	Starter de eksisterende containere igen (bin/docker-compose start). Den anvender ikke konfigurationsændringer.
bin/stop	Stopper containerne og beholder dem (bin/docker-compose stop).
bin/docker-compose	Kører docker compose med Toolkits filer, for eksempel bin/docker-compose ps eller bin/docker-compose restart sharelatex.
bin/logs	Viser eller følger logfilerne for en eller flere tjenester, for eksempel bin/logs -f web.
bin/error-logs	Som bin/logs, men viser kun fejlene.
bin/shell	Åbner en shell i sharelatex-containeren.
bin/mongo	Åbner en MongoDB-shell på databasen sharelatex.
bin/run-script	Kører et script, der følger med i sharelatex-containeren.
bin/doctor	Kontrollerer værten og konfigurationen og udskriver en rapport, som du kan dele, når du beder om hjælp.
bin/images	Viser Overleaf-Docker-imagesne på værten.
bin/backup-config	Kopierer mappen config/ til en backupplacering (copy, zip eller tar).
bin/upgrade	Opdaterer Toolkit og Overleaf-imaget trin for trin, se Opgradering af din udrulning.
bin/rename-env-vars-5-0, bin/rename-rc-vars	Engangsmigreringer af gamle SHARELATEX_*-variabelnavne til OVERLEAF_*.

Når bin/up genopretter en container, går alt, der er ændret inde i den, tabt, for eksempel pakker installeret eller filer redigeret via bin/shell. Kun datamapperne (data/ som standard) og config/ bevares. Foretag i stedet varige ændringer via config/variables.env, config/overleaf.rc eller config/docker-compose.override.yml.

Hvis hver bin/up logger alle brugere ud, skal du sætte OVERLEAF_SESSION_SECRET. Uden den signeres sessionscookies med en hemmelighed, der genereres igen, hver gang containeren genoprettes, se spørgsmål og svar i Miljøvariabler.