Backup/Restore

For your peace of mind, Papermerge provides easy way to backup/export and restore all your documents. Terms backup and export (similar for restore/import) are synonymous so I will use them interchangeably. There are two different interfaces to backup and restore your documents:

  • Command line based (suitable for automation)
  • User interface based (by clicking) - will be implemented

Command Line

Backup/Export

To create a backup of all documents currently found your in Papermerge instance, just run:

./manage.py backup --user <username>

This will create a file backup_<current-datetime>.tar for specified user in same folder where manage.py file is located. You can provide a file name as well:

./manage.py backup papermerge.tar --user <username>

Notice tar extension. You can provide any file name (or path to a file) but keep in mind that backup command creates a tar archive for you. Finally you can provide as argument an existing directory:

./manage.py backup /data/backups/papermerge/ --user <username>

In example above, file named /data/backups/papermerge/backup_<current-datetime>.tar will be created.

For full reference see backup and restore commands in utils documentation.

Restore/Import

To restore documents from tar archive, use following command:

./manage.py restore <path-to-tar-file> --user <username>

As main argument for restore command use provide path to tar archive.

Warning

Keep in mind that restore command expects tar archive - not zipped tar archive. In case your backup solution pipeline compressed tar archive provided by backup command - you will need to first uncompress it manually, and then provide it as argument to restore command.

User argument expects a username - not an id. Example of usage:

./manage.py restore papermerge_13_07_2020.tar --user admin

User Interface

Note

User Interface based backup is not yet implemented