导出项目

在 Server Pro 和 Community 版中 5.4.0 我们包含了一个脚本，允许管理员将所有用户项目导出（包括仍然可见的 已删除 和 已丢弃 文件夹）到磁盘上的目录。

运行此脚本的输出与从用户的项目仪表板手动下载所有项目的压缩包相同。脚本在开始下载前会刷新任何待处理的更改，以确保导出包含项目的最新版本。

限制

导出脚本具有以下限制：

• 不会导出任何项目设置，例如 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 用户
$ 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"

# 传统 docker-compose.yml 用户
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 脚本。

完成

导出完成后，您可以通过绑定挂载到主机的目录访问这些文件，该目录映射到 /var/lib/overleaf 中。 docker-compose.yml 文件或如果您使用 Toolkit，则是 OVERLEAF_DATA_PATH 环境变量在 config/overleaf.rc 文件中。

Overleaf 当前允许重复的项目名称。如果用户的项目包含重复项，这些项目仍将被添加到用户的 Zip 导出中，但解压后只会存在一个版本。在 Linux 上， unzip -B 会将同名文件写为备份文件而不是覆盖。