Exporter des projets

Dans Server Pro et Community Edition 5.4.0, nous avons inclus un script permettant aux administrateurs d’exporter tous les projets des utilisateurs (y compris ceux encore visibles dans les dossiers Deleted et Trashed) vers un répertoire sur le disque.

Le résultat de ce script est identique au téléchargement manuel d’un Zip de tous les projets depuis le tableau de bord de l’utilisateur. Le script applique toutes les modifications en attente avant de lancer le téléchargement, afin que l’export contienne la dernière version du projet.

​

Limitations

Le script d’export présente les limitations suivantes :

• Aucun paramètre de projet, comme le nom de l’image TeX Live ou le compilateur, n’est exporté. Ces paramètres doivent être définis lorsque le projet est importé dans le compte de l’utilisateur.
• Les projets exportés ne contiennent aucun historique des versions.
• Aucune information sur les collaborateurs n’est conservée. Les projets devront être partagés à nouveau. Si vous utilisez le partage par lien, les liens de lecture et de modification seront régénérés (ils seront différents des précédents).
• Les commentaires et les informations de suivi des modifications ne seront pas exportés.
• L’historique du chat du projet ne sera pas exporté.

Ce script n’est pas conçu pour remplacer une sauvegarde complète du système. Pour vous assurer de pouvoir restaurer votre instance en cas de sinistre, nous recommandons vivement de réaliser une sauvegarde cohérente.

​

Options

Nom	Description
--help	Affiche l’aide
--user-id	L’identifiant de l’utilisateur (obligatoire sauf si vous utilisez --export-all ou --project-id)
--project-id	Exporte un seul projet (ne peut pas être utilisé avec --user-id ou --export-all)
--list	Liste les projets de l’utilisateur (ne peut pas être utilisé avec --output)
--output	Fichier zip de sortie (pour les exports uniques)
--export-all	Exporte les projets de tous les utilisateurs (nécessite --output-dir)
--output-dir	Répertoire de stockage des fichiers d’export de tous les utilisateurs
--log-level	Niveaux de journalisation pris en charge : trace|debug|info|warn|error|fatal

​

Utilisation

Utilisez la commande suivante pour exporter les projets de tous les utilisateurs :

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

Si vous utilisez Server Pro ou Community Edition <= 3.5.13, vous devrez adapter l’exemple ci-dessus pour utiliser le script export-legacy-user-projects.js.

​

Fin de l’export

Une fois l’export terminé, vous pouvez accéder aux fichiers via le répertoire de l’hôte monté (bind mount) sur /var/lib/overleaf dans votre fichier docker-compose.yml, ou via la variable d’environnement OVERLEAF_DATA_PATH du fichier config/overleaf.rc si vous utilisez le Toolkit.

Overleaf autorise actuellement les noms de projets en double. Si un utilisateur possède des projets portant le même nom, ils seront tous ajoutés à son export Zip, mais une seule version sera présente après extraction. Sous Linux, unzip -B enregistre les fichiers de même nom en tant que fichiers de sauvegarde au lieu de les écraser.