Doctor
Overleaf Toolkit には、デバッグに役立つ便利なdoctor スクリプトが付属しています。bin/doctor を実行すると、ホスト環境、設定、Toolkit が必要とする依存関係に関する情報が出力されます。この出力は、Ayakaleaf Pro のインストールに関する問題を私たちが診断する際にも役立ちます。
Overleaf Pro のユーザーは GitHub で issue を作成できます。メッセージには
bin/doctor スクリプトの出力を含めることをおすすめします。Doctor に相談する
doctor スクリプトを実行します。Run doctor
完全な出力の例
完全な出力の例
ホスト情報
Host Information セクションには、Toolkit を実行しているマシンに関する情報(たとえば Linux ディストリビューションやリリース)が含まれます。
Host Information の出力例
Host Information の出力例
依存関係
Dependencies セクションには、Toolkit の動作に必要なツールが一覧表示されます。ツールが存在する場合は、バージョン情報とともに status: present と表示されます。存在しない場合は status: MISSING! と表示され、doctor の出力の末尾に警告が追加されます。
Dependency の出力例(存在する場合)
Dependency の出力例(存在する場合)
Dependency の出力例(存在しない場合)
Dependency の出力例(存在しない場合)
設定
Configuration セクションには、config/ ディレクトリ内のファイルに関する情報が含まれます。config/overleaf.rc については、doctor がいくつかの重要な値を出力します。存在しないファイルは status: MISSING! と表示され、doctor の出力の末尾に警告が追加されます。
Configuration の出力例
Configuration の出力例
OVERLEAF_DATA_PATHが/tmp/overleafに設定されていますが、これは重要なデータの保存場所としては安全でない可能性があります。MONGO_ENABLED: falseは、Toolkit が独自の MongoDB をプロビジョニングしないことを意味します。必要に応じて、MONGO_URLが外部で管理されている MongoDB を指していることを確認してください。- この例では
config/variables.envが存在しません。
警告
Warnings セクションには、doctor スクリプトが検出した問題がまとめられます。問題がない場合は、このセクションにその旨が表示されます。
Warnings の出力例
Warnings の出力例
Q&A
bin/doctor が出力する quay.io、Docker の設定、Perl のロケールに関するメッセージは修正が必要ですか?
bin/doctor が出力する quay.io、Docker の設定、Perl のロケールに関するメッセージは修正が必要ですか?
回答: いいえ、3 つとも情報提供のためのものです。
bin/doctor はレポートを出力するだけで、bin/up を止めることはありません。logged in to quay.io: falseと警告Server Pro enabled, but not logged in to quay.io repository: このチェックは公式の Toolkit に由来するもので、公式では Server Pro のイメージが非公開の quay.io レジストリにあります。SERVER_PRO=trueの場合、Toolkit は公開されているghcr.io/ayaka-notes/overleaf-proを取得するため、ログインは不要です。この警告は無視してください。grep: /root/.docker/config.json: No such file or directory(または別のホームディレクトリ): quay.io のチェックは、このファイル内でquay.ioを探します。Docker は保存すべき設定がある場合(たとえばdocker loginの後)にのみこのファイルを書き込むため、多くのサーバーでは存在しません。このファイルは必要ありません。perl: warning: Setting locale failed: Toolkit がperlを使うのはbin/doctorでバージョンを表示するこの箇所だけで、LANGやLC_ALLがホストにインストールされていないロケールを指定していると Perl が警告を出します。それでもバージョンは表示されます。警告を消すには、これらの変数をlocale -aで一覧表示されるロケール(たとえばC.UTF-8)に設定してください。
Docker daemon is not running、docker not found、Docker Compose not found、あるいは config/ 内のファイルが見つからないといった警告は修正が必要です。これらがないと Toolkit は起動できません。
