Migracja z docker-compose.yml do Toolkit

Przenieś wdrożenie Overleaf oparte na Docker Compose do Toolkit.

Jeśli obecnie korzystasz z Docker Compose za pomocą pliku docker-compose.yml, migracja do Toolkit może ułatwić wdrażanie, aktualizowanie i utrzymywanie lokalnej (on-premises) wersji Overleaf.

Aby przeprowadzić migrację, musisz przekonwertować istniejącą konfigurację Docker Compose do formatu używanego przez Toolkit. Proces ten polega na skopiowaniu istniejącej konfiguracji do Toolkit.

Ten przewodnik przeprowadzi Cię przez każdy krok tego procesu, zapewniając płynną migrację z Docker Compose do Toolkit.

Te instrukcje dotyczą wersji v4.x i wcześniejszych. Dlatego wszystkie zmienne używają prefiksu SHARELATEX_ zamiast OVERLEAF_.

1. Sklonuj repozytorium Toolkit

   Najpierw sklonuj repozytorium Toolkit na maszynę hosta:

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

   Następnie uruchom polecenie bin/init, aby zainicjować Toolkit z domyślną konfiguracją.

2. Ustawienie obrazu i wersji

   W typowym pliku docker-compose.yml obraz i wersja są zdefiniowane w opisie komponentu, na przykład:

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

   W przypadku Toolkit nazwa obrazu jest rozwiązywana automatycznie; jedynym wymaganiem jest ustawienie SERVER_PRO=true w config/overleaf.rc, aby wybrać obraz Server Pro, lub SERVER_PRO=false, aby użyć Community Edition.

   Żądany numer wersji Server Pro/Community Edition ustawia się w pliku config/version. Toolkit wymaga konkretnego numeru wersji, np. 4.2.3. Jeśli używasz latest, możesz użyć bin/images, aby znaleźć identyfikator obrazu lokalnej wersji latest, a następnie skorzystać z informacji o wydaniach 2.x.x, 3.x.x, 4.x.x lub 5.x.x, aby dopasować identyfikator obrazu do wersji.

   Jeśli pobierasz obraz z własnego wewnętrznego rejestru, możesz nadpisać obraz używany przez Toolkit, ustawiając OVERLEAF_IMAGE_NAME. Nie musisz podawać tagu, ponieważ Toolkit doda go automatycznie na podstawie pliku config/version.

3. Konfiguracja dostępu zewnętrznego

   Domyślnie Overleaf nasłuchuje na 127.0.0.1:80, przyjmując ruch wyłącznie z maszyny hosta Docker.

   Aby zezwolić na dostęp z zewnątrz, ustaw OVERLEAF_LISTEN_IP i OVERLEAF_PORT w pliku config/overleaf.rc.

4. Migracja zmiennych środowiskowych

   Prawdopodobnie masz zestaw zmiennych środowiskowych zdefiniowanych w usłudze sharelatex w pliku docker-compose.yml, na przykład:

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

   Skopiuj te zmienne do pliku config/variables.env w Toolkit, zachowując następującą postać (użyj = zamiast :):

   OVERLEAF_APP_NAME=Overleaf Community Edition
   OVERLEAF_PROXY_LEARN=true
   

   Wyjątki / różnice przy korzystaniu z Toolkit:

   • Zmienne zaczynające się od SANDBOXED_COMPILES_ i DOCKER_RUNNER nie są już potrzebne. Aby włączyć Sandboxed Compiles, ustaw SIBLING_CONTAINERS_ENABLED=true w pliku config/overleaf.rc.
   • Zmienne zaczynające się od OVERLEAF_MONGO_, OVERLEAF_REDIS_ oraz zmienna REDIS_HOST nie są już potrzebne. MongoDB i Redis konfiguruje się teraz w pliku config/overleaf.rc za pomocą MONGO_URL, REDIS_HOST i REDIS_PORT.

   Zaawansowane opcje konfiguracji opisano w dokumentacji config/overleaf.rc.

5. Proxy NGINX

   Instrukcje migracji nginx znajdziesz w dokumentacji TLS Proxy:

6. Wolumeny

   Ustaw lokalizacje wolumenów danych w config/overleaf.rc:

   ​

   ShareLaTeX

   Ustaw OVERLEAF_DATA_PATH na lokalizację wolumenu danych używanego przez kontener sharelatex.

   ​

   MongoDB

   Ustaw MONGO_DATA_PATH na lokalizację wolumenu danych używanego przez kontener mongo.

   ​

   Redis

   Ustaw REDIS_DATA_PATH na lokalizację wolumenu danych używanego przez kontener redis.

Więcej szczegółów i zaawansowaną konfigurację znajdziesz w odpowiedniej dokumentacji konfiguracji Toolkit, do której linki podano powyżej.