summaryrefslogtreecommitdiff
path: root/docs/admin/backup.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/admin/backup.md')
-rw-r--r--docs/admin/backup.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/admin/backup.md b/docs/admin/backup.md
new file mode 100644
index 000000000..b373996f5
--- /dev/null
+++ b/docs/admin/backup.md
@@ -0,0 +1,15 @@
+# Backup your instance
+
+1. Stop the Pleroma service.
+2. Go to the working directory of Pleroma (default is `/opt/pleroma`)
+3. Run `sudo -Hu postgres pg_dump -d <pleroma_db> --format=custom -f </path/to/backup_location/pleroma.pgdump>`
+4. Copy `pleroma.pgdump`, `config/prod.secret.exs` and the `uploads` folder to your backup destination. If you have other modifications, copy those changes too.
+5. Restart the Pleroma service.
+
+## Restore your instance
+
+1. Stop the Pleroma service.
+2. Go to the working directory of Pleroma (default is `/opt/pleroma`)
+3. Copy the above mentioned files back to their original position.
+4. Run `sudo -Hu postgres pg_restore -d <pleroma_db> -v -1 </path/to/backup_location/pleroma.pgdump>`
+5. Restart the Pleroma service.