aboutsummaryrefslogtreecommitdiff
path: root/docs/admin
diff options
context:
space:
mode:
authorEgor Kislitsyn <egor@kislitsyn.com>2019-04-02 15:41:30 +0700
committerEgor Kislitsyn <egor@kislitsyn.com>2019-04-02 15:41:30 +0700
commita1869f5272ddd83cdf2b2fc487668de79f2d0c6d (patch)
treedef42bef14e8ced310471a194080e38cbee15452 /docs/admin
parent16e598ec11cb9178b9fc53a1ec4b649d97c5f3b8 (diff)
parentf8aa917eef9280631a5cd2c95cf1db8fab6e14e5 (diff)
downloadpleroma-a1869f5272ddd83cdf2b2fc487668de79f2d0c6d.tar.gz
Merge remote-tracking branch 'pleroma/develop' into remove-user-activities
Diffstat (limited to 'docs/admin')
-rw-r--r--docs/admin/backup.md17
-rw-r--r--docs/admin/updating.md9
2 files changed, 26 insertions, 0 deletions
diff --git a/docs/admin/backup.md b/docs/admin/backup.md
new file mode 100644
index 000000000..2c70e7bf8
--- /dev/null
+++ b/docs/admin/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/admin/updating.md b/docs/admin/updating.md
new file mode 100644
index 000000000..84e6ef18d
--- /dev/null
+++ b/docs/admin/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.