> 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/ko/getting-started/what-is-the-overleaf-toolkit.md). # Ayakaleaf Toolkit이란 무엇인가요? Ayakaleaf 툴킷은 Community Edition, Ayakaleaf Pro의 온프레미스 설치에 권장되는 배포 방식이며, 가장 일반적인 환경인 단일 물리 서버 또는 가상 머신에서 작동하도록 설계되었습니다. 툴킷은 `docker compose` 서버의 Docker 컨테이너를 관리하고, 다음을 감싸는 스크립트 집합을 제공합니다 `docker` 명령어들을 사용하여 온프레미스 버전의 Overleaf를 관리하는 더 기술적인 측면을 돕습니다. #### 이 `bin/docker-compose` 래퍼 이 `bin/docker-compose` 스크립트는 다음을 감싸는 래퍼입니다 `docker compose`. 그것은 다음에서 구성을 불러온 후 `config/` 디렉터리에서 구성을 불러온 뒤 `docker compose` 스크립트에 전달된 인자와 함께 호출합니다. 다음을 `bin/docker-compose` 다음의 투명한 래퍼로 취급할 수 있습니다 `docker compose` 프로그램은 귀하의 머신에 설치되어 있습니다. 예시: {% code title="실행 중인 컨테이너 확인" %} ```bash $ bin/docker-compose ps ``` {% endcode %} #### 편의용 도우미 다음 외에도 `bin/docker-compose`툴킷은 일반적인 작업을 돕는 편리한 스크립트를 제공합니다: * `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`: 서비스 로그를 확인/실시간 추적합니다 * `bin/error-logs`: 서비스 오류 로그를 확인/실시간 추적합니다 * `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을 통해) 툴킷 업데이트를 확인하고 변경 사항을 가져오도록 제안하며, 최신 Docker 이미지 버전을 확인하고 업데이트하도록 제안합니다. 단계별 확인, 현재 구성을 백업할 수 있는 옵션을 제공하며, Docker 서비스의 중지/시작을 처리합니다. 자세한 내용은 배포 업그레이드하기를 참조하세요: {% hint style="info" %} Docker 로그에 연결하지 않고 인스턴스를 실행하려면 `bin/up -d` 를 실행하여 분리 모드로 실행할 수 있습니다. {% endhint %} #### 서버 확인 Overleaf 툴킷에는 다음이라는 유용한 스크립트가 포함되어 있습니다 `bin/doctor` 이 들어 있지 않은 종속 항목이 있으면 이를 가리키는 보고서를 생성합니다. 계속하기 전에 `bin/doctor` 스크립트를 실행하고 모든 것이 올바르게 작동하는지 확인하세요: {% code title="Overleaf Doctor 실행" %} ```bash bin/doctor ``` {% endcode %} 예시 출력(일부 생략/예시용):
bin/doctor의 샘플 출력 ``` ====== Overleaf Doctor ====== - 호스트 정보 - Linux - 'lsb_release -a'의 출력: LSB 모듈을 사용할 수 없습니다. 배포자 ID: Ubuntu 설명: Ubuntu 22.04.5 LTS 릴리스: 22.04 코드명: jammy - 종속 항목 - bash - 상태: 있음 - 버전 정보: 5.1.16(1)-release - docker - 상태: 있음 - 버전 정보: Docker version 27.3.1, build ce12230 - realpath - 상태: 있음 - 버전 정보: realpath (GNU coreutils) 8.32 - perl - 상태: 있음 - 버전 정보: 5.034000 - awk - 상태: 있음 - 버전 정보: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1) - openssl - 상태: 있음 - 버전 정보: OpenSSL 3.0.2 15 Mar 2022 (라이브러리: OpenSSL 3.0.2 15 Mar 2022) - docker compose - 상태: 있음 - 버전 정보: Docker Compose version v2.29.7 - Docker 데몬 - 상태: 실행 중 ====== 구성 ====== - config/version - 상태: 있음 - 버전: 5.1.1 - config/overleaf.rc - 상태: 있음 - 값 - OVERLEAF_DATA_PATH: data/overleaf - OVERLEAF_LOG_PATH: data/overleaf/logs - SERVER_PRO: true - 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 - 상태: 있음 - 값 - OVERLEAF_FILESTORE_BACKEND: fs - OVERLEAF_HISTORY_BACKEND: fs ====== 경고 ====== - 없음, 모두 정상입니다 ====== 끝 ====== ```
필수 종속 항목이 누락되면 doctor가 경고를 출력합니다. 문제가 발생하면 먼저 `bin/doctor` 를 실행하고 출력에서 경고를 확인하세요. {% hint style="info" %} * Ayakaleaf Pro Edition 사용자는 GitHub에 이슈를 열 수 있습니다: 두 경우 모두 다음의 출력 내용을 `bin/doctor` 메시지에 포함하세요. {% 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/ko/getting-started/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.