spc-pleroma/docs/administration/updating.md

# 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` [^1]. This pulls the latest changes from upstream.
3. Run `mix deps.get` [^1]. This pulls in any new dependencies.
4. Stop the Pleroma service.
5. Run `mix ecto.migrate` [^1] [^2]. This task performs database migrations, if there were any.
6. Start the Pleroma service.

[^1]: Depending on which install guide you followed (for example on Debian/Ubuntu), you want to run `git` and `mix` tasks as `pleroma` user by adding `sudo -Hu pleroma` before the command.
[^2]: Prefix with `MIX_ENV=prod` to run it using the production config file.
Move out of Gitlab Wiki I understand that this change is quite unreadable and hard to review, sorry for forgetting to do atomic commits. This patch does not change too much content wise, it just * Gets everything from gitlab wiki * Removes some specific gitlab hacks * Formats all documentation file names to be in snake case so they look the same way as our code does 2019-03-28 16:46:30 +00:00			`# Updating your instance`
Add OTP to updating.md * I removed the Update section from the OTP install and added it to updating.md * I also added a link to the updating.md from the OTP install page * I added a Questions section to the OTP install, similar to the debian_based_en.md * Restructured the updating.md a bit I would very much also like to link to the changelog, but I don't know how to do it because I can't find the page in the docs? 2020-01-15 08:12:24 +00:00
added link to changelog, removed repetition 2020-07-09 03:15:51 +00:00			`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.`
Add OTP to updating.md * I removed the Update section from the OTP install and added it to updating.md * I also added a link to the updating.md from the OTP install page * I added a Questions section to the OTP install, similar to the debian_based_en.md * Restructured the updating.md a bit I would very much also like to link to the changelog, but I don't know how to do it because I can't find the page in the docs? 2020-01-15 08:12:24 +00:00
			`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)`

Instruct to stop the service only after git pulling and getting deps to minimize downtimes 2019-04-01 13:23:32 +00:00			1. Go to the working directory of Pleroma (default is `/opt/pleroma`)
Instruct users to run 'git pull' as the pleroma user 2022-05-12 16:02:58 +00:00			2. Run `git pull` [^1]. This pulls the latest changes from upstream.
Add mention of sudo -Hu pleroma to docs 2020-08-28 13:50:21 +00:00			3. Run `mix deps.get` [^1]. This pulls in any new dependencies.
Instruct to stop the service only after git pulling and getting deps to minimize downtimes 2019-04-01 13:23:32 +00:00			`4. Stop the Pleroma service.`
Add mention of sudo -Hu pleroma to docs 2020-08-28 13:50:21 +00:00			5. Run `mix ecto.migrate` [^1] [^2]. This task performs database migrations, if there were any.
restart makes no sense here as we instructed to stop the service before 2019-04-01 13:26:46 +00:00			`6. Start the Pleroma service.`
Move out of Gitlab Wiki I understand that this change is quite unreadable and hard to review, sorry for forgetting to do atomic commits. This patch does not change too much content wise, it just * Gets everything from gitlab wiki * Removes some specific gitlab hacks * Formats all documentation file names to be in snake case so they look the same way as our code does 2019-03-28 16:46:30 +00:00
Instruct users to run 'git pull' as the pleroma user 2022-05-12 16:02:58 +00:00			[^1]: Depending on which install guide you followed (for example on Debian/Ubuntu), you want to run `git` and `mix` tasks as `pleroma` user by adding `sudo -Hu pleroma` before the command.
Add mention of sudo -Hu pleroma to docs 2020-08-28 13:50:21 +00:00			[^2]: Prefix with `MIX_ENV=prod` to run it using the production config file.