Siirtyminen docker-compose.yml-tiedostosta Toolkitiin

Siirrä Overleafin Docker Compose -käyttöönotto Toolkitiin.

Jos käytät tällä hetkellä Docker Composea docker-compose.yml-tiedoston kautta, siirtyminen Toolkitiin voi helpottaa paikallisesti asennetun Overleafin käyttöönottoa, päivittämistä ja ylläpitoa.

Siirtyäksesi sinun on muunnettava nykyinen Docker Compose -kokoonpanosi Toolkitin käyttämään muotoon. Tähän kuuluu olemassa olevien määritysten kopioiminen Toolkitiin.

Tämä opas käy läpi prosessin jokaisen vaiheen ja varmistaa sujuvan siirtymisen Docker Composesta Toolkitiin.

Nämä ohjeet koskevat versioita v4.x ja sitä aiempia. Siksi kaikissa muuttujissa käytetään SHARELATEX_-etuliitettä OVERLEAF_-etuliitteen sijaan.

1. Kloonaa Toolkit-tietovarasto

   Kloonaa ensin Toolkit-tietovarasto isäntäkoneelle:

   git clone https://github.com/overleaf/toolkit.git ./overleaf-toolkit
   

   Suorita seuraavaksi bin/init-komento alustaaksesi Toolkitin oletusmäärityksellä.

2. Kuvan ja version asettaminen

   Tyypillisessä docker-compose.yml-tiedostossa kuva ja versio määritellään komponentin kuvauksessa, esimerkiksi:

   version: '2.2'
   services:
       sharelatex:
           restart: always
           # Server Pro users:
           # image: quay.io/sharelatex/sharelatex-pro
           image: sharelatex/sharelatex:3.5.13
   

   Toolkitia käytettäessä kuvan nimi selvitetään automaattisesti; ainoa vaatimus on asettaa config/overleaf.rc-tiedostoon SERVER_PRO=true, jos haluat käyttää Server Pro -kuvaa, tai SERVER_PRO=false, jos haluat käyttää Community Editionia.

   Haluttu Server Pron/Community Editionin versionumero asetetaan config/version-tiedostoon. Toolkit vaatii tarkan versionumeron, kuten 4.2.3. Jos käytät latest-versiota, voit selvittää paikallisen latest-versiosi kuvatunnisteen komennolla bin/images ja sitten yhdistää kuvatunnisteen versioon versioiden 2.x.x, 3.x.x, 4.x.x tai 5.x.x julkaisutietojen avulla.

   Jos haet kuvan omasta sisäisestä rekisteristäsi, voit ohittaa Toolkitin käyttämän kuvan asettamalla OVERLEAF_IMAGE_NAME-muuttujan. Tagia ei tarvitse määrittää, sillä Toolkit lisää sen automaattisesti config/version-tiedostosi perusteella.

3. Ulkoisen pääsyn määrittäminen

   Oletuksena Overleaf kuuntelee osoitetta 127.0.0.1:80 ja sallii liikenteen vain Docker-isäntäkoneelta.

   Salliaksesi ulkoisen pääsyn aseta OVERLEAF_LISTEN_IP ja OVERLEAF_PORT tiedostossa config/overleaf.rc.

4. Ympäristömuuttujien siirtäminen

   Sinulla on todennäköisesti joukko ympäristömuuttujia määriteltynä docker-compose.yml-tiedostosi sharelatex-palvelussa, esimerkiksi:

   environment:
       OVERLEAF_APP_NAME: Overleaf Community Edition
       OVERLEAF_PROXY_LEARN: 'true'
       …
   

   Kopioi nämä muuttujat Toolkitin tiedostoon config/variables.env seuraavassa muodossa (käytä = merkin : sijaan):

   OVERLEAF_APP_NAME=Overleaf Community Edition
   OVERLEAF_PROXY_LEARN=true
   

   Poikkeukset ja erot Toolkitia käytettäessä:

   • SANDBOXED_COMPILES_- ja DOCKER_RUNNER-alkuisia muuttujia ei enää tarvita. Ota Sandboxed Compiles käyttöön asettamalla SIBLING_CONTAINERS_ENABLED=true config/overleaf.rc-tiedostoon.
   • OVERLEAF_MONGO_- ja OVERLEAF_REDIS_-alkuisia muuttujia sekä REDIS_HOST-muuttujaa ei enää tarvita. MongoDB ja Redis määritetään nyt config/overleaf.rc-tiedostossa muuttujilla MONGO_URL, REDIS_HOST ja REDIS_PORT.

   Lisämääritysvaihtoehdot löydät config/overleaf.rc -dokumentaatiosta.

5. NGINX-välityspalvelin

   Ohjeet nginx-palvelun siirtämiseen löydät TLS-välityspalvelimen dokumentaatiosta:

6. Taltiot

   Aseta datataltioiden sijainnit config/overleaf.rc-tiedostoon:

   ​

   ShareLaTeX

   Aseta OVERLEAF_DATA_PATH osoittamaan sharelatex-kontin käyttämän datataltion sijaintiin.

   ​

   MongoDB

   Aseta MONGO_DATA_PATH osoittamaan mongo-kontin käyttämän datataltion sijaintiin.

   ​

   Redis

   Aseta REDIS_DATA_PATH osoittamaan redis-kontin käyttämän datataltion sijaintiin.

Lisätietoja ja lisämäärityksiä löydät yllä linkitetyistä Toolkitin määritysdokumenteista.