Migrasi dari docker-compose.yml ke Toolkit

Migrasikan deployment Overleaf berbasis Docker Compose ke Toolkit.

Jika saat ini Anda menggunakan Docker Compose melalui file docker-compose.yml, bermigrasi ke Toolkit dapat membuat versi on-premises Overleaf lebih mudah di-deploy, di-upgrade, dan dipelihara.

Untuk bermigrasi, Anda perlu mengonversi penyiapan Docker Compose yang ada ke format yang digunakan oleh Toolkit. Proses ini melibatkan penyalinan konfigurasi yang ada ke dalam Toolkit.

Panduan ini akan memandu Anda melalui setiap langkah proses ini, sehingga migrasi dari Docker Compose ke Toolkit berjalan lancar.

Instruksi ini ditujukan untuk v4.x dan versi sebelumnya. Oleh karena itu, semua variabel menggunakan awalan SHARELATEX_ alih-alih OVERLEAF_.

1. Clone repositori Toolkit

   Pertama, clone repositori Toolkit ke mesin host:

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

   Selanjutnya, jalankan perintah bin/init untuk menginisialisasi Toolkit dengan konfigurasi default-nya.

2. Mengatur image dan versi

   Dalam docker-compose.yml yang umum, image dan versi didefinisikan dalam deskripsi komponen, misalnya:

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

   Saat menggunakan Toolkit, nama image di-resolve secara otomatis; satu-satunya persyaratan adalah mengatur SERVER_PRO=true di config/overleaf.rc untuk memilih image Server Pro atau SERVER_PRO=false untuk menggunakan Community Edition.

   Nomor versi Server Pro/Community Edition yang diinginkan diatur di file config/version. Toolkit memerlukan nomor versi spesifik seperti 4.2.3. Jika Anda menggunakan latest, Anda dapat menggunakan bin/images untuk menemukan image id dari versi latest lokal Anda, lalu menggunakan catatan rilis untuk 2.x.x, 3.x.x, 4.x.x, atau 5.x.x untuk mencocokkan image id dengan versinya.

   Jika Anda mengambil image dari registry internal Anda sendiri, Anda dapat menimpa image yang digunakan Toolkit dengan mengatur OVERLEAF_IMAGE_NAME. Anda tidak perlu menentukan tag karena Toolkit akan menambahkannya secara otomatis berdasarkan file config/version Anda.

3. Mengonfigurasi akses eksternal

   Secara default, Overleaf akan mendengarkan di 127.0.0.1:80, yang hanya mengizinkan lalu lintas dari mesin host Docker.

   Untuk mengizinkan akses eksternal, atur OVERLEAF_LISTEN_IP dan OVERLEAF_PORT di file config/overleaf.rc.

4. Migrasi variabel lingkungan

   Kemungkinan Anda memiliki sekumpulan variabel lingkungan yang didefinisikan di layanan sharelatex dalam docker-compose.yml Anda, misalnya:

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

   Salin variabel-variabel ini ke file config/variables.env milik Toolkit, dengan memastikan format berikut (gunakan = alih-alih :):

   OVERLEAF_APP_NAME=Overleaf Community Edition
   OVERLEAF_PROXY_LEARN=true
   

   Pengecualian / perbedaan saat menggunakan Toolkit:

   • Variabel yang diawali dengan SANDBOXED_COMPILES_ dan DOCKER_RUNNER tidak lagi diperlukan. Untuk mengaktifkan Sandboxed Compiles, atur SIBLING_CONTAINERS_ENABLED=true di file config/overleaf.rc Anda.
   • Variabel yang diawali dengan OVERLEAF_MONGO_, OVERLEAF_REDIS_, serta variabel REDIS_HOST tidak lagi diperlukan. MongoDB dan Redis kini dikonfigurasi di file config/overleaf.rc menggunakan MONGO_URL, REDIS_HOST, dan REDIS_PORT.

   Untuk opsi konfigurasi lanjutan, lihat dokumentasi config/overleaf.rc.

5. Proxy NGINX

   Untuk instruksi cara memigrasikan nginx, lihat dokumentasi TLS Proxy:

6. Volume

   Atur lokasi volume data di config/overleaf.rc:

   ​

   ShareLaTeX

   Atur OVERLEAF_DATA_PATH ke lokasi volume data yang digunakan oleh container sharelatex.

   ​

   MongoDB

   Atur MONGO_DATA_PATH ke lokasi volume data yang digunakan oleh container mongo.

   ​

   Redis

   Atur REDIS_DATA_PATH ke lokasi volume data yang digunakan oleh container redis.

Untuk detail lebih lanjut dan konfigurasi lanjutan, lihat dokumentasi konfigurasi Toolkit terkait yang ditautkan di atas.