> For the complete documentation index, see [llms.txt](https://ayakaleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ayakaleaf-pro.ayaka.space/on-premises/id/memulai/what-is-the-overleaf-toolkit.md). # Apa itu Ayakaleaf Toolkit? Toolkit ayakaleaf adalah metode penerapan yang direkomendasikan untuk instalasi on-premises Community Edition, Ayakaleaf Pro, dan dirancang untuk bekerja dengan lingkungan yang paling umum: satu server fisik atau mesin virtual. Toolkit menggunakan `docker compose` untuk mengelola kontainer Docker server Anda dan menyediakan sekumpulan skrip yang membungkus `docker` perintah untuk membantu sisi yang lebih teknis dalam mengelola versi on-premises Overleaf. #### Skrip `bin/docker-compose` pembungkus Skrip `bin/docker-compose` adalah skrip pembungkus untuk `docker compose`. Skrip ini memuat konfigurasi dari `config/` direktori, sebelum menjalankan `docker compose` dengan argumen apa pun yang diteruskan ke skrip. Anda dapat menganggap `bin/docker-compose` sebagai pembungkus transparan untuk `docker compose` program yang terpasang di mesin Anda. Contoh: {% code title="Periksa kontainer yang sedang berjalan" %} ```bash $ bin/docker-compose ps ``` {% endcode %} #### Bantuan 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`: membuka shell di dalam **sharelatex** kontainer * `bin/doctor`: skrip yang digunakan untuk mengumpulkan informasi instalasi dan penerapan. Lihat bagian "Memeriksa server Anda" di bawah * `bin/mongo`: membuka shell di dalam **mongo** kontainer dan beralih ke basis data 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 log layanan * `bin/error-logs`: melihat/mengikuti log kesalahan layanan * `bin/rename-env-vars-5-0`: skrip migrasi untuk memperbarui variabel lingkungan di **config/variables.env** (rebranding dari ShareLaTeX ke Overleaf) * `bin/rename-rc-vars`: skrip migrasi untuk memperbarui variabel lingkungan di **config/overleaf.rc** (rebranding dari ShareLaTeX ke Overleaf) * `bin/run-script`: alat bantu untuk mempermudah menjalankan skrip yang disimpan di dalam **sharelatex** kontainer * `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/penyalinan layanan Docker. Lihat Meningkatkan deployment Anda untuk informasi lebih lanjut: {% hint style="info" %} Jika Anda lebih suka menjalankan instance Anda tanpa menautkan ke log Docker, Anda dapat menjalankan `bin/up -d` untuk berjalan dalam mode terpisah. {% endhint %} #### Memeriksa server Anda Overleaf Toolkit menyertakan skrip praktis bernama `bin/doctor` yang menghasilkan laporan yang menunjuk ke dependensi apa pun yang belum terpenuhi. Sebelum melanjutkan, jalankan `bin/doctor` skrip dan periksa bahwa semuanya berfungsi dengan benar: {% code title="Jalankan Overleaf Doctor" %} ```bash bin/doctor ``` {% endcode %} Contoh keluaran (dipotong/ilustratif):
Contoh keluaran dari bin/doctor ``` ====== Overleaf Doctor ====== - Informasi Host - Linux - Keluaran dari 'lsb_release -a': Tidak ada modul LSB yang tersedia. Distributor ID: Ubuntu Deskripsi: Ubuntu 22.04.5 LTS Rilis: 22.04 Nama kode: jammy - Dependensi - bash - status: tersedia - informasi versi: 5.1.16(1)-release - docker - status: tersedia - informasi versi: Docker version 27.3.1, build ce12230 - realpath - status: tersedia - informasi versi: realpath (GNU coreutils) 8.32 - perl - status: tersedia - informasi versi: 5.034000 - awk - status: tersedia - informasi versi: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1) - openssl - status: tersedia - informasi versi: OpenSSL 3.0.2 15 Mar 2022 (Library: OpenSSL 3.0.2 15 Mar 2022) - docker compose - status: tersedia - informasi versi: Docker Compose version v2.29.7 - Docker Daemon - status: aktif ====== Konfigurasi ====== - config/version - status: tersedia - version: 5.1.1 - config/overleaf.rc - status: tersedia - nilai - 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: tersedia - nilai - OVERLEAF_FILESTORE_BACKEND: fs - OVERLEAF_HISTORY_BACKEND: fs ====== Peringatan ====== - Tidak ada, semuanya baik ====== Akhir ====== ```
Jika ada dependensi yang hilang, doctor akan menampilkan peringatan. Jika Anda mengalami masalah, pertama jalankan `bin/doctor` dan periksa keluarannya untuk melihat peringatan. {% hint style="info" %} * Pengguna Ayakaleaf Pro Edition dapat membuka issue di GitHub: Dalam kedua kasus, sertakan keluaran dari `bin/doctor` di pesan Anda. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://ayakaleaf-pro.ayaka.space/on-premises/id/memulai/what-is-the-overleaf-toolkit.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.