akkoma/docs/administration/updating.md
norm 0e344ac8bb
All checks were successful
ci/woodpecker/push/lint Pipeline was successful
ci/woodpecker/push/test Pipeline was successful
ci/woodpecker/push/release Pipeline was successful
Update administration docs (#39)
Reviewed-on: #39
Co-authored-by: norm <normandy@biribiri.dev>
Co-committed-by: norm <normandy@biribiri.dev>
2022-07-03 15:18:43 +00:00

1.2 KiB

Updating your instance

You should always check the release notes/changelog in case there are config deprecations, special update steps, etc.

Besides that, doing the following is generally enough:

For OTP installations

# Download the new release
su akkoma -s $SHELL -lc "./bin/pleroma_ctl update"

# Migrate the database, you are advised to stop the instance before doing that
su akkoma -s $SHELL -lc "./bin/pleroma_ctl migrate"

For from source installations (using git)

  1. Go to the working directory of Akkoma (default is /opt/akkoma)
  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 Akkoma service.
  5. Run mix ecto.migrate 1 2. This task performs database migrations, if there were any.
  6. Start the Akkoma service.

  1. Depending on which install guide you followed (for example on Debian/Ubuntu), you want to run git and mix tasks as akkoma user by adding sudo -Hu akkoma before the command. ↩︎

  2. Prefix with MIX_ENV=prod to run it using the production config file. ↩︎