include frontend installation document on all install guides
authorFloatingGhost <hannah@coffee-and-dreams.uk>
Tue, 30 Aug 2022 09:56:33 +0000 (10:56 +0100)
committerFloatingGhost <hannah@coffee-and-dreams.uk>
Tue, 30 Aug 2022 09:56:33 +0000 (10:56 +0100)
13 files changed:
docs/docs/configuration/cheatsheet.md
docs/docs/installation/alpine_linux_en.md
docs/docs/installation/arch_linux_en.md
docs/docs/installation/debian_based_en.md
docs/docs/installation/fedora_based_en.md
docs/docs/installation/freebsd_en.md
docs/docs/installation/frontends.include [new file with mode: 0644]
docs/docs/installation/gentoo_en.md
docs/docs/installation/migrating_to_akkoma.md
docs/docs/installation/netbsd_en.md
docs/docs/installation/openbsd_en.md
docs/docs/installation/otp_en.md
docs/docs/installation/otp_redhat_en.md

index 90041d3d64e85b2f420fa453a2ce60d291535084..52062eaa0509057b24d8ce392ad5f1a2c0f9a89c 100644 (file)
@@ -1183,4 +1183,4 @@ Translations are available at `/api/v1/statuses/:id/translations/:language`, whe
 ### `:libre_translate`
 
 - `:url` - URL of LibreTranslate instance
-- `:api_key` - API key for LibreTranslate
\ No newline at end of file
+- `:api_key` - API key for LibreTranslate
index f98998fb8cdf828594fc83cf6289eefd63210f44..aae8f9626086209304a5d95c236e419b9234e6da 100644 (file)
@@ -221,6 +221,8 @@ If your instance is up and running, you can create your first user with administ
 doas -u akkoma env MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
 ```
 
+{! installation/frontends.include !}
+
 #### Further reading
 
 {! installation/further_reading.include !}
index f7a7d62391500d94d50544b6fe1e3380b153204e..639c9c7986e9910a62ffb17fa66feea8f586a20b 100644 (file)
@@ -212,6 +212,8 @@ If your instance is up and running, you can create your first user with administ
 sudo -Hu akkoma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
 ```
 
+{! installation/frontends.include !}
+
 #### Further reading
 
 {! installation/further_reading.include !}
index 40503db0ce46e5d9fe68c5bed0d076eae8282d39..139c789bc7767495d7f13271607887bff46bb7b3 100644 (file)
@@ -175,6 +175,8 @@ If your instance is up and running, you can create your first user with administ
 sudo -Hu akkoma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
 ```
 
+{! installation/frontends.include !}
+
 #### Further reading
 
 {! installation/further_reading.include !}
index 30d68d97fb444941ef44d15cec6937bb39741795..d8c7b3e743b4b795eb2cb35e16de847527caedce 100644 (file)
@@ -199,6 +199,8 @@ If your instance is up and running, you can create your first user with administ
 sudo -Hu akkoma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
 ```
 
+{! installation/frontends.include !}
+
 #### Further reading
 
 {! installation/further_reading.include !}
index be735a998476be222784c9faf0a3b8ef465ec219..53c029d275fc8e01b5882000edcfeaceeae91ab8 100644 (file)
@@ -206,6 +206,9 @@ If your instance is up and running, you can create your first user with administ
 ```shell
 sudo -Hu akkoma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
 ```
+
+{! installation/frontends.include !}
+
 ## Conclusion
 
 Restart nginx with `# service nginx restart` and you should be up and running.
diff --git a/docs/docs/installation/frontends.include b/docs/docs/installation/frontends.include
new file mode 100644 (file)
index 0000000..585be71
--- /dev/null
@@ -0,0 +1,25 @@
+#### Installing Frontends
+
+Once your backend server is functional, you'll also want to
+probably install frontends.
+
+These are no longer bundled with the distribution and need an extra
+command to install.
+
+For most installations, the following will suffice:
+
+=== "OTP" 
+    ```sh
+    ./bin/pleroma_ctl frontend install pleroma-fe --ref stable
+    # and also, if desired
+    ./bin/pleroma_ctl frontend install admin-fe --ref stable
+    ```
+
+=== "From Source"
+    ```sh
+    mix pleroma.frontend install pleroma-fe --ref stable
+    mix pleroma.frontend install admin-fe --ref stable
+    ```
+
+For more customised installations, refer to [Frontend Management](../../configuration/frontend_management)
+
index 4649b63bfca0e2b2aabeba8b0c0db9007e761b53..9450c9b3864ea54f9ec656cbb27d9f4048cdf409 100644 (file)
@@ -293,6 +293,8 @@ akkoma$ MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
 
 If you opted to allow sudo for the `akkoma` user but would like to remove the ability for greater security, now might be a good time to edit `/etc/sudoers` and/or change the groups the `akkoma` user belongs to. Be sure to restart the akkoma service afterwards to ensure it picks up on the changes.
 
