summaryrefslogtreecommitdiff
path: root/docs/administration
diff options
context:
space:
mode:
authorrinpatch <rinpatch@sdf.org>2019-10-02 23:28:45 +0300
committerrinpatch <rinpatch@sdf.org>2019-10-02 23:28:45 +0300
commitacc62f327d45c0a9a0414da56bc339ec3e22cb63 (patch)
tree6ac0fbfc1c489e7e1823562f1717b29bf875d593 /docs/administration
parentc5e937b156ea1f8f96ade7d9104fc2c5fd1dd9cd (diff)
downloadpleroma-acc62f327d45c0a9a0414da56bc339ec3e22cb63.tar.gz
pleroma-acc62f327d45c0a9a0414da56bc339ec3e22cb63.zip
Rename some directories because MkDocs uses them for categories
Diffstat (limited to 'docs/administration')
-rw-r--r--docs/administration/backup.md17
-rw-r--r--docs/administration/updating.md9
2 files changed, 26 insertions, 0 deletions
diff --git a/docs/administration/backup.md b/docs/administration/backup.md
new file mode 100644
index 000000000..2c70e7bf8
--- /dev/null
+++ b/docs/administration/backup.md
@@ -0,0 +1,17 @@
+# Backup/Restore your instance
+
+## Backup
+
+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
+
+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.
diff --git a/docs/administration/updating.md b/docs/administration/updating.md
new file mode 100644
index 000000000..84e6ef18d
--- /dev/null
+++ b/docs/administration/updating.md
@@ -0,0 +1,9 @@
+# Updating your instance
+1. Go to the working directory of Pleroma (default is `/opt/pleroma`)
+2. Run `git pull`. This pulls the latest changes from upstream.
+3. Run `mix deps.get`. This pulls in any new dependencies.
+4. Stop the Pleroma service.
+5. Run `mix ecto.migrate`[^1]. This task performs database migrations, if there were any.
+6. Start the Pleroma service.
+
+[^1]: Prefix with `MIX_ENV=prod` to run it using the production config file.