Projekte exportieren

In Server Pro und Community Edition 5.4.0 haben wir ein Skript bereitgestellt, mit dem Administratoren alle Benutzerprojekte (einschließlich derer, die noch in den Ordnern Deleted und Trashed sichtbar sind) in ein Verzeichnis auf der Festplatte exportieren können.

Die Ausgabe dieses Skripts entspricht dem manuellen Herunterladen eines Zip-Archivs aller Projekte über das Projekt-Dashboard des Benutzers. Das Skript schreibt vor Beginn des Downloads alle ausstehenden Änderungen fest, damit der Export die neueste Version des Projekts enthält.

​

Einschränkungen

Das Export-Skript unterliegt den folgenden Einschränkungen:

• Projekteinstellungen wie der Name des TeX Live-Images oder der Compiler werden nicht exportiert. Diese müssen beim Hochladen des Projekts in das Benutzerkonto festgelegt werden.
• Exportierte Projekte enthalten keinen Versionsverlauf.
• Informationen zu Mitbearbeitern bleiben nicht erhalten. Projekte müssen erneut geteilt werden. Bei Verwendung der Link-Freigabe werden die Links zum Ansehen und Bearbeiten neu generiert (sie sind nicht dieselben wie zuvor).
• Kommentare und Informationen zu nachverfolgten Änderungen werden nicht exportiert.
• Der Chatverlauf von Projekten wird nicht exportiert.

Dieses Skript ist nicht als Ersatz für eine vollständige Systemsicherung gedacht. Damit Sie Ihre Instanz in einem Disaster-Recovery-Szenario wiederherstellen können, empfehlen wir dringend, eine konsistente Sicherung zu erstellen.

​

Flags

Name	Beschreibung
--help	Hilfe anzeigen
--user-id	Die Benutzer-ID (erforderlich, sofern nicht --export-all oder --project-id verwendet wird)
--project-id	Ein einzelnes Projekt exportieren (kann nicht mit --user-id oder --export-all verwendet werden)
--list	Projekte des Benutzers auflisten (kann nicht mit --output verwendet werden)
--output	Ausgabe-Zip-Datei (für einzelne Exportvorgänge)
--export-all	Projekte aller Benutzer exportieren (erfordert --output-dir)
--output-dir	Verzeichnis zum Speichern der Exportdateien aller Benutzer
--log-level	Unterstützte Log-Level: trace|debug|info|warn|error|fatal

​

Verwendung

Verwenden Sie den folgenden Befehl, um die Projekte aller Benutzer zu exportieren:

# 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"

Wenn Sie Server Pro oder Community Edition <= 3.5.13 verwenden, müssen Sie das obige Beispiel so anpassen, dass das Skript export-legacy-user-projects.js verwendet wird.

​

Abschluss

Sobald der Export abgeschlossen ist, können Sie auf die Dateien über das Verzeichnis auf dem Host zugreifen, das in Ihrer docker-compose.yml per Bind-Mount nach /var/lib/overleaf eingebunden ist, bzw. über die Umgebungsvariable OVERLEAF_DATA_PATH in der Datei config/overleaf.rc, wenn Sie das Toolkit verwenden.

Overleaf erlaubt derzeit doppelte Projektnamen. Wenn ein Benutzer Projekte mit identischem Namen hat, werden diese trotzdem in den Zip-Export des Benutzers aufgenommen, beim Entpacken ist jedoch nur eine Version vorhanden. Unter Linux schreibt unzip -B Dateien mit gleichem Namen als Sicherungsdateien, anstatt sie zu überschreiben.