From 0d92648d62ea591301d7f04b32878a95d17c23b9 Mon Sep 17 00:00:00 2001 From: quantenProjects Date: Thu, 16 Nov 2023 01:26:52 +0100 Subject: [PATCH] Documentation: Structure backup section more clearly (#4559) --------- Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com> --- .prettierrc | 2 +- docs/administration.md | 82 +++++++++++++++++++++++------------------- 2 files changed, 46 insertions(+), 38 deletions(-) diff --git a/.prettierrc b/.prettierrc index b0d7223f8..c7b03967b 100644 --- a/.prettierrc +++ b/.prettierrc @@ -7,7 +7,7 @@ "trailingComma": "es5", "overrides": [ { - "files": "index.md", + "files": ["index.md", "administration.md"], "options": { "tabWidth": 4 } diff --git a/docs/administration.md b/docs/administration.md index 29f4fb60a..354c380e3 100644 --- a/docs/administration.md +++ b/docs/administration.md @@ -5,17 +5,19 @@ Multiple options exist for making backups of your paperless instance, depending on how you installed paperless. -Before making backups, make sure that paperless is not running. +Before making a backup, it's probably best to make sure that paperless is not actively +consuming documents at that time. Options available to any installation of paperless: -- Use the [document exporter](#exporter). The document exporter exports all your documents, - thumbnails, metadata, and database contents to a specific folder. You may import your - documents and settings into a fresh instance of paperless again or store your - documents in another DMS with this export. -- The document exporter is also able to update an already existing - export. Therefore, incremental backups with `rsync` are entirely - possible. +- Use the [document exporter](#exporter). The document exporter exports all your documents, + thumbnails, metadata, and database contents to a specific folder. You may import your + documents and settings into a fresh instance of paperless again or store your + documents in another DMS with this export. + + The document exporter is also able to update an already existing + export. Therefore, incremental backups with `rsync` are entirely + possible. !!! caution @@ -25,31 +27,37 @@ Options available to any installation of paperless: Options available to docker installations: -- Backup the docker volumes. These usually reside within - `/var/lib/docker/volumes` on the host and you need to be root in - order to access them. +- Backup the docker volumes. These usually reside within + `/var/lib/docker/volumes` on the host and you need to be root in + order to access them. - Paperless uses 4 volumes: + Paperless uses 4 volumes: - - `paperless_media`: This is where your documents are stored. - - `paperless_data`: This is where auxillary data is stored. This - folder also contains the SQLite database, if you use it. - - `paperless_pgdata`: Exists only if you use PostgreSQL and - contains the database. - - `paperless_dbdata`: Exists only if you use MariaDB and contains - the database. + - `paperless_media`: This is where your documents are stored. + - `paperless_data`: This is where auxillary data is stored. This + folder also contains the SQLite database, if you use it. + - `paperless_pgdata`: Exists only if you use PostgreSQL and + contains the database. + - `paperless_dbdata`: Exists only if you use MariaDB and contains + the database. Options available to bare-metal and non-docker installations: -- Backup the entire paperless folder. This ensures that if your - paperless instance crashes at some point or your disk fails, you can - simply copy the folder back into place and it works. +- Backup the entire paperless folder. This ensures that if your + paperless instance crashes at some point or your disk fails, you can + simply copy the folder back into place and it works. - When using PostgreSQL or MariaDB, you'll also have to backup the - database. + When using PostgreSQL or MariaDB, you'll also have to backup the + database. ### Restoring {#migrating-restoring} +If you've backed-up Paperless-ngx using the [document exporter](#exporter), +restoring can simply be done with the [document importer](#importer). + +Of course, other backup strategies require restoring any volumes, folders and database +copies you created in the steps above. + ## Updating Paperless {#updating} ### Docker Route {#docker-updating} @@ -470,19 +478,19 @@ collection for issues. The issues detected by the sanity checker are as follows: -- Missing original files. -- Missing archive files. -- Inaccessible original files due to improper permissions. -- Inaccessible archive files due to improper permissions. -- Corrupted original documents by comparing their checksum against - what is stored in the database. -- Corrupted archive documents by comparing their checksum against what - is stored in the database. -- Missing thumbnails. -- Inaccessible thumbnails due to improper permissions. -- Documents without any content (warning). -- Orphaned files in the media directory (warning). These are files - that are not referenced by any document in paperless. +- Missing original files. +- Missing archive files. +- Inaccessible original files due to improper permissions. +- Inaccessible archive files due to improper permissions. +- Corrupted original documents by comparing their checksum against + what is stored in the database. +- Corrupted archive documents by comparing their checksum against what + is stored in the database. +- Missing thumbnails. +- Inaccessible thumbnails due to improper permissions. +- Documents without any content (warning). +- Orphaned files in the media directory (warning). These are files + that are not referenced by any document in paperless. ``` document_sanity_checker