YunoHost-Apps/akkoma_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/akkoma_ynh.git synced 2024-09-03 20:36:17 +02:00
Code Issues Activity Actions

Merge pull request #17 from bugsysop/documentation-1

Browse source 
Refactor DESCRIPTION.md and DISCLAIMER.md
This commit is contained in:
Aris 2023-01-30 13:08:02 +01:00 committed by GitHub
commit 380a1fdaa5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 32 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/DESCRIPTION.md
View file

@ -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. 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.
**Mastodon web front-end for Akkoma:** Add **/web** in front of your Akkoma domain, eg. akkoma.domain.tld/web

49
doc/DISCLAIMER.md
View file

@ -1,37 +1,50 @@
## Login fails if password contains special characters
See [#4](https://github.com/YunoHost-Apps/akkoma_ynh/issues/4) for more explaination.
## Limitations ## Limitations
- **Akkoma** require a dedicated **root domain**, eg. akkoma.domain.tld - 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**. - 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**. - 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. - 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
- **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
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 ## 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 ### Adding users
**Run:** ```
sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user new <userName> <userEmail>"
$ ( cd /var/www/akkoma/live && sudo -u akkoma MIX_ENV=prod ./bin/pleroma_ctl user new <NICKNAME> <EMAIL> ) ```
### Password reset ### Password reset
**Run:** ```
sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user reset_password <userName>"
$ ( cd /var/www/akkoma/live && sudo -u akkoma MIX_ENV=prod ./bin/pleroma_ctl user reset_password <NICKNAME> ) ```
This will generate a **password reset link** that you can then send to the user. This will generate a **password reset link** that you can then send to the user.
### Moderators ### 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 <NICKNAME> --[no-]admin ) ```
sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user set <userName> --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.