Overleaf Toolkit 사용하여 local overleaf 서버 빌드하기 with review

Overleaf 프로젝트

Overleaf 는 latex 문법으로 논문을 작성하는 웹 서비스를 제공하는 프로젝트이다. 이 프로젝트는 커뮤니티 에디션이 오픈소스로 공개되어 있으며, 서비스를 이용하기 위해서는 유료버전으로 서버를 운영하거나 무료/유료로 웹 서비스를 이용하는 방법도 있다.

다만, 커뮤니티 버전에는 기능이 막혀있거나 없는 것들 또 사용하기 불편한 점들이 많아 최근 이 오픈소스 코드를 이용하여 기능 추가 및 운영을 지속하고 있다. 본 글에서는 기본적인 실행 방법과, 기능 추가 과정에서 정리해둔 현재 최신 버전에는 없는 리뷰 추가 기능과 texlive 패키지를 업데이트 하는 방법등을 소개해볼까 하다.

리뷰추가 및 텍스라이브 패키지 업데이트를 위해 이 레포지토리를 참고하였다. grandduke's sharelatex

기본 서버 실행

기본적으로 overleaf에서 제공하는 toolkit을 이용하는것이 좋다. 추가적인 기능 없이 담백하게 서버 운영을 간단한 키워드로 실행이 가능하다.(Overleaf Toolkit With Review)

파워 링크로 걸어둔 것은 툴킷을 포크하여 리뷰를 적용할 수 있도록 가이드를 적어놓은 깃헙 링크이다.
일단 기본적으로 clone을 진행한 후 아래의 명령어를 입력해야 한다.

cd toolkit-with-review
bin/init

init은 기본 config을 설정하는 단계로 만약 nginx를 같이 사용하기 위해서는 아래의 커맨드를 이용해 init해주어야 한다.

bin/init --tls

nginx 서버 실행 후 https까지 설정하는 법은 다음 글에서 포스팅 할 예정이다.

이제 클론한 폴더를 보면 config이라는 폴더아래에 다양한 파일들이 생긴것을 확인할 수 있다. 이 파일들을 본인의 입맛에 맞게 설정하면 된다. 주로 보아야 할 것은 config/overleaf.rc파일로 여기서 주 기본 설정들이 이루어진다. 자세한것은 오버리프의 공식 도큐먼트를 참고할 것을 추천한다.

다시 실행으로 돌아와 아래의 명령어를 입력하면 리뷰와 텍스라이브 서버 업데이트가 빠진 버전의 sharelatex 서버를 굴릴 수 있다.

bin/up -d

-d옵션을 주는 이유는 백그라운드 실행을 하기 위함으로 공식적으로 추천하는 방법이다.

이미지 빌드 with review

기존 Toolkit에서 Dockerfile을 하나 추가해두었는데, 이를 아래처럼 빌드하여 사용하면 된다. 이 파일은 기본 sharelatex이미지위에 texlive 업데이트 코드와 review기능 추가를 적용시키는 파일이다.

docker build . -t sharelatex/sharelatex:5.5.4-with-review

올려둔 깃헙 레포지토리에서는 sharelatex/sharelatex:5.5.4-with-review 라는 이름으로되어 있는 이미지를 인식하도록 바꾸어 두었다. 만약에 다른 이름으로 설정하였다면 아래 파일을 바꾸어야 한다.

• lib/docker-compose.base.yml

  services:
    sharelatex:
        restart: always
        image: sharelatex_image_name:tag <- update this part
        container_name: sharelatex
        ...

  이 파일의 image부분을 당신이 원하는 이미지 파일로 변경해주면 된다.

2025년 11월 기준 최신 버전에서는 리뷰 추가 기능이 dockerfile을 이용하는 방법이 적용되지 않는데, 이는 파일 이름이 맞지 않기 때문이다. 때문에, 이를 원한다면 직접 이미지 파일을 빌드하여야 한다.

리뷰 패치를 적용하기 위한 이미지 파일 빌드는 다음 포스트에서 작성하도록 하겠다.