Nhận trợ giúp

​

Doctor

Overleaf Toolkit đi kèm một script doctor tiện dụng để hỗ trợ gỡ lỗi. Chạy bin/doctor và script sẽ in ra thông tin về môi trường máy host, cấu hình của bạn và các phụ thuộc mà Toolkit cần. Kết quả này cũng có thể giúp chúng tôi chẩn đoán sự cố cho các bản cài đặt Ayakaleaf Pro của bạn.

Người dùng Overleaf Pro có thể mở issue trên GitHub.

Bạn nên đính kèm kết quả đầu ra của script bin/doctor trong tin nhắn của mình.

​

Tham khảo ý kiến Doctor

Chạy script doctor:

Run doctor

bin/doctor

Bạn sẽ thấy kết quả tương tự như ví dụ dưới đây.

Ví dụ kết quả đầy đủ

====== 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 ======

​

Thông tin máy host

Phần Host Information chứa thông tin về máy đang chạy Toolkit (ví dụ: bản phân phối Linux và phiên bản phát hành).

Ví dụ kết quả 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

​

Phụ thuộc

Phần Dependencies liệt kê các công cụ cần thiết để Toolkit hoạt động. Nếu một công cụ có mặt, nó sẽ được liệt kê với status: present kèm thông tin phiên bản. Nếu thiếu, nó sẽ được liệt kê với status: MISSING! và một cảnh báo sẽ được thêm vào cuối kết quả của doctor.

Ví dụ kết quả Dependency (có mặt)

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

Ví dụ kết quả Dependency (bị thiếu)

- docker
    - status: MISSING!

Nếu thiếu bất kỳ phụ thuộc nào, gần như chắc chắn Toolkit sẽ không hoạt động.

​

Cấu hình

Phần Configuration chứa thông tin về các tệp trong thư mục config/. Đối với config/overleaf.rc, doctor sẽ in ra một số giá trị quan trọng. Các tệp bị thiếu sẽ được liệt kê với status: MISSING! và một cảnh báo sẽ được thêm vào cuối kết quả của doctor.

Ví dụ kết quả 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!

Ghi chú từ ví dụ trên:

• OVERLEAF_DATA_PATH được đặt là /tmp/overleaf có thể không phải là vị trí an toàn cho dữ liệu quan trọng.
• MONGO_ENABLED: false nghĩa là Toolkit sẽ không tự cấp phát MongoDB; hãy đảm bảo MONGO_URL trỏ đến một MongoDB được quản lý bên ngoài nếu cần.
• config/variables.env bị thiếu trong ví dụ.

​

Cảnh báo

Phần Warnings tóm tắt các vấn đề được script doctor phát hiện. Nếu không có vấn đề nào, phần này sẽ cho biết điều đó.

Ví dụ kết quả Warnings

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