Backing up

Taking a backup

For a complete backup of the data please take periodic snapshots of:

  • Virtualpaper’s data directory
  • (Virtualpaper’s config file) - Postgresql database
  • (Optional) Meilisearch index

Backing up config file is recommended unless using ENV variables. In such case web access tokens are invalidated if api.api_key is not saved and provided with ENV variable).

It is sufficient to back up the Postgresql database by either backing up the postgresql data directory or by taking a database dump:

pg_dump virtualpaper > virtualpaper.sql

Virtualpaper data storage can be backed up as such. Meilisearch does have a backup functionality, but it is not necessary and Meilisearch index can always be re-creaeted by Virtualpaper administrator. For more information on search index, see how to re-build the search index

Manually extracting documents from the data directory

Please refer to administrating/internals for more information on how to extract the relevant data from database.