Tiedostot ja sijainnit

Tällä sivulla kuvataan konfiguraatiotiedostot, joita Toolkit käyttää Overleafin paikallisen käyttöönoton määrittämiseen.

​

Pysyvä data

Overleaf Toolkitin on tallennettava pysyvää dataa, kuten LaTeX-projektien kääntämiseen tarvittavat tiedostot ja MongoDB-tietokannan sisältö. Tämä toteutetaan liittämällä isäntäkoneelta muutama hakemisto Docker-kontteihin ja kirjoittamalla data näihin hakemistoihin.

​

Datahakemistot

sharelatex-kontti tarvitsee hakemiston, johon tallennetaan LaTeX-käännöksiin liittyvää dataa. Tämä hakemisto asetetaan muuttujalla OVERLEAF_DATA_PATH tiedostossa config/overleaf.rc.

mongo-kontti tarvitsee, jos se on käytössä, hakemiston tietokantatiedostojensa tallentamiseen, ja sama pätee redis-konttiin. Myös nämä hakemistot voidaan määrittää tiedostossa config/overleaf.rc.

​

Tiedostojen käyttöoikeudet

Koska Docker toimii root-käyttäjänä, datahakemistot päätyvät root-käyttäjän omistukseen, vaikka Toolkitia käyttäisi muu kuin root-käyttäjä. Tämä ei ole ongelma, mutta se on hyvä tietää, jos aiot muokata pysyvää dataa konttien ulkopuolelta.

​

Konfiguraatiotiedostojen sijainti

Kaikki käyttäjän omistamat konfiguraatiotiedostot löytyvät hakemistosta config/.

Tämä hakemisto on suljettu pois git-versionhallinnasta, joten Toolkitin koodin päivittäminen ei muuta sitä. Toolkit ei muuta mitään config/-hakemiston dataa ilman lupaasi.

Konfiguraatiotiedostojen muutoksia ei sovelleta automaattisesti olemassa oleviin kontteihin, vaikka kontti pysäytettäisiin ja käynnistettäisiin uudelleen (komennoilla bin/stop ja bin/start). Ota muutokset käyttöön suorittamalla bin/up, jolloin docker compose soveltaa konfiguraatiomuutokset automaattisesti uuteen konttiin. (Tai suorita bin/up -d, jos et halua liittyä Dockerin lokeihin.)

​

overleaf.rc-tiedosto

Tiedosto config/overleaf.rc sisältää Toolkitin tärkeimmät ylätason konfiguraatioasetukset. Se sisältää muuttujia asettavia lausekkeita muodossa: VARIABLE_NAME=value

Erittelyn kaikista käytettävissä olevista konfiguraatiovaihtoehdoista löydät asetuksia käsittelevästä osiostamme.

​

variables.env-tiedosto

Tiedosto config/variables.env sisältää ympäristömuuttujat, jotka ladataan sharelatex-konttiin ja joilla määritetään Overleafin mikropalvelut. Näihin kuuluvat sovelluksen nimi, joka näytetään verkkokäyttöliittymän ylätunnisteessa, sähköpostien lähetysasetukset sekä muut premium-asetukset, kuten SSO Server Pron kanssa käytettäväksi.

Erittelyn kaikista käytettävissä olevista ympäristömuuttujista löydät osiosta Ympäristömuuttujat.

​

version-tiedosto

Tiedosto config/version sisältää sen Docker-imagen versionumeron, jota käytetään Overleaf-palvelimesi käynnissä olevan instanssin luomiseen.

Näiden konfiguraatiotiedostojen muutoksia ei sovelleta automaattisesti olemassa oleviin kontteihin, vaikka kontti pysäytettäisiin ja käynnistettäisiin uudelleen (komennoilla bin/stop ja bin/start). Ota muutokset käyttöön suorittamalla bin/up, jolloin Toolkit luo sinulle automaattisesti uuden kontin, johon konfiguraatiomuutokset on sovellettu.

​

docker-compose.override.yml-tiedosto

Jos tiedosto config/docker-compose.override.yml on olemassa, se sisällytetään docker compose -kutsuun. Tämä on hyödyllistä Docker Composeen liittyvän konfiguraation ohittamisessa.

Lisätietoja on docker-compose-dokumentaatiossa.