Mendapatkan bantuan

​

The Doctor

Overleaf Toolkit dilengkapi dengan skrip doctor yang praktis untuk membantu proses debugging. Jalankan bin/doctor dan skrip akan mencetak informasi tentang lingkungan host Anda, konfigurasi Anda, dan dependensi yang dibutuhkan Toolkit. Output ini juga dapat membantu kami mendiagnosis masalah pada instalasi Ayakaleaf Pro Anda.

Pengguna Overleaf Pro dapat membuka issue di GitHub.

Sebaiknya sertakan output dari skrip bin/doctor dalam pesan Anda.

​

Berkonsultasi dengan Doctor

Jalankan skrip doctor:

Run doctor

bin/doctor

Anda akan melihat output yang mirip dengan contoh di bawah ini.

Contoh output lengkap

====== 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 28.0.4, build b8034c0
    - docker compose
        - status: present
        - version info: Docker Compose version v2.34.0
    - realpath
        - status: present
        - version info: realpath (GNU coreutils) 8.32
    - perl
        - status: present
        - version info: 5.034000
    - awk
        - status: present
        - version info: mawk 1.3.4 20200120
- Docker Daemon
    - status: up
====== Configuration ======
- config/version
    - status: present
    - version: 5.4.0
- config/overleaf.rc
    - status: present
    - values
        - OVERLEAF_DATA_PATH: data/overleaf
        - OVERLEAF_LOG_PATH: data/overleaf/logs
        - SERVER_PRO: true
        - SIBLING_CONTAINERS_ENABLED: true
            - logged in to quay.io: true
        - MONGO_ENABLED: true
        - REDIS_ENABLED: true
- config/variables.env
    - status: present
    - values
        - OVERLEAF_FILESTORE_BACKEND: fs
        - OVERLEAF_HISTORY_BACKEND: fs

====== Warnings ======
- None, all good
====== End ======

​

Informasi Host

Bagian Host Information berisi informasi tentang mesin yang menjalankan Toolkit (misalnya, distribusi dan rilis Linux).

Contoh output Host Information

- 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

​

Dependensi

Bagian Dependencies mencantumkan alat-alat yang dibutuhkan agar Toolkit dapat berfungsi. Jika sebuah alat tersedia, alat tersebut akan dicantumkan sebagai status: present beserta info versinya. Jika tidak ada, alat tersebut akan dicantumkan sebagai status: MISSING! dan sebuah peringatan akan ditambahkan di bagian bawah output doctor.

Contoh output Dependency (tersedia)

- docker
    - status: present
    - version info: Docker version 28.0.4, build b8034c0

Contoh output Dependency (tidak ada)

- docker
    - status: MISSING!

Jika ada dependensi yang tidak tersedia, Toolkit hampir pasti tidak akan berfungsi.

​

Konfigurasi

Bagian Configuration berisi informasi tentang file-file di direktori config/. Untuk config/overleaf.rc, doctor mencetak beberapa nilai penting. File yang tidak ada akan dicantumkan sebagai status: MISSING! dan sebuah peringatan akan ditambahkan di bagian bawah output doctor.

Contoh output Configuration

====== Configuration ======
- config/version
    - status: present
    - version: 5.4.0
- config/overleaf.rc
    - status: present
    - values
        - OVERLEAF_DATA_PATH: /tmp/overleaf
        - SERVER_PRO: false
        - MONGO_ENABLED: false
        - REDIS_ENABLED: true
- config/variables.env
    - status: MISSING!

Catatan dari contoh di atas:

• OVERLEAF_DATA_PATH yang diatur ke /tmp/overleaf mungkin bukan lokasi yang aman untuk data penting.
• MONGO_ENABLED: false berarti Toolkit tidak akan menyediakan MongoDB sendiri; pastikan MONGO_URL mengarah ke MongoDB yang dikelola secara eksternal jika diperlukan.
• config/variables.env tidak ada dalam contoh tersebut.

​

Peringatan

Bagian Warnings merangkum masalah yang ditemukan oleh skrip doctor. Jika tidak ada masalah, bagian ini akan menunjukkannya.

Contoh output Warnings

====== Warnings ======
- configuration file variables.env not found
- rc file, OVERLEAF_DATA_PATH not set
====== End =======