diff options
Diffstat (limited to 'docs/administration/updating.md')
| -rw-r--r-- | docs/administration/updating.md | 26 |
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. |