aboutsummaryrefslogtreecommitdiff
path: root/docs/administration/updating.md
diff options
context:
space:
mode:
authorrinpatch <rinpatch@sdf.org>2020-03-08 10:38:35 +0000
committerrinpatch <rinpatch@sdf.org>2020-03-08 10:38:35 +0000
commite8493431bfc16977e43715bf8bdb09ac46580028 (patch)
tree2e1a0068583ca62870a15590c4ccba237999f51a /docs/administration/updating.md
parent42f76306e7fe69fc51be00285a4fef8569f54989 (diff)
parente7c49d51d724680c1f19888ea409687733753c7b (diff)
downloadpleroma-e8493431bfc16977e43715bf8bdb09ac46580028.tar.gz
Merge branch 'release/2.0.0' into 'stable'v2.0.0
Release/2.0.0 See merge request pleroma/pleroma!2273
Diffstat (limited to 'docs/administration/updating.md')
-rw-r--r--docs/administration/updating.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/administration/updating.md b/docs/administration/updating.md
new file mode 100644
index 000000000..2a08dac1f
--- /dev/null
+++ b/docs/administration/updating.md
@@ -0,0 +1,26 @@
+# Updating your instance
+
+You should **always check the release notes/changelog** in case there are config deprecations, special update special update steps, etc.
+
+Besides that, doing the following is generally enough:
+
+## For OTP installations
+
+```sh
+# Download the new release
+su pleroma -s $SHELL -lc "./bin/pleroma_ctl update"
+
+# Migrate the database, you are advised to stop the instance before doing that
+su pleroma -s $SHELL -lc "./bin/pleroma_ctl migrate"
+```
+
+## For from source installations (using git)
+
+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.