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 サーバーインスタンスの管理に役立つスクリプト群が含まれています。これらのスクリプトの詳細は、以下のコマンドのセクションを参照してください。
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	1 つ以上のサービスのログを表示または追跡します。例: 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 を設定してください。これがない場合、セッション Cookie はコンテナが再作成されるたびに生成し直されるシークレットで署名されます。環境変数の Q&A を参照してください。