From 25111bb407f9e94939160258f8a8ad59ed04f93f Mon Sep 17 00:00:00 2001 From: FloatingGhost Date: Tue, 30 Aug 2022 10:56:33 +0100 Subject: [PATCH] include frontend installation document on all install guides --- docs/docs/configuration/cheatsheet.md | 2 +- docs/docs/installation/alpine_linux_en.md | 2 ++ docs/docs/installation/arch_linux_en.md | 2 ++ docs/docs/installation/debian_based_en.md | 2 ++ docs/docs/installation/fedora_based_en.md | 2 ++ docs/docs/installation/freebsd_en.md | 3 ++ docs/docs/installation/frontends.include | 25 ++++++++++++++++ docs/docs/installation/gentoo_en.md | 2 ++ docs/docs/installation/migrating_to_akkoma.md | 29 ++++++++++--------- docs/docs/installation/netbsd_en.md | 2 ++ docs/docs/installation/openbsd_en.md | 2 ++ docs/docs/installation/otp_en.md | 2 ++ docs/docs/installation/otp_redhat_en.md | 1 + 13 files changed, 61 insertions(+), 15 deletions(-) create mode 100644 docs/docs/installation/frontends.include diff --git a/docs/docs/configuration/cheatsheet.md b/docs/docs/configuration/cheatsheet.md index 90041d3d6..52062eaa0 100644 --- a/docs/docs/configuration/cheatsheet.md +++ b/docs/docs/configuration/cheatsheet.md @@ -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 diff --git a/docs/docs/installation/alpine_linux_en.md b/docs/docs/installation/alpine_linux_en.md index f98998fb8..aae8f9626 100644 --- a/docs/docs/installation/alpine_linux_en.md +++ b/docs/docs/installation/alpine_linux_en.md @@ -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 --admin ``` +{! installation/frontends.include !} + #### Further reading {! installation/further_reading.include !} diff --git a/docs/docs/installation/arch_linux_en.md b/docs/docs/installation/arch_linux_en.md index f7a7d6239..639c9c798 100644 --- a/docs/docs/installation/arch_linux_en.md +++ b/docs/docs/installation/arch_linux_en.md @@ -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 --admin ``` +{! installation/frontends.include !} + #### Further reading {! installation/further_reading.include !} diff --git a/docs/docs/installation/debian_based_en.md b/docs/docs/installation/debian_based_en.md index 40503db0c..139c789bc 100644 --- a/docs/docs/installation/debian_based_en.md +++ b/docs/docs/installation/debian_based_en.md @@ -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 --admin ``` +{! installation/frontends.include !} + #### Further reading {! installation/further_reading.include !} diff --git a/docs/docs/installation/fedora_based_en.md b/docs/docs/installation/fedora_based_en.md index 30d68d97f..d8c7b3e74 100644 --- a/docs/docs/installation/fedora_based_en.md +++ b/docs/docs/installation/fedora_based_en.md @@ -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 --admin ``` +{! installation/frontends.include !} + #### Further reading {! installation/further_reading.include !} diff --git a/docs/docs/installation/freebsd_en.md b/docs/docs/installation/freebsd_en.md index be735a998..53c029d27 100644 --- a/docs/docs/installation/freebsd_en.md +++ b/docs/docs/installation/freebsd_en.md @@ -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 --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 index 000000000..585be71ae --- /dev/null +++ b/docs/docs/installation/frontends.include @@ -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) + diff --git a/docs/docs/installation/gentoo_en.md b/docs/docs/installation/gentoo_en.md index 4649b63bf..9450c9b38 100644 --- a/docs/docs/installation/gentoo_en.md +++ b/docs/docs/installation/gentoo_en.md @@ -293,6 +293,8 @@ akkoma$ MIX_ENV=prod mix pleroma.user new --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 !} diff --git a/docs/docs/installation/migrating_to_akkoma.md b/docs/docs/installation/migrating_to_akkoma.md index 74b87e318..d8ea0ea25 100644 --- a/docs/docs/installation/migrating_to_akkoma.md +++ b/docs/docs/installation/migrating_to_akkoma.md @@ -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" + ```sh + ./bin/pleroma_ctl frontend install pleroma-fe --ref stable + # and also, if desired + ./bin/pleroma_ctl frontend install admin-fe --ref stable + ``` -# OTP -./bin/pleroma_ctl frontend install pleroma-fe -# you'll probably want this too -./bin/pleroma_ctl frontend install admin-fe -``` +=== "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 diff --git a/docs/docs/installation/netbsd_en.md b/docs/docs/installation/netbsd_en.md index c00a32e34..f13a3ee89 100644 --- a/docs/docs/installation/netbsd_en.md +++ b/docs/docs/installation/netbsd_en.md @@ -202,6 +202,8 @@ incorrect timestamps. You should have ntpd running. * +{! installation/frontends.include !} + #### Further reading {! installation/further_reading.include !} diff --git a/docs/docs/installation/openbsd_en.md b/docs/docs/installation/openbsd_en.md index c7e8cf0c0..581942f99 100644 --- a/docs/docs/installation/openbsd_en.md +++ b/docs/docs/installation/openbsd_en.md @@ -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 --admin ``` +{! installation/frontends.include !} + #### Further reading {! installation/further_reading.include !} diff --git a/docs/docs/installation/otp_en.md b/docs/docs/installation/otp_en.md index 022716fec..329afe967 100644 --- a/docs/docs/installation/otp_en.md +++ b/docs/docs/installation/otp_en.md @@ -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 !} diff --git a/docs/docs/installation/otp_redhat_en.md b/docs/docs/installation/otp_redhat_en.md index 2e6b58c9e..ec6c30bcf 100644 --- a/docs/docs/installation/otp_redhat_en.md +++ b/docs/docs/installation/otp_redhat_en.md @@ -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 !}