Merge branch 'develop' into fix/csp-for-captcha
[akkoma] / docs / administration / updating.md
index 84e6ef18d6e5ff204a313f213f09b03e4828d872..c994f3f16c0ddd5ed7e360125737b47f582ebe99 100644 (file)
@@ -1,4 +1,21 @@
 # Updating your instance
+
+You should **always check the [release notes/changelog](https://git.pleroma.social/pleroma/pleroma/-/releases)** in case there are config deprecations, 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.