docker-compose.yml'den Toolkit'e geçiş

Bir Overleaf Docker Compose kurulumunu Toolkit’e taşıyın.

Şu anda bir docker-compose.yml dosyası aracılığıyla Docker Compose kullanıyorsanız, Toolkit’e geçmek Overleaf’in şirket içi sürümünü dağıtmayı, yükseltmeyi ve bakımını yapmayı kolaylaştırabilir.

Geçiş için mevcut Docker Compose kurulumunuzu Toolkit’in kullandığı biçime dönüştürmeniz gerekir. Bu süreç, mevcut yapılandırmanın Toolkit’e kopyalanmasını içerir.

Bu kılavuz, Docker Compose’dan Toolkit’e sorunsuz bir geçiş sağlamak için sürecin her adımında size yol gösterecektir.

Bu talimatlar v4.x ve önceki sürümler içindir. Bu nedenle tüm değişkenler OVERLEAF_ yerine SHARELATEX_ önekini kullanır.

1. Toolkit deposunu klonlayın

   Önce Toolkit deposunu ana makineye klonlayın:

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

   Ardından Toolkit’i varsayılan yapılandırmasıyla başlatmak için bin/init komutunu çalıştırın.

2. İmajı ve sürümü ayarlama

   Tipik bir docker-compose.yml dosyasında imaj ve sürüm bileşen tanımında belirtilir, örneğin:

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

   Toolkit kullanılırken imaj adı otomatik olarak çözümlenir; tek gereksinim, Server Pro imajını seçmek için config/overleaf.rc dosyasında SERVER_PRO=true, Community Edition’ı kullanmak için ise SERVER_PRO=false ayarını yapmaktır.

   İstenen Server Pro/Community Edition sürüm numarası config/version dosyasında ayarlanır. Toolkit, 4.2.3 gibi belirli bir sürüm numarası gerektirir. latest kullanıyorsanız, yerel latest sürümünüzün imaj kimliğini bulmak için bin/images komutunu kullanabilir, ardından imaj kimliğini sürümle eşleştirmek için 2.x.x, 3.x.x, 4.x.x veya 5.x.x sürüm notlarını kullanabilirsiniz.

   İmajı kendi dahili kayıt defterinizden alıyorsanız, OVERLEAF_IMAGE_NAME değerini ayarlayarak Toolkit’in kullandığı imajı geçersiz kılabilirsiniz. Etiketi belirtmeniz gerekmez; Toolkit bunu config/version dosyanıza göre otomatik olarak ekler.

3. Harici erişimi yapılandırma

   Varsayılan olarak Overleaf 127.0.0.1:80 adresini dinler ve yalnızca Docker ana makinesinden gelen trafiğe izin verir.

   Harici erişime izin vermek için config/overleaf.rc dosyasında OVERLEAF_LISTEN_IP ve OVERLEAF_PORT değerlerini ayarlayın.

4. Ortam değişkenlerinin taşınması

   Büyük olasılıkla docker-compose.yml dosyanızdaki sharelatex hizmetinde tanımlanmış bir dizi ortam değişkeniniz vardır, örneğin:

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

   Bu değişkenleri aşağıdaki biçimde olacak şekilde (: yerine = kullanarak) Toolkit’in config/variables.env dosyasına kopyalayın:

   OVERLEAF_APP_NAME=Overleaf Community Edition
   OVERLEAF_PROXY_LEARN=true
   

   Toolkit kullanılırken istisnalar / farklılıklar:

   • SANDBOXED_COMPILES_ ve DOCKER_RUNNER ile başlayan değişkenlere artık gerek yoktur. Sandboxed Compiles’ı etkinleştirmek için config/overleaf.rc dosyanızda SIBLING_CONTAINERS_ENABLED=true ayarını yapın.
   • OVERLEAF_MONGO_, OVERLEAF_REDIS_ ile başlayan değişkenlere ve REDIS_HOST değişkenine artık gerek yoktur. MongoDB ve Redis artık config/overleaf.rc dosyasında MONGO_URL, REDIS_HOST ve REDIS_PORT kullanılarak yapılandırılır.

   Gelişmiş yapılandırma seçenekleri için config/overleaf.rc dokümantasyonuna bakın.

5. NGINX Proxy

   nginx’in nasıl taşınacağına ilişkin talimatlar için TLS Proxy dokümantasyonuna bakın:

6. Birimler

   Veri birimlerinin konumlarını config/overleaf.rc dosyasında ayarlayın:

   ​

   ShareLaTeX

   OVERLEAF_DATA_PATH değerini sharelatex kapsayıcısının kullandığı veri biriminin konumuna ayarlayın.

   ​

   MongoDB

   MONGO_DATA_PATH değerini mongo kapsayıcısının kullandığı veri biriminin konumuna ayarlayın.

   ​

   Redis

   REDIS_DATA_PATH değerini redis kapsayıcısının kullandığı veri biriminin konumuna ayarlayın.

Daha fazla ayrıntı ve gelişmiş yapılandırma için yukarıda bağlantısı verilen ilgili Toolkit yapılandırma belgelerine başvurun.