Apa itu Ayakaleaf Toolkit?

Ayakaleaf toolkit adalah metode deployment yang direkomendasikan untuk instalasi on-premises Community Edition dan Ayakaleaf Pro. Toolkit ini dirancang untuk bekerja pada lingkungan yang paling umum: satu server fisik atau mesin virtual. Toolkit menggunakan docker compose untuk mengelola kontainer Docker di server Anda dan menyediakan serangkaian skrip yang membungkus perintah docker untuk membantu aspek teknis dalam mengelola versi on-premises Overleaf.

Wrapper bin/docker-compose

Skrip bin/docker-compose adalah wrapper untuk docker compose. Skrip ini memuat konfigurasi dari direktori config/, sebelum memanggil docker compose dengan argumen apa pun yang diberikan ke skrip tersebut.

Anda dapat memperlakukan bin/docker-compose sebagai wrapper transparan untuk program docker compose yang terinstal di mesin Anda.

Contoh:

Check running containers

$ bin/docker-compose ps

Skrip bantu praktis

Selain bin/docker-compose, Toolkit menyediakan skrip praktis untuk membantu tugas-tugas umum:

• bin/up: pintasan untuk bin/docker-compose up
• bin/start: pintasan untuk bin/docker-compose start
• bin/stop: pintasan untuk bin/docker-compose stop
• bin/shell: memulai shell di dalam kontainer sharelatex
• bin/doctor: skrip yang digunakan untuk mengumpulkan informasi instalasi dan deployment. Lihat bagian “Memeriksa server Anda” di bawah
• bin/mongo: memulai shell di dalam kontainer mongo dan beralih ke database yang benar (sharelatex)
• bin/backup-config: membuat salinan (zip atau tar) dari konfigurasi Anda saat ini dan menyimpannya di direktori tujuan pilihan Anda
• bin/logs: melihat/mengikuti (tail) log layanan
• bin/error-logs: melihat/mengikuti (tail) log error layanan
• bin/rename-env-vars-5-0: skrip migrasi untuk memperbarui variabel lingkungan di config/variables.env (perubahan merek dari ShareLaTeX ke Overleaf)
• bin/rename-rc-vars: skrip migrasi untuk memperbarui variabel lingkungan di config/overleaf.rc (perubahan merek dari ShareLaTeX ke Overleaf)
• bin/run-script: skrip bantu untuk menyederhanakan menjalankan skrip yang tersimpan di dalam kontainer sharelatex
• bin/upgrade: membantu peningkatan instance. Skrip ini akan memeriksa pembaruan Toolkit (melalui git) dan menawarkan untuk menarik perubahan, memeriksa versi image Docker terbaru dan menawarkan untuk memperbaruinya. Skrip ini menyediakan konfirmasi langkah demi langkah, opsi untuk mencadangkan konfigurasi saat ini, dan menangani penghentian/memulai layanan Docker. Lihat Upgrading your deployment untuk informasi lebih lanjut: https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment

Jika Anda lebih suka menjalankan instance tanpa menempel ke log Docker, Anda dapat menjalankan bin/up -d untuk berjalan dalam mode detached.

Memeriksa server Anda

Overleaf Toolkit menyertakan skrip praktis bernama bin/doctor yang menghasilkan laporan yang menunjukkan dependensi apa pun yang belum terpenuhi.

Sebelum melanjutkan, jalankan skrip bin/doctor dan periksa apakah semuanya berfungsi dengan benar:

Run Overleaf Doctor

bin/doctor

Contoh keluaran (dipotong/ilustratif):

Contoh keluaran dari bin/doctor

====== Overleaf Doctor ======
- Host Information
    - Linux
    - Output of 'lsb_release -a':
            No LSB modules are available.
            Distributor ID:     Ubuntu
            Description:        Ubuntu 22.04.5 LTS
            Release:    22.04
            Codename:   jammy
- Dependencies
    - bash
        - status: present
        - version info: 5.1.16(1)-release
    - docker
        - status: present
        - version info: Docker version 27.3.1, build ce12230
    - realpath
        - status: present
        - version info: realpath (GNU coreutils) 8.32
    - perl
        - status: present
        - version info: 5.034000
    - awk
        - status: present
        - version info: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1)
    - openssl
        - status: present
        - version info: OpenSSL 3.0.2 15 Mar 2022 (Library: OpenSSL 3.0.2 15 Mar 2022)
    - docker compose
        - status: present
        - version info: Docker Compose version v2.29.7
- Docker Daemon
    - status: up
====== Configuration ======
- config/version
    - status: present
    - version: 5.1.1
- config/overleaf.rc
    - status: present
    - values
        - OVERLEAF_DATA_PATH: data/overleaf
        - OVERLEAF_LOG_PATH: data/overleaf/logs
        - SERVER_PRO: true
            - logged in to quay.io: true
        - SIBLING_CONTAINERS_ENABLED: true
        - OVERLEAF_LISTEN_IP: 0.0.0.0
        - OVERLEAF_PORT: 80
        - MONGO_ENABLED: true
        - MONGO_IMAGE: mongo
        - MONGO_VERSION: 6.0
        - MONGO_DATA_PATH: data/mongo
        - REDIS_ENABLED: true
        - REDIS_IMAGE: redis:6.2
        - REDIS_DATA_PATH: data/redis
- config/variables.env
    - status: present
    - values
        - OVERLEAF_FILESTORE_BACKEND: fs
        - OVERLEAF_HISTORY_BACKEND: fs
====== Warnings ======
- None, all good
====== End ======

Jika ada dependensi yang hilang, doctor akan menampilkan peringatan. Jika Anda mengalami masalah, jalankan bin/doctor terlebih dahulu dan periksa keluarannya untuk melihat peringatan.

• Pengguna Ayakaleaf Pro Edition dapat membuka issue di GitHub: https://github.com/ayaka-notes/toolkit/issues

Dalam kedua kasus, sertakan keluaran bin/doctor dalam pesan Anda.