2. Bli kjent med Toolkit

​

En titt rundt

Nå som du har en lokal kopi av Toolkit, kan vi se på strukturen i repositoriet ved hjelp av kommandoen ls.

Run this

ls -l

Kommandoen ls -l viser en detaljert, lang oppføring av innholdet i en katalog, med tilleggsinformasjon om filene, som tillatelser, eierskap og størrelse.

Hvis alt ble klonet korrekt, skal du se noe lignende 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 konfigurasjonsfiler som eies av brukeren, ligger i katalogen config/. Denne katalogen er utelatt fra git-versjonskontrollen, så den endres ikke når du oppdaterer Toolkit.

​

Oppbygging av repositoriet

Navn	Beskrivelse
bin	Denne mappen inneholder en samling skript som hjelper deg med å administrere Overleaf-serverinstansen din. Du kan lese mer om disse skriptene i avsnittet Kommandoer nedenfor.
config	Denne mappen inneholder dine egne lokale konfigurasjonsfiler.
lib	Denne mappen inneholder grunnleggende konfigurasjonsfiler som brukes av Toolkit.
data	Som standard inneholder denne mappen lagringsplasseringen for MongoDb, Redis og Overleaf. For mer informasjon, se avsnittet Persistente data nedenfor.

Vi anbefaler at du ikke endrer filer utenfor mappen /config direkte. Hvis du trenger å gjøre endringer, kan de i stedet gjøres via miljøvariabler satt i enten config/variables.env eller config/overleaf.rc.
For eksempel, for å angi imaget for mongo-tjenesten, setter du imaget med miljøvariabelen MONGO_IMAGE i config/overleaf.rc i stedet for å redigere lib/docker-compose.mongo.yml direkte. For mer informasjon, se siden Toolkit-innstillinger.

Toolkit vil ikke endre noen data i katalogen config/ uten din tillatelse.

​

Kommandoer

Kjør disse skriptene fra Toolkit-katalogen. Hvert av dem viser alternativene sine med --help.

Kommando	Hva den gjør
bin/init	Oppretter konfigurasjonsfilene i config/ første gang. bin/init --tls legger til konfigurasjonen for NGINX TLS-proxyen.
bin/up	Oppretter og starter containerne (bin/docker-compose up). Legg til -d for å kjøre i bakgrunnen i stedet for å følge loggene. Kjør den etter hver endring i config/: den gjenoppretter containerne der konfigurasjonen er endret.
bin/start	Starter de eksisterende containerne igjen (bin/docker-compose start). Den tar ikke i bruk konfigurasjonsendringer.
bin/stop	Stopper containerne og beholder dem (bin/docker-compose stop).
bin/docker-compose	Kjører docker compose med Toolkits filer, for eksempel bin/docker-compose ps eller bin/docker-compose restart sharelatex.
bin/logs	Viser eller følger loggene til én eller flere tjenester, for eksempel bin/logs -f web.
bin/error-logs	Som bin/logs, men viser bare feilene.
bin/shell	Åpner et skall inne i sharelatex-containeren.
bin/mongo	Åpner et MongoDB-skall på sharelatex-databasen.
bin/run-script	Kjører et skript som følger med inne i sharelatex-containeren.
bin/doctor	Kontrollerer verten og konfigurasjonen, og skriver ut en rapport du kan dele når du ber om hjelp.
bin/images	Viser Overleaf-Docker-imagene på verten.
bin/backup-config	Kopierer katalogen config/ til en sikkerhetskopiplassering (kopi, zip eller tar).
bin/upgrade	Oppdaterer Toolkit og Overleaf-imaget trinn for trinn, se Oppgradere distribusjonen.
bin/rename-env-vars-5-0, bin/rename-rc-vars	Engangsmigreringer av gamle variabelnavn fra SHARELATEX_* til OVERLEAF_*.

Når bin/up gjenoppretter en container, går alt som er endret inne i den tapt, for eksempel pakker som er installert eller filer som er redigert via bin/shell. Bare datakatalogene (data/ som standard) og config/ beholdes. Gjør varige endringer via config/variables.env, config/overleaf.rc eller config/docker-compose.override.yml i stedet.

Hvis hver bin/up logger ut alle brukere, setter du OVERLEAF_SESSION_SECRET. Uten den signeres øktinformasjonskapslene med en hemmelighet som genereres på nytt hver gang containeren gjenopprettes, se spørsmål og svar i Miljøvariabler.