2. Toolkit 살펴보기

​

둘러보기

이제 Toolkit의 로컬 사본이 준비되었으니 ls 명령으로 저장소 구조를 살펴보겠습니다.

Run this

ls -l

ls -l 명령은 디렉터리 내용을 자세한 긴 목록 형식으로 표시하며, 권한, 소유자, 크기 등 추가 파일 정보를 제공합니다.

모든 것이 성공적으로 클론되었다면 다음과 비슷한 결과가 표시됩니다:

drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 bin
-rw-r--r-- 1 fry fry  6465 Aug 30 14:16 CHANGELOG.md
drwxr-xr-x 2 fry fry  4096 Sep  6 12:43 config
drwxr-xr-x 5 fry fry  4096 Aug 30 14:22 data
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 doc
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 lib
-rw-r--r-- 1 fry fry 34520 Aug 30 14:16 LICENSE
-rw-r--r-- 1 fry fry  1178 Aug 30 14:16 README.md

사용자가 관리하는 모든 구성 파일은 config/ 디렉터리에 있습니다. 이 디렉터리는 git 버전 관리 시스템에서 제외되므로 Toolkit을 업데이트해도 변경되지 않습니다.

​

저장소 구성

이름	설명
bin	Overleaf 서버 인스턴스 관리를 돕는 스크립트 모음이 들어 있는 폴더입니다. 이 스크립트에 대한 자세한 내용은 아래 Commands 섹션에서 확인할 수 있습니다.
config	사용자 자신의 로컬 구성 파일이 들어 있는 폴더입니다.
lib	Toolkit에서 사용하는 기본 구성 파일이 들어 있는 폴더입니다.
data	기본적으로 이 폴더에는 MongoDb, Redis, Overleaf의 저장 위치가 들어 있습니다. 자세한 내용은 아래 영구 데이터 섹션을 참조하세요.

/config 폴더 외부의 파일을 직접 변경하지 않는 것을 권장합니다. 대신 변경이 필요한 경우 config/variables.env 또는 config/overleaf.rc에 설정하는 환경 변수를 통해 변경할 수 있습니다.
예를 들어 mongo 서비스 이미지를 설정하려면 lib/docker-compose.mongo.yml을 직접 편집하는 대신 config/overleaf.rc에서 환경 변수 MONGO_IMAGE를 사용해 이미지를 설정하세요. 자세한 내용은 Toolkit 설정 페이지를 참조하세요.

Toolkit은 사용자의 허락 없이 config/ 디렉터리의 데이터를 변경하지 않습니다.

​

명령

다음 스크립트는 Toolkit 디렉터리에서 실행하세요. 각 스크립트는 --help로 옵션을 출력합니다.

명령	기능
bin/init	처음 실행할 때 config/에 구성 파일을 생성합니다. bin/init --tls는 NGINX TLS 프록시 구성을 추가합니다.
bin/up	컨테이너를 생성하고 시작합니다(bin/docker-compose up). 로그를 따라가는 대신 백그라운드에서 실행하려면 -d를 추가하세요. config/를 변경할 때마다 실행하세요. 구성이 변경된 컨테이너를 다시 생성합니다.
bin/start	기존 컨테이너를 다시 시작합니다(bin/docker-compose start). 구성 변경 사항은 적용하지 않습니다.
bin/stop	컨테이너를 중지하되 삭제하지는 않습니다(bin/docker-compose stop).
bin/docker-compose	Toolkit의 파일로 docker compose를 실행합니다. 예: bin/docker-compose ps 또는 bin/docker-compose restart sharelatex.
bin/logs	하나 이상의 서비스 로그를 표시하거나 따라갑니다. 예: bin/logs -f web.
bin/error-logs	bin/logs와 비슷하지만 오류만 표시합니다.
bin/shell	sharelatex 컨테이너 내부에서 셸을 엽니다.
bin/mongo	sharelatex 데이터베이스에서 MongoDB 셸을 엽니다.
bin/run-script	sharelatex 컨테이너에 포함된 스크립트를 실행합니다.
bin/doctor	호스트와 구성을 확인하고, 도움을 요청할 때 공유할 보고서를 출력합니다.
bin/images	호스트에 있는 Overleaf Docker 이미지를 나열합니다.
bin/backup-config	config/ 디렉터리를 백업 위치로 복사합니다(copy, zip 또는 tar).
bin/upgrade	Toolkit과 Overleaf 이미지를 단계별로 업데이트합니다. 배포 업그레이드를 참조하세요.
bin/rename-env-vars-5-0, bin/rename-rc-vars	이전 SHARELATEX_* 변수 이름을 OVERLEAF_*로 바꾸는 일회성 마이그레이션입니다.

bin/up이 컨테이너를 다시 생성하면, bin/shell을 통해 설치한 패키지나 편집한 파일 등 컨테이너 내부에서 변경한 모든 내용이 사라집니다. 데이터 디렉터리(기본값 data/)와 config/만 유지됩니다. 영구적인 변경은 대신 config/variables.env, config/overleaf.rc 또는 config/docker-compose.override.yml을 통해 적용하세요.

bin/up을 실행할 때마다 모든 사용자가 로그아웃된다면 OVERLEAF_SESSION_SECRET을 설정하세요. 이 값이 없으면 세션 쿠키가 컨테이너를 다시 생성할 때마다 새로 생성되는 시크릿으로 서명됩니다. 환경 변수의 Q&A를 참조하세요.