mirror of
https://github.com/YunoHost-Apps/akkoma_ynh.git
synced 2024-09-03 20:36:17 +02:00
92 lines
3.9 KiB
Markdown
92 lines
3.9 KiB
Markdown
<!--
|
||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||
It shall NOT be edited by hand.
|
||
-->
|
||
|
||
# Akkoma pour YunoHost
|
||
|
||
[](https://dash.yunohost.org/appci/app/akkoma)  
|
||
[](https://install-app.yunohost.org/?app=akkoma)
|
||
|
||
*[Read this readme in english.](./README.md)*
|
||
|
||
> *Ce package vous permet d'installer Akkoma rapidement et simplement sur un serveur YunoHost.
|
||
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||
|
||
## Vue d'ensemble
|
||
|
||
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
|
||
|
||
|
||
|
||
**Version incluse :** 3.5.0~ynh3
|
||
|
||
**Démo :** https://otp.akkoma.dev
|
||
|
||
## Captures d'écran
|
||
|
||
|
||
|
||
## Avertissements / informations importantes
|
||
|
||
## 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
|
||
- **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**.
|
||
- LDAP supported but HTTP auth not.
|
||
|
||
## Admin Tasks
|
||
Go to **cd /var/www/pleroma/live**.
|
||
|
||
### Adding users
|
||
|
||
**Run:**
|
||
|
||
$ ( cd /var/www/pleroma/live && sudo -u pleroma MIX_ENV=prod ./bin/pleroma_ctl user new <NICKNAME> <EMAIL> )
|
||
|
||
### Password reset
|
||
|
||
**Run:**
|
||
|
||
$ ( cd /var/www/pleroma/live && sudo -u pleroma 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.
|
||
|
||
### Moderators
|
||
|
||
You can make users **moderators**. They will then be able to **delete any post**.
|
||
|
||
**Run:**
|
||
|
||
$ ( cd /var/www/pleroma/live && sudo -u pleroma MIX_ENV=prod ./bin/pleroma_ctl user set <NICKNAME> --[no-]admin )
|
||
|
||
**--admin** option will **make the user moderator** and **--no-admin** will **take away the moderator privileges** from the user.
|
||
|
||
## Documentations et ressources
|
||
|
||
* Site officiel de l'app : <https://akkoma.social/>
|
||
* Documentation officielle de l'admin : <https://docs.akkoma.dev/stable/>
|
||
* Dépôt de code officiel de l'app : <https://akkoma.dev/AkkomaGang/akkoma/>
|
||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_akkoma>
|
||
* Signaler un bug : <https://github.com/YunoHost-Apps/akkoma_ynh/issues>
|
||
|
||
## Informations pour les développeurs
|
||
|
||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/akkoma_ynh/tree/testing).
|
||
|
||
Pour essayer la branche testing, procédez comme suit.
|
||
|
||
``` bash
|
||
sudo yunohost app install https://github.com/YunoHost-Apps/akkoma_ynh/tree/testing --debug
|
||
ou
|
||
sudo yunohost app upgrade akkoma -u https://github.com/YunoHost-Apps/akkoma_ynh/tree/testing --debug
|
||
```
|
||
|
||
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
|