Merge branch 'develop' of https://git.pleroma.social/pleroma/pleroma into develop
[akkoma] / docs / administration / updating.md
1 # Updating your instance
2
3 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.
4
5 Besides that, doing the following is generally enough:
6
7 ## For OTP installations
8
9 ```sh
10 # Download the new release
11 su pleroma -s $SHELL -lc "./bin/pleroma_ctl update"
12
13 # Migrate the database, you are advised to stop the instance before doing that
14 su pleroma -s $SHELL -lc "./bin/pleroma_ctl migrate"
15 ```
16
17 ## For from source installations (using git)
18
19 1. Go to the working directory of Pleroma (default is `/opt/pleroma`)
20 2. Run `git pull`. This pulls the latest changes from upstream.
21 3. Run `mix deps.get` [^1]. This pulls in any new dependencies.
22 4. Stop the Pleroma service.
23 5. Run `mix ecto.migrate` [^1] [^2]. This task performs database migrations, if there were any.
24 6. Start the Pleroma service.
25
26 [^1]: Depending on which install guide you followed (for example on Debian/Ubuntu), you want to run `mix` tasks as `pleroma` user by adding `sudo -Hu pleroma` before the command.
27 [^2]: Prefix with `MIX_ENV=prod` to run it using the production config file.