summaryrefslogtreecommitdiff
path: root/docs/admin
diff options
context:
space:
mode:
authorlambda <lain@soykaf.club>2019-03-29 10:24:52 +0000
committerlambda <lain@soykaf.club>2019-03-29 10:24:52 +0000
commit749d53e2b2ffb108964c569f04e5989c63643338 (patch)
tree5c765f1be631734c99e690fbefc1906eb487f208 /docs/admin
parent52bec238c3c80a246eb269de9afb1f9b3ea58f4f (diff)
parent634e09e1a8d0c26ad9a89875e3f713a0bf07ea3e (diff)
downloadpleroma-749d53e2b2ffb108964c569f04e5989c63643338.tar.gz
pleroma-749d53e2b2ffb108964c569f04e5989c63643338.zip
Merge branch 'sayonara-gitlab-wiki' into 'develop'
Move out of Gitlab Wiki See merge request pleroma/pleroma!990
Diffstat (limited to 'docs/admin')
-rw-r--r--docs/admin/backup.md15
-rw-r--r--docs/admin/updating.md9
2 files changed, 24 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.
diff --git a/docs/admin/updating.md b/docs/admin/updating.md
new file mode 100644
index 000000000..33ce1ab4f
--- /dev/null
+++ b/docs/admin/updating.md
@@ -0,0 +1,9 @@
+# Updating your instance
+1. Stop the Pleroma service.
+2. Go to the working directory of Pleroma (default is `/opt/pleroma`)
+3. Run `git pull`. This pulls the latest changes from upstream.
+4. Run `mix deps.get`. This pulls in any new dependencies.
+5. Run `mix ecto.migrate`[^1]. This task performs database migrations, if there were any.
+6. Restart the Pleroma service.
+
+[^1]: Prefix with `MIX_ENV=prod` to run it using the production config file.