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
Social media based on ActivityPub, fork of Pleroma
23 commits 5 branches 0 tags 912 KiB
Shell 98.4%
Elixir 1.6%
Find a file
lapineige 1054e61e05
Change config file on install to enable admin UI configuration + install Mangane 
Should do it on upgrade and restore too ?

We should document Mangane in the readme.
2023-01-12 08:22:04 +01:00
conf Pleroma -> Akkoma 2022-12-20 22:50:33 +01:00
doc Fix pleroma/akkoma 2023-01-12 01:24:02 +01:00
scripts Change config file on install to enable admin UI configuration + install Mangane 2023-01-12 08:22:04 +01:00
check_process Initial release 2022-12-20 17:59:20 +01:00
LICENSE Initial release 2022-12-20 17:59:20 +01:00
manifest.json bump version number 2023-01-01 17:53:06 +01:00
README.md Auto-update README 2023-01-12 00:24:11 +00:00
README_fr.md Auto-update README 2023-01-12 00:24:11 +00:00

README.md

Akkoma for YunoHost

Integration level Working status Maintenance status
Install Akkoma with YunoHost

Lire ce readme en français.

This package allows you to install Akkoma quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

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

Shipped version: 3.5.0~ynh3

Demo: https://otp.akkoma.dev

Screenshots

Screenshot of Akkoma

Disclaimers / important information

Login fails if password contains special characters

See #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/akkoma/live.

Adding users

Run:

$ ( cd /var/www/akkoma/live && sudo -u akkoma MIX_ENV=prod ./bin/pleroma_ctl user new <NICKNAME> <EMAIL> )

Password reset

Run:

$ ( 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.

Moderators

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 )

--admin option will make the user moderator and --no-admin will take away the moderator privileges from the user.

Documentation and resources

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/akkoma_ynh/tree/testing --debug
or
sudo yunohost app upgrade akkoma -u https://github.com/YunoHost-Apps/akkoma_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps