From 98bff188ccd7b861b81c5dbb15c7e4a82f430e58 Mon Sep 17 00:00:00 2001 From: Aris Date: Mon, 30 Jan 2023 10:30:06 +0100 Subject: [PATCH 1/4] Remove frontend note: moved to DISCLAMER.md --- doc/DESCRIPTION.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index 5b3222f..b9937b7 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1,4 +1 @@ -Akkoma is a microblogging server software that can federate (= exchange messages with) other servers that support ActivityPub. What that means is that you can host a server for yourself or your friends and stay in control of your online identity, but still exchange messages with people on larger servers. Akkoma will federate with all servers that implement ActivityPub, like Friendica, GNU Social, Hubzilla, Mastodon, Misskey, Pleroma, Peertube, and Pixelfed. - -**Mastodon web front-end for Akkoma:** Add **/web** in front of your Akkoma domain, eg. akkoma.domain.tld/web - +Akkoma is a microblogging server software that can federate (= exchange messages with) other servers that support ActivityPub. What that means is that you can host a server for yourself or your friends and stay in control of your online identity, but still exchange messages with people on larger decentrilized and federated network. Akkoma will federate with all servers that implement ActivityPub, like Friendica, GNU Social, Hubzilla, Mastodon, Misskey, Pleroma, Peertube, or Pixelfed. From ef99092e94edde96d52201f5276a1350058c1ef9 Mon Sep 17 00:00:00 2001 From: Aris Date: Mon, 30 Jan 2023 10:45:23 +0100 Subject: [PATCH 2/4] Wording + reorganize sections + frontend --- doc/DISCLAIMER.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index 67e807f..a6f4f34 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -1,7 +1,3 @@ -## Login fails if password contains special characters - -See [#4](https://github.com/YunoHost-Apps/akkoma_ynh/issues/4) for more explaination. - ## Limitations - **Akkoma** require a dedicated **root domain**, eg. akkoma.domain.tld @@ -9,6 +5,18 @@ See [#4](https://github.com/YunoHost-Apps/akkoma_ynh/issues/4) for more explaina - This package is currently set to **single-instance** that means you can run a **single Akkoma instance** on a **single server**. - LDAP supported but HTTP auth not. +## Bugs + +**Login fails if password contains special characters** +See [#4](https://github.com/YunoHost-Apps/akkoma_ynh/issues/4) for more explaination. + + +## Customization + +This application come with the default frontend (Pleroma FE) and admin interface pre-installed and activated. There is also the Mangane front-end who is installed but not active. Note that you can choose other _alternative public interfaces_ (Brutaldon, Fedi FE...) or even provide a custom one. + +**Mastodon frontend:** if you installed the Mastodon FE package (from CLI or Admin interface) you can have access to an alternate user interface, similar the Mastodons or Glitch frontend. This frontend live alongside the default Pleroma FE: to access just add `/web` at the end of your instance domain (eg. `akkoma.domain.tld/web`). + ## Admin Tasks Go to **cd /var/www/akkoma/live**. From 97c02cd262a90d199866994dcda50f3e0bd8cf32 Mon Sep 17 00:00:00 2001 From: Aris Date: Mon, 30 Jan 2023 11:35:03 +0100 Subject: [PATCH 3/4] Correction of all CLI examples - Bash error generated from previous version: bash: syntax error near unexpected token `cd` - Useless argument `MIX_ENV=prod`: we are on OTP install (not MIX/Sources) --- doc/DISCLAIMER.md | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index a6f4f34..b9deeae 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -1,14 +1,15 @@ ## Limitations -- **Akkoma** require a dedicated **root domain**, eg. akkoma.domain.tld -- **Akkoma** require a valid **certificate** installed on the domain. Yunohost can **install Letsencrypt certificate** on the domain from **admin web-interface** or through **command-line**. -- This package is currently set to **single-instance** that means you can run a **single Akkoma instance** on a **single server**. +- Require a dedicated **root domain**, eg. `akkoma.domain.tld` +- Require a valid **certificate** installed on the domain. Yunohost can install **Letsencrypt certificate** on the domain from admin web-interface or through command-line. +- This package is currently set to **single-instance** that means you can run only a _single Akkoma instance_ on a single server. - LDAP supported but HTTP auth not. ## Bugs -**Login fails if password contains special characters** -See [#4](https://github.com/YunoHost-Apps/akkoma_ynh/issues/4) for more explaination. +- **Login fails** if password contains special characters. See [#4](https://github.com/YunoHost-Apps/akkoma_ynh/issues/4) for more explanation. +- **Login fails** for non YNH users if LDAP is activated (this is by default). See [#15](https://github.com/YunoHost-Apps/akkoma_ynh/issues/15) for more explanation. +- No way to **change user password** from admin interface. May be related to previous bug. Work like charm from CLI. ## Customization @@ -18,28 +19,31 @@ This application come with the default frontend (Pleroma FE) and admin interface **Mastodon frontend:** if you installed the Mastodon FE package (from CLI or Admin interface) you can have access to an alternate user interface, similar the Mastodons or Glitch frontend. This frontend live alongside the default Pleroma FE: to access just add `/web` at the end of your instance domain (eg. `akkoma.domain.tld/web`). ## Admin Tasks -Go to **cd /var/www/akkoma/live**. + +Connect with SSH to your Yunohost as YNH admin user. +For the commands syntax, have in mind the specificities of [Yunohost Akkoma install](./yunohost.md). ### Adding users -**Run:** - - $ ( cd /var/www/akkoma/live && sudo -u akkoma MIX_ENV=prod ./bin/pleroma_ctl user new ) +``` +sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user new " +``` ### Password reset -**Run:** - - $ ( cd /var/www/akkoma/live && sudo -u akkoma MIX_ENV=prod ./bin/pleroma_ctl user reset_password ) +``` +sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user reset_password " +``` This will generate a **password reset link** that you can then send to the user. ### Moderators -You can make users **moderators**. They will then be able to **delete any post**. +You can make users **moderators**. They will then be able to _delete any post_. -**Run:** - $ ( cd /var/www/akkoma/live && sudo -u akkoma MIX_ENV=prod ./bin/pleroma_ctl user set --[no-]admin ) +``` +sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user set --admin" +``` -**--admin** option will **make the user moderator** and **--no-admin** will **take away the moderator privileges** from the user. +Note: `--admin` option will _make the user moderator_ and `--no-admin` will _take away_ the moderator privileges from the user. From 63135dc8c22e982171732da5c7b243dde642b8a6 Mon Sep 17 00:00:00 2001 From: Aris Date: Mon, 30 Jan 2023 11:45:08 +0100 Subject: [PATCH 4/4] Pleroma-Akkoma upgrade :-( --- doc/DISCLAIMER.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index b9deeae..4ca06a9 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -4,6 +4,7 @@ - Require a valid **certificate** installed on the domain. Yunohost can install **Letsencrypt certificate** on the domain from admin web-interface or through command-line. - This package is currently set to **single-instance** that means you can run only a _single Akkoma instance_ on a single server. - LDAP supported but HTTP auth not. +- You can normaly _upgrade a Pleroma instance_ to Akkoma... but not with Pleroma on Yunohost (work in progress). ## Bugs