+{! installation/frontends.include !}
+
 #### Further reading
 
 {! installation/further_reading.include !}
index 74b87e318d07e4c4d47175b05e1f106e3319c64d..d8ea0ea25ae65f22326fbc76941d40cf261475ed 100644 (file)
@@ -1,7 +1,5 @@
 # Migrating to Akkoma
 
-**Akkoma does not currently have a stable release, until 3.0, all builds should be considered "develop"**
-
 ## Why should you migrate?
 
 aside from actually responsive maintainer(s)? let's lookie here, we've got:
@@ -11,6 +9,8 @@ aside from actually responsive maintainer(s)? let's lookie here, we've got:
 - elasticsearch support (because pleroma search is GARBAGE)
 - latest develop pleroma-fe additions
 - local-only posting
+- automatic post translation
+- the mastodon frontend back in all its glory
 - probably more, this is like 3.5 years of IHBA additions finally compiled
 
 ## Actually migrating
@@ -43,14 +43,14 @@ This will just be setting the update URL - find your flavour from the [mapping o
 ```bash
 export FLAVOUR=[the flavour you found above]
 
-./bin/pleroma_ctl update --zip-url https://akkoma-updates.s3-website.fr-par.scw.cloud/develop/akkoma-$FLAVOUR.zip
+./bin/pleroma_ctl update --zip-url https://akkoma-updates.s3-website.fr-par.scw.cloud/stable/akkoma-$FLAVOUR.zip
 ./bin/pleroma_ctl migrate
 ```
 
 Then restart. When updating in the future, you canjust use
 
 ```bash
-./bin/pleroma_ctl update --branch develop
+./bin/pleroma_ctl update --branch stable
 ```
 
 ## Frontend changes
@@ -62,17 +62,18 @@ your upgrade path here depends on your setup
 
 You'll need to run a couple of commands,
 
-```bash
-# From source
-mix pleroma.frontend install pleroma-fe
-# you'll probably want this too
-mix pleroma.frontend install admin-fe
-
-# OTP
-./bin/pleroma_ctl frontend install pleroma-fe
-# you'll probably want this too
-./bin/pleroma_ctl frontend install admin-fe
-```
+=== "OTP"
+    ```sh
+    ./bin/pleroma_ctl frontend install pleroma-fe --ref stable
+    # and also, if desired
+    ./bin/pleroma_ctl frontend install admin-fe --ref stable
+    ```
+
+=== "From Source"
+    ```sh
+    mix pleroma.frontend install pleroma-fe --ref stable
+    mix pleroma.frontend install admin-fe --ref stable
+    ```
 
 ### I've run the mix task to install a frontend
 
index c00a32e343ca536892c5f3658c0590bab5865372..f13a3ee8947dc46c1b0d8d1f85a6c85828fed528 100644 (file)
@@ -202,6 +202,8 @@ incorrect timestamps. You should have ntpd running.
 
 * <https://catgirl.science>
 
+{! installation/frontends.include !}
+
 #### Further reading
 
 {! installation/further_reading.include !}
index c7e8cf0c09b3136eb31d2304448b737f7d19c863..581942f9902238edf05afd215f70f4e9a9f724b7 100644 (file)
@@ -250,6 +250,8 @@ If your instance is up and running, you can create your first user with administ
 LC_ALL=en_US.UTF-8 MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
 ```
 
+{! installation/frontends.include !}
+
 #### Further reading
 
 {! installation/further_reading.include !}
index 022716fec881d8a6d4239abca8f9a738e703a64d..329afe967de0ae3d1d967f6a2acc32f0b4615ecb 100644 (file)
@@ -306,6 +306,8 @@ su akkoma -s $SHELL -lc "./bin/pleroma_ctl user new joeuser joeuser@sld.tld --ad
 ```
 This will create an account withe the username of 'joeuser' with the email address of joeuser@sld.tld, and set that user's account as an admin. This will result in a link that you can paste into the browser, which logs you in and enables you to set the password.
 
+{! installation/frontends.include !}
+
 ## Further reading
 
 {! installation/further_reading.include !}
index 2e6b58c9e4ccc6460a94fdbdb507573bed36a385..ec6c30bcf99f224aabb9c8da8b099724a0813b15 100644 (file)
@@ -279,6 +279,7 @@ After that, run the `pleroma_ctl migrate` command as usual to perform database m
 
 As it currently stands, your OTP build will only be compatible for the specific RedHat distribution you've built it on. Fedora builds only work on Fedora, Centos builds only on Centos, RedHat builds only on RedHat. Secondly, for Fedora, they will also be bound to the specific Fedora release. This is because different releases of Fedora may have significant changes made in some of the required packages and libraries.
 
+{! installation/frontends.include !}
 
 {! installation/further_reading.include !}