2. Maak kennis met de Toolkit

​

Rondkijken

Nu je een lokale kopie van de Toolkit hebt, gaan we de structuur van de repository bekijken met de opdracht ls.

Run this

ls -l

De opdracht ls -l toont een gedetailleerde, uitgebreide lijstweergave van de inhoud van een map, met aanvullende bestandsinformatie zoals rechten, eigenaarschap en grootte.

Als alles succesvol is gekloond, zou je iets als het volgende moeten zien:

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 configuratiebestanden die van de gebruiker zijn, staan in de map config/. Deze map is uitgesloten van het git-versiebeheersysteem, zodat deze niet wordt gewijzigd bij het bijwerken van de Toolkit.

​

Indeling van de repository

Naam	Beschrijving
bin	Deze map bevat een verzameling scripts waarmee je je Overleaf-serverinstantie kunt beheren. Je kunt meer over deze scripts lezen in onze sectie Opdrachten hieronder.
config	Deze map bevat je eigen lokale configuratiebestanden.
lib	Deze map bevat basisconfiguratiebestanden die door de Toolkit worden gebruikt.
data	Standaard bevat deze map de opslaglocatie voor MongoDb, Redis en Overleaf. Zie de sectie Persistente gegevens hieronder voor meer informatie.

We raden aan om bestanden buiten de map /config niet rechtstreeks te wijzigen. Als je wijzigingen moet aanbrengen, kun je dat in plaats daarvan doen via omgevingsvariabelen die zijn ingesteld in config/variables.env of config/overleaf.rc.
Om bijvoorbeeld de image van de mongo-service in te stellen, bewerk je niet rechtstreeks lib/docker-compose.mongo.yml, maar stel je de image in met de omgevingsvariabele MONGO_IMAGE in config/overleaf.rc. Zie de pagina Toolkit-instellingen voor meer informatie.

De Toolkit wijzigt geen gegevens in de map config/ zonder jouw toestemming.

​

Commando’s

Voer deze scripts uit vanuit de Toolkit-map. Elk script toont zijn opties met --help.

Commando	Wat het doet
bin/init	Maakt de eerste keer de configuratiebestanden in config/ aan. bin/init --tls voegt de configuratie voor de NGINX TLS-proxy toe.
bin/up	Maakt de containers aan en start ze (bin/docker-compose up). Voeg -d toe om ze op de achtergrond te draaien in plaats van de logs te volgen. Voer het uit na elke wijziging in config/: het maakt de containers waarvan de configuratie is gewijzigd opnieuw aan.
bin/start	Start de bestaande containers opnieuw (bin/docker-compose start). Past geen configuratiewijzigingen toe.
bin/stop	Stopt de containers en behoudt ze (bin/docker-compose stop).
bin/docker-compose	Voert docker compose uit met de bestanden van de Toolkit, bijvoorbeeld bin/docker-compose ps of bin/docker-compose restart sharelatex.
bin/logs	Toont of volgt de logs van een of meer services, bijvoorbeeld bin/logs -f web.
bin/error-logs	Zoals bin/logs, maar toont alleen de fouten.
bin/shell	Opent een shell in de container sharelatex.
bin/mongo	Opent een MongoDB-shell op de database sharelatex.
bin/run-script	Voert een script uit dat in de container sharelatex wordt meegeleverd.
bin/doctor	Controleert de host en de configuratie, en drukt een rapport af dat je kunt delen wanneer je om hulp vraagt.
bin/images	Toont de Overleaf-Docker-images op de host.
bin/backup-config	Kopieert de map config/ naar een back-uplocatie (kopie, zip of tar).
bin/upgrade	Werkt de Toolkit en het Overleaf-image stap voor stap bij, zie Je deployment upgraden.
bin/rename-env-vars-5-0, bin/rename-rc-vars	Eenmalige migraties van oude SHARELATEX_*-variabelenamen naar OVERLEAF_*.

Wanneer bin/up een container opnieuw aanmaakt, gaat alles wat daarin is gewijzigd verloren, bijvoorbeeld pakketten die zijn geïnstalleerd of bestanden die zijn bewerkt via bin/shell. Alleen de datamappen (standaard data/) en config/ blijven behouden. Breng blijvende wijzigingen in plaats daarvan aan via config/variables.env, config/overleaf.rc of config/docker-compose.override.yml.

Als elke bin/up alle gebruikers uitlogt, stel dan OVERLEAF_SESSION_SECRET in. Zonder deze variabele worden de sessiecookies ondertekend met een geheim dat opnieuw wordt gegenereerd telkens wanneer de container opnieuw wordt aangemaakt, zie de Vragen en antwoorden in Omgevingsvariabelen.