2. Tutustu Toolkitiin

​

Katsaus ympäristöön

Nyt kun sinulla on paikallinen kopio Toolkitista, tarkastellaan repositorion rakennetta ls-komennolla.

Run this

ls -l

ls -l-komento näyttää hakemiston sisällön yksityiskohtaisena pitkänä listauksena ja antaa lisätietoja tiedostoista, kuten käyttöoikeudet, omistajan ja koon.

Jos kloonaus onnistui, näet jotain tämänkaltaista:

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

Kaikki käyttäjän omistamat määritystiedostot löytyvät config/-hakemistosta. Tämä hakemisto on suljettu pois git-versionhallinnasta, joten Toolkitin päivittäminen ei muuta sitä.

​

Repositorion rakenne

Nimi	Kuvaus
bin	Tämä kansio sisältää joukon skriptejä, jotka auttavat hallitsemaan Overleaf-palvelininstanssiasi. Voit lukea näistä skripteistä lisää alla olevasta Komennot-osiosta.
config	Tämä kansio sisältää omat paikalliset määritystiedostosi.
lib	Tämä kansio sisältää Toolkitin käyttämät perusmääritystiedostot.
data	Oletuksena tämä kansio on MongoDb:n, Redisin ja Overleafin tallennussijainti. Lisätietoja on alla olevassa Pysyvät tiedot -osiossa.

Suosittelemme, että /config-kansion ulkopuolisia tiedostoja ei muuteta suoraan. Jos sinun on tehtävä muutoksia, ne voidaan tehdä ympäristömuuttujilla, jotka asetetaan joko tiedostossa config/variables.env tai config/overleaf.rc.
Jos esimerkiksi haluat asettaa mongo-palvelun imagen, älä muokkaa tiedostoa lib/docker-compose.mongo.yml suoraan, vaan aseta image ympäristömuuttujalla MONGO_IMAGE tiedostossa config/overleaf.rc. Lisätietoja on sivulla Toolkitin asetukset.

Toolkit ei muuta mitään config/-hakemiston tietoja ilman lupaasi.

​

Komennot

Aja nämä skriptit Toolkit-hakemistosta. Kukin niistä tulostaa vaihtoehtonsa valitsimella --help.

Komento	Mitä se tekee
bin/init	Luo konfiguraatiotiedostot hakemistoon config/ ensimmäisellä kerralla. bin/init --tls lisää NGINX TLS -välityspalvelimen konfiguraation.
bin/up	Luo ja käynnistää kontit (bin/docker-compose up). Lisää -d, jos haluat ajaa ne taustalla lokien seuraamisen sijaan. Aja se jokaisen config/-hakemistoon tehdyn muutoksen jälkeen: se luo uudelleen kontit, joiden konfiguraatio on muuttunut.
bin/start	Käynnistää olemassa olevat kontit uudelleen (bin/docker-compose start). Se ei ota konfiguraatiomuutoksia käyttöön.
bin/stop	Pysäyttää kontit ja säilyttää ne (bin/docker-compose stop).
bin/docker-compose	Ajaa docker compose -komennon Toolkitin tiedostoilla, esimerkiksi bin/docker-compose ps tai bin/docker-compose restart sharelatex.
bin/logs	Näyttää tai seuraa yhden tai useamman palvelun lokeja, esimerkiksi bin/logs -f web.
bin/error-logs	Kuten bin/logs, mutta näyttää vain virheet.
bin/shell	Avaa komentotulkin sharelatex-kontin sisällä.
bin/mongo	Avaa MongoDB-komentotulkin sharelatex-tietokantaan.
bin/run-script	Ajaa sharelatex-kontin mukana toimitetun skriptin.
bin/doctor	Tarkistaa isännän ja konfiguraation ja tulostaa raportin, jonka voit jakaa pyytäessäsi apua.
bin/images	Luettelee isännän Overleaf-Docker-imaget.
bin/backup-config	Kopioi config/-hakemiston varmuuskopiosijaintiin (kopiona, zip- tai tar-tiedostona).
bin/upgrade	Päivittää Toolkitin ja Overleaf-imagen vaihe vaiheelta, katso Käyttöönoton päivittäminen.
bin/rename-env-vars-5-0, bin/rename-rc-vars	Kertaluonteiset siirrot vanhoista SHARELATEX_*-muuttujanimistä muotoon OVERLEAF_*.

Kun bin/up luo kontin uudelleen, kaikki sen sisällä tehdyt muutokset menetetään, esimerkiksi bin/shell-komennon kautta asennetut paketit tai muokatut tiedostot. Vain datahakemistot (oletuksena data/) ja config/ säilyvät. Tee pysyvät muutokset sen sijaan tiedostojen config/variables.env, config/overleaf.rc tai config/docker-compose.override.yml kautta.

Jos jokainen bin/up kirjaa kaikki käyttäjät ulos, aseta OVERLEAF_SESSION_SECRET. Ilman sitä istuntoevästeet allekirjoitetaan salaisuudella, joka luodaan uudelleen aina, kun kontti luodaan uudelleen, katso kysymykset ja vastaukset sivulla Ympäristömuuttujat.