Projecten exporteren

In Server Pro en Community Edition 5.4.0 hebben we een script toegevoegd waarmee beheerders alle gebruikersprojecten (inclusief projecten die nog zichtbaar zijn in de mappen Deleted en Trashed) kunnen exporteren naar een map op schijf.

De uitvoer van dit script is hetzelfde als het handmatig downloaden van een zip-bestand van alle projecten vanuit het projectdashboard van de gebruiker. Het script verwerkt eerst alle openstaande wijzigingen voordat de download begint, zodat de export de nieuwste versie van het project bevat.

​

Beperkingen

Het exportscript heeft de volgende beperkingen:

• Er worden geen projectinstellingen geëxporteerd, zoals de naam van de TeX Live-image of de compiler. Deze moeten worden ingesteld wanneer het project naar het account van de gebruiker wordt geüpload.
• Geëxporteerde projecten bevatten geen versiegeschiedenis.
• Er wordt geen informatie over medewerkers bewaard. Projecten moeten opnieuw worden gedeeld. Bij gebruik van link-sharing worden de links voor bekijken en bewerken opnieuw gegenereerd (ze zijn dus niet hetzelfde als voorheen).
• Opmerkingen en informatie over bijgehouden wijzigingen worden niet geëxporteerd.
• De chatgeschiedenis van projecten wordt niet geëxporteerd.

Dit script is niet bedoeld als vervanging van een volledige systeemback-up. Om ervoor te zorgen dat je je instantie bij een calamiteit kunt herstellen, raden we sterk aan een consistente back-up te maken.

​

Flags

Naam	Beschrijving
--help	Help weergeven
--user-id	Het gebruikers-ID (verplicht, tenzij --export-all of --project-id wordt gebruikt)
--project-id	Eén project exporteren (kan niet samen met --user-id of --export-all worden gebruikt)
--list	Projecten van de gebruiker weergeven (kan niet samen met --output worden gebruikt)
--output	Zip-uitvoerbestand (voor afzonderlijke exportbewerkingen)
--export-all	Projecten van alle gebruikers exporteren (vereist --output-dir)
--output-dir	Map voor het opslaan van de exportbestanden van alle gebruikers
--log-level	Ondersteunde logniveaus: trace|debug|info|warn|error|fatal

​

Gebruik

Gebruik het volgende commando om de projecten van alle gebruikers te exporteren:

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

Als je Server Pro of Community Editition <= 3.5.13 gebruikt, moet je het bovenstaande voorbeeld aanpassen zodat het script export-legacy-user-projects.js wordt gebruikt.

​

Voltooiing

Zodra de export is voltooid, kun je de bestanden openen via de map op de host die in je docker-compose.yml-bestand als bind mount aan /var/lib/overleaf is gekoppeld, of via de omgevingsvariabele OVERLEAF_DATA_PATH in het bestand config/overleaf.rc als je de Toolkit gebruikt.

Overleaf staat momenteel dubbele projectnamen toe. Als een gebruiker projecten met dezelfde naam heeft, worden deze nog steeds aan de zip-export van de gebruiker toegevoegd, maar bij het uitpakken is slechts één versie aanwezig. Op Linux schrijft unzip -B bestanden met dezelfde naam weg als back-upbestanden in plaats van ze te overschrijven.