From: Norm <normandy@biribiri.dev>
Date: Wed, 14 Dec 2022 03:03:08 +0000 (+0000)
Subject: Update the "Updating your instance" docs (#361)
X-Git-Url: https://git.squeep.com/?a=commitdiff_plain;h=53f21489a2f9737dc2a7f55417f9d9901f750107;p=akkoma

Update the "Updating your instance" docs (#361)

This makes them consistent with the update instructions that are in the
release announcements.

Also adds in the command to update the frontend as well.

Co-authored-by: Francis Dinh <normandy@biribiri.dev>
Reviewed-on: https://akkoma.dev/AkkomaGang/akkoma/pulls/361
Co-authored-by: Norm <normandy@biribiri.dev>
Co-committed-by: Norm <normandy@biribiri.dev>
---

diff --git a/docs/docs/administration/updating.md b/docs/docs/administration/updating.md
index 2d9e77075..52979a1f5 100644
--- a/docs/docs/administration/updating.md
+++ b/docs/docs/administration/updating.md
@@ -3,15 +3,34 @@
 You should **always check the [release notes/changelog](https://akkoma.dev/AkkomaGang/akkoma/src/branch/develop/CHANGELOG.md)** in case there are config deprecations, special update steps, etc.
 
 Besides that, doing the following is generally enough:
+## Switch to the akkoma user
+```sh
+# Using sudo
+sudo -su akkoma
 
-## For OTP installations
+# Using doas
+doas -su akkoma
+
+# Using su
+su -s "$SHELL" akkoma
+```
 
+## For OTP installations
 ```sh
-# Download the new release
-su akkoma -s $SHELL -lc "./bin/pleroma_ctl update" 
+# Download latest stable release
+./bin/pleroma_ctl update --branch stable
+
+# Stop akkoma
+./bin/pleroma stop # or using the system service manager (e.g. systemctl stop akkoma)
+
+# Run database migrations
+./bin/pleroma_ctl migrate
+
+# Update frontend(s). See Frontend Configuration doc for more information.
+./bin/pleroma_ctl frontend install pleroma-fe --ref stable
 
-# Migrate the database, you are advised to stop the instance before doing that
-su akkoma -s $SHELL -lc "./bin/pleroma_ctl migrate"
+# Start akkoma
+./bin/pleroma daemon # or using the system service manager (e.g. systemctl start akkoma)
 ```
 
 If you selected an alternate flavour on installation, 
@@ -19,13 +38,28 @@ you _may_ need to specify `--flavour`, in the same way as
 [when installing](../../installation/otp_en#detecting-flavour).
 
 ## For from source installations (using git)
+Run as the `akkoma` user:
 
-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.
+```sh
+# Pull in new changes
+git pull
+
+# Run with production configuration
+export MIX_ENV=prod
+
+# Download and compile dependencies
+mix deps.get
+mix compile
+
+# Stop akkoma (replace with your system service manager's equivalent if different)
+sudo systemctl stop akkoma
 
-[^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.
+# Run database migrations
+mix ecto.migrate
+
+# Update frontend(s). See Frontend Configration doc for more information.
+mix pleroma.frontend install pleroma-fe --ref stable
+
+# Start akkoma (replace with your system service manager's equivalent if different)
+sudo systemctl start akkoma
+```