5
5
Multiple options exist for making backups of your paperless instance,
6
6
depending on how you installed paperless.
7
7
8
- Before making backups, make sure that paperless is not running.
8
+ Before making a backup, it's probably best to make sure that paperless is not actively
9
+ consuming documents at that time.
9
10
10
11
Options available to any installation of paperless:
11
12
12
- - Use the [ document exporter] ( #exporter ) . The document exporter exports all your documents,
13
- thumbnails, metadata, and database contents to a specific folder. You may import your
14
- documents and settings into a fresh instance of paperless again or store your
15
- documents in another DMS with this export.
16
- - The document exporter is also able to update an already existing
17
- export. Therefore, incremental backups with ` rsync ` are entirely
18
- possible.
13
+ - Use the [ document exporter] ( #exporter ) . The document exporter exports all your documents,
14
+ thumbnails, metadata, and database contents to a specific folder. You may import your
15
+ documents and settings into a fresh instance of paperless again or store your
16
+ documents in another DMS with this export.
17
+
18
+ The document exporter is also able to update an already existing
19
+ export. Therefore, incremental backups with ` rsync ` are entirely
20
+ possible.
19
21
20
22
!!! caution
21
23
@@ -25,31 +27,37 @@ Options available to any installation of paperless:
25
27
26
28
Options available to docker installations:
27
29
28
- - Backup the docker volumes. These usually reside within
29
- ` /var/lib/docker/volumes ` on the host and you need to be root in
30
- order to access them.
30
+ - Backup the docker volumes. These usually reside within
31
+ ` /var/lib/docker/volumes ` on the host and you need to be root in
32
+ order to access them.
31
33
32
- Paperless uses 4 volumes:
34
+ Paperless uses 4 volumes:
33
35
34
- - ` paperless_media ` : This is where your documents are stored.
35
- - ` paperless_data ` : This is where auxillary data is stored. This
36
- folder also contains the SQLite database, if you use it.
37
- - ` paperless_pgdata ` : Exists only if you use PostgreSQL and
38
- contains the database.
39
- - ` paperless_dbdata ` : Exists only if you use MariaDB and contains
40
- the database.
36
+ - ` paperless_media ` : This is where your documents are stored.
37
+ - ` paperless_data ` : This is where auxillary data is stored. This
38
+ folder also contains the SQLite database, if you use it.
39
+ - ` paperless_pgdata ` : Exists only if you use PostgreSQL and
40
+ contains the database.
41
+ - ` paperless_dbdata ` : Exists only if you use MariaDB and contains
42
+ the database.
41
43
42
44
Options available to bare-metal and non-docker installations:
43
45
44
- - Backup the entire paperless folder. This ensures that if your
45
- paperless instance crashes at some point or your disk fails, you can
46
- simply copy the folder back into place and it works.
46
+ - Backup the entire paperless folder. This ensures that if your
47
+ paperless instance crashes at some point or your disk fails, you can
48
+ simply copy the folder back into place and it works.
47
49
48
- When using PostgreSQL or MariaDB, you'll also have to backup the
49
- database.
50
+ When using PostgreSQL or MariaDB, you'll also have to backup the
51
+ database.
50
52
51
53
### Restoring {#migrating-restoring}
52
54
55
+ If you've backed-up Paperless-ngx using the [ document exporter] ( #exporter ) ,
56
+ restoring can simply be done with the [ document importer] ( #importer ) .
57
+
58
+ Of course, other backup strategies require restoring any volumes, folders and database
59
+ copies you created in the steps above.
60
+
53
61
## Updating Paperless {#updating}
54
62
55
63
### Docker Route {#docker-updating}
@@ -470,19 +478,19 @@ collection for issues.
470
478
471
479
The issues detected by the sanity checker are as follows:
472
480
473
- - Missing original files.
474
- - Missing archive files.
475
- - Inaccessible original files due to improper permissions.
476
- - Inaccessible archive files due to improper permissions.
477
- - Corrupted original documents by comparing their checksum against
478
- what is stored in the database.
479
- - Corrupted archive documents by comparing their checksum against what
480
- is stored in the database.
481
- - Missing thumbnails.
482
- - Inaccessible thumbnails due to improper permissions.
483
- - Documents without any content (warning).
484
- - Orphaned files in the media directory (warning). These are files
485
- that are not referenced by any document in paperless.
481
+ - Missing original files.
482
+ - Missing archive files.
483
+ - Inaccessible original files due to improper permissions.
484
+ - Inaccessible archive files due to improper permissions.
485
+ - Corrupted original documents by comparing their checksum against
486
+ what is stored in the database.
487
+ - Corrupted archive documents by comparing their checksum against what
488
+ is stored in the database.
489
+ - Missing thumbnails.
490
+ - Inaccessible thumbnails due to improper permissions.
491
+ - Documents without any content (warning).
492
+ - Orphaned files in the media directory (warning). These are files
493
+ that are not referenced by any document in paperless.
486
494
487
495
```
488
496
document_sanity_checker
0 commit comments