リポジトリをクローン#

1
git clone https://github.com/overleaf/toolkit.git ./overleaf-toolkit
2
cd ./overleaf-toolkit

以後 Overleaf Toolkit を OLTK と略称します。

起動する#

OLTK ディレクトリ内で bin/init を実行すると設定ファイルが作成されます。

1
./overleaf-toolkit % ls config
2
> overleaf.rc  variables.env  version

続けて bin/up でコンテナを起動します。docker compose up を内部的に実行しているみたい？

初回起動時はブラウザで http://localhost/launchpad を開くと管理者アカウントの登録画面に入れます。

管理用アカウントを作成しますが、メアド/パスワードはローカル環境でつかうものなので適当に。とくにオンラインで認証が入るわけじゃないです。

次回以降は http://localhost/login からログインできます。また http://localhost/project でプロジェクト一覧を開けます。

(なんか出たら Start Using Our Overleaf Instance で進んでよさそう)

Creat a new project を押して Upload project を選択するとオンライン版 Overleaf のプロジェクトを読み込めます。

ただし今のままだとエラーが出ると思うので日本語環境の設定が必要。

日本語環境に設定する#

現在の状態だと日本語環境が全く無いので，新しくターミナルなどを開いてから bin/shell を実行します。(bin/up をしたウィンドウは入力できない状態のはずなので新規ウィンドウ)

コンテナの中のシェルに入れるので，以下のコマンドで TeX Live を更新します。

• tlmgr update --self
• tlmgr install collection-langjapanese here float comment booktabs titlesec wrapfig siunitx
  • このコマンドは必要なパッケージがあれば適宜増やしてください

TeX Live の更新が終わったら exit もしくは Ctrl+D でシェルを抜けられます。

シェルを抜けたあとのターミナルなどで以下のコマンドを実行するとこのコンテナイメージを保存しておけるので，次回以降の起動で設定が不要になります。

1
docker commit sharelatex sharelatex/sharelatex:with-texlive-full

いったん Overleaf サーバーを落とすために bin/stop を実行します。bin/up がうごいているターミナルで Ctrl+C でも可。

普段のつかいかた#

Docker Desktop を利用しているなら Overleaf コンテナの再生マークをクリックして起動できます。起動したら

コマンドで起動したいなら bin/start で起動すればバックグラウンドで動かせる (ターミナルにログが出ない) のでおすすめです。同じく bin/stop で止められます。

いずれにせよ、起動したら http://localhost/login でオンライン版と同じようにつかうことができます。

Mac で bin/up すると MONGO_VERSION エラーが出る#

1
./overleaf-toolkit % bin/up
2
---------------------  ERROR  -----------------------
3
  Invalid MONGO_VERSION: MONGO_VERSION=8.0
4

5
  MONGO_VERSION must start with the actual major version of mongo, followed by a dot.
6
  Example: MONGO_IMAGE=my.dockerhub.com/custom-mongo
7
           MONGO_VERSION=6.0-custom
8
---------------------  ERROR  -----------------------

lib/shared-functions.sh の正規表現に誤りがあるみたいなので修正します。(参考)

• 修正前

1
function read_variable() {
2
  local name=$1
3
  grep -E "^$name=" "$TOOLKIT_ROOT/config/variables.env" \
4
  | sed -r "s/^$name=([\"']?)(.+)\1\$/\2/"
5
}
6

7
function read_configuration() {
8
  local name=$1
9
  grep -E "^$name=" "$TOOLKIT_ROOT/config/overleaf.rc" \
10
  | sed -r "s/^$name=([\"']?)(.+)\1\$/\2/"
11
}

• 修正後

1
function read_variable() {
2
  local name=$1
3
  grep -E "^$name=" "$TOOLKIT_ROOT/config/variables.env" \
4
  | sed -r "s/^$name=[\"']?([^\"']+)[\"']?\$/\1/"
5
}
6

7
function read_configuration() {
8
  local name=$1
9
  grep -E "^$name=" "$TOOLKIT_ROOT/config/overleaf.rc" \
10
  | sed -r "s/^$name=[\"']?([^\"']+)[\"']?\$/\1/"
11
}

Mac で bin/up すると no matching manifest for linux/arm64/v8 in the manifest list entries エラーが出る#

内部でうごいている sharelatex の Apple Silicon 向けのビルドが無いせいなので、M1 チップ以降の Mac で動かすときにはいくつか手順が必要です。

bin/init した後に lib/docker-compose.base.yml を編集します。

1
services:
2
    sharelatex:
3
        restart: always
4
        platform: linux/amd64 # これを追記する
5
        image: "${IMAGE}"

また config/overleaf.rc ファイルを開いて、14行目あたりにある以下を false にします。

1
SIBLING_CONTAINERS_ENABLED=false

ARM 向けの Docker Image を落とします。

1
docker pull --platform linux/amd64 sharelatex/sharelatex:6.0.1

これで bin/up できるはず。

参考

こういうところで ARM アーキテクチャが牙を剥いてくる。

Windows で bin/up すると Error response from daemon: mount denied エラーが出る#

lib/docker-compose.base.yml をエディターで開いて9行目を以下のように変更します。(参考)

1
"${OVERLEAF_DATA_PATH}:/var/lib/overleaf"