Ayakaleaf Toolkit이란?

Ayakaleaf Toolkit은 Community Edition 및 Ayakaleaf Pro의 온프레미스 설치에 권장되는 배포 방법으로, 가장 일반적인 환경인 단일 물리 서버 또는 가상 머신에서 작동하도록 설계되었습니다. Toolkit은 docker compose를 사용하여 서버의 Docker 컨테이너를 관리하며, docker 명령을 감싸는 일련의 스크립트를 제공하여 온프레미스 버전의 Overleaf를 관리하는 기술적인 측면을 지원합니다.

bin/docker-compose 래퍼

bin/docker-compose 스크립트는 docker compose를 감싸는 래퍼입니다. 이 스크립트는 config/ 디렉터리에서 구성을 로드한 후, 스크립트에 전달된 인수를 그대로 사용하여 docker compose를 호출합니다.

bin/docker-compose는 컴퓨터에 설치된 docker compose 프로그램의 투명한 래퍼로 간주해도 됩니다.

예시:

Check running containers

$ bin/docker-compose ps

편의 도우미

bin/docker-compose 외에도 Toolkit은 일반적인 작업을 돕는 편리한 스크립트를 제공합니다.

• bin/up: bin/docker-compose up의 바로 가기
• bin/start: bin/docker-compose start의 바로 가기
• bin/stop: bin/docker-compose stop의 바로 가기
• bin/shell: sharelatex 컨테이너 내부에서 셸을 시작합니다
• bin/doctor: 설치 및 배포 정보를 수집하는 스크립트입니다. 아래의 “서버 점검하기” 섹션을 참조하세요
• bin/mongo: mongo 컨테이너 내부에서 셸을 시작하고 올바른 데이터베이스(sharelatex)로 전환합니다
• bin/backup-config: 현재 구성의 사본(zip 또는 tar)을 만들어 원하는 대상 디렉터리에 저장합니다
• bin/logs: 서비스 로그 보기/tail
• bin/error-logs: 서비스 오류 로그 보기/tail
• bin/rename-env-vars-5-0: config/variables.env의 환경 변수를 업데이트하는 마이그레이션 스크립트입니다(ShareLaTeX에서 Overleaf로의 리브랜딩)
• bin/rename-rc-vars: config/overleaf.rc의 환경 변수를 업데이트하는 마이그레이션 스크립트입니다(ShareLaTeX에서 Overleaf로의 리브랜딩)
• bin/run-script: sharelatex 컨테이너 내에 저장된 스크립트 실행을 간소화하는 도우미입니다
• bin/upgrade: 인스턴스 업그레이드를 지원합니다. 이 스크립트는 (git을 통해) Toolkit 업데이트를 확인하고 변경 사항을 pull할지 제안하며, 최신 Docker 이미지 버전을 확인하고 업데이트를 제안합니다. 단계별 확인, 현재 구성 백업 옵션을 제공하고 Docker 서비스의 중지/시작을 처리합니다. 자세한 내용은 배포 업그레이드 문서를 참조하세요: https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment

Docker 로그에 연결하지 않고 인스턴스를 실행하려면 bin/up -d를 실행하여 분리 모드로 실행할 수 있습니다.

서버 점검하기

Overleaf Toolkit에는 충족되지 않은 의존성을 알려 주는 보고서를 생성하는 bin/doctor라는 편리한 스크립트가 포함되어 있습니다.

계속하기 전에 bin/doctor 스크립트를 실행하여 모든 것이 올바르게 작동하는지 확인하세요.

Run Overleaf Doctor

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

의존성이 누락된 경우 doctor가 경고를 출력합니다. 문제가 발생하면 먼저 bin/doctor를 실행하고 출력에서 경고를 확인하세요.

• Ayakaleaf Pro Edition 사용자는 GitHub에 이슈를 열 수 있습니다: https://github.com/ayaka-notes/toolkit/issues

어느 경우든 메시지에 bin/doctor의 출력을 포함해 주세요.