도움 받기

​

Doctor

Overleaf Toolkit에는 디버깅에 유용한 doctor 스크립트가 포함되어 있습니다. bin/doctor를 실행하면 호스트 환경, 구성, Toolkit에 필요한 의존성에 대한 정보가 출력됩니다. 이 출력은 Ayakaleaf Pro 설치의 문제를 진단하는 데에도 도움이 됩니다.

Overleaf Pro 사용자는 GitHub에 이슈를 등록할 수 있습니다.

메시지에 bin/doctor 스크립트의 출력을 함께 첨부하는 것이 좋습니다.

​

Doctor로 진단하기

doctor 스크립트를 실행합니다.

Run doctor

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

​

호스트 정보

Host Information 섹션에는 Toolkit을 실행하는 머신에 대한 정보(예: Linux 배포판 및 릴리스)가 포함됩니다.

호스트 정보 출력 예시

- 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 섹션에는 Toolkit이 작동하는 데 필요한 도구가 나열됩니다. 도구가 있으면 버전 정보와 함께 status: present로 표시됩니다. 없으면 status: MISSING!으로 표시되며 doctor 출력 하단에 경고가 추가됩니다.

의존성 출력 예시 (있음)

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

의존성 출력 예시 (없음)

- docker
    - status: MISSING!

의존성이 하나라도 없으면 Toolkit은 거의 확실히 작동하지 않습니다.

​

구성

Configuration 섹션에는 config/ 디렉터리의 파일에 대한 정보가 포함됩니다. config/overleaf.rc의 경우 doctor는 몇 가지 주요 값을 출력합니다. 누락된 파일은 status: MISSING!으로 표시되며 doctor 출력 하단에 경고가 추가됩니다.

구성 출력 예시

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

위 예시에 대한 참고 사항:

• OVERLEAF_DATA_PATH가 /tmp/overleaf로 설정되어 있는데, 이는 중요한 데이터를 저장하기에 안전한 위치가 아닐 수 있습니다.
• MONGO_ENABLED: false는 Toolkit이 자체 MongoDB를 프로비저닝하지 않는다는 의미입니다. 필요한 경우 MONGO_URL이 외부에서 관리되는 MongoDB를 가리키는지 확인하세요.
• 예시에서는 config/variables.env가 누락되어 있습니다.

​

경고

Warnings 섹션에는 doctor 스크립트가 발견한 문제가 요약됩니다. 문제가 없으면 이 섹션에 그 사실이 표시됩니다.

경고 출력 예시

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