プロジェクトのエクスポート

Server Pro および Community Edition 5.4.0 には、管理者がすべてのユーザープロジェクト(Deleted および Trashed フォルダーにまだ表示されているものを含む)をディスク上のディレクトリにエクスポートできるスクリプトが含まれています。

このスクリプトを実行した結果は、ユーザーのプロジェクトダッシュボードからすべてのプロジェクトの Zip を手動でダウンロードした場合と同じです。スクリプトはダウンロードを開始する前に保留中の変更をフラッシュするため、エクスポートにはプロジェクトの最新バージョンが含まれます。

​

制限事項

エクスポートスクリプトには次の制限があります。

• TeX Live イメージ名やコンパイラーなどのプロジェクト設定はエクスポートされません。これらは、プロジェクトをユーザーのアカウントにアップロードする際に設定する必要があります。
• エクスポートされたプロジェクトにはバージョン履歴が含まれません。
• 共同編集者の情報は保持されません。プロジェクトは再共有する必要があります。リンク共有を使用している場合、閲覧用および編集用のリンクは再生成されます(以前と同じにはなりません)。
• コメントや変更履歴の情報はエクスポートされません。
• プロジェクトのチャット履歴はエクスポートされません。

このスクリプトは完全なシステムバックアップの代わりとなるようには設計されていません。災害復旧のシナリオでインスタンスを確実に復元できるよう、整合性のあるバックアップを取ることを強く推奨します。

​

フラグ

名前	説明
--help	ヘルプを表示
--user-id	ユーザー ID(--export-all または --project-id を使用しない場合は必須)
--project-id	単一のプロジェクトをエクスポート(--user-id や --export-all とは併用不可)
--list	ユーザーのプロジェクトを一覧表示(--output とは併用不可)
--output	出力 zip ファイル(単一のエクスポート操作用)
--export-all	すべてのユーザーのプロジェクトをエクスポート(--output-dir が必要)
--output-dir	すべてのユーザーのエクスポートファイルを保存するディレクトリ
--log-level	サポートされているログレベル: trace|debug|info|warn|error|fatal

​

使い方

すべてのユーザーのプロジェクトをエクスポートするには、次のコマンドを使用します。

# Overleaf Toolkit users
$ bin/docker-compose exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/export-user-projects.mjs --export-all --output-dir=/var/lib/overleaf/data/exports"

# Legacy docker-compose.yml users
docker exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/export-user-projects.mjs --export-all --output-dir=/var/lib/overleaf/data/exports"

Server Pro または Community Edition 3.5.13 以前を実行している場合は、上記の例を export-legacy-user-projects.js スクリプトを使用するように変更する必要があります。

​

完了

エクスポートが完了したら、docker-compose.yml ファイルで /var/lib/overleaf にバインドマウントされているホスト上のディレクトリ、または Toolkit を使用している場合は config/overleaf.rc ファイルの OVERLEAF_DATA_PATH 環境変数で指定されたディレクトリからファイルにアクセスできます。

Overleaf では現在、プロジェクト名の重複が許可されています。ユーザーのプロジェクトに重複がある場合でも、それらのプロジェクトはユーザーの Zip エクスポートに追加されますが、展開すると 1 つのバージョンしか残りません。Linux では、unzip -B を使うと、上書きする代わりに同名のファイルをバックアップファイルとして書き出します。