Экспорт проектов

В 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.

​

Завершение

После завершения экспорта файлы доступны в каталоге хоста, который смонтирован (bind mount) в /var/lib/overleaf в вашем файле docker-compose.yml, или в каталоге, указанном в переменной окружения OVERLEAF_DATA_PATH в файле config/overleaf.rc, если вы используете Toolkit.

В настоящее время Overleaf допускает одинаковые названия проектов. Если у пользователя есть проекты с одинаковыми названиями, они всё равно будут добавлены в Zip-архив экспорта, но при распаковке останется только одна версия. В Linux команда unzip -B сохраняет файлы с одинаковыми именами как резервные копии вместо перезаписи.