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
akkoma_ynh/doc/DISCLAIMER.md
lapineige f8a4038cec
Explain how to add custom theme
2023-02-14 11:53:01 +01:00

3.6 KiB
Raw Blame History

Limitations

  • 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.
  • 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 for more explanation.
  • Login fails for non YNH users if LDAP is activated (this is by default). See #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).

Custom theme

You can eitheir create your custom theme or use existing ones. To add custom themes, you will have to upload them to your instance dedicated folder (/home/yunohost.app/akkoma/static/themes/ in Yunohost case), then to edit /home/yunohost.app/akkoma/static/styles.json to add a new entry referencing it. See the official documentation for more details.

  • Upload your custom theme, place it in /home/yunohost.app/akkoma/static/themes/ (you could also directly edit the file from the command line and copy-paste the content).
  • Make sure the file access rights are approriate (only akkoma user can access them) sudo chown -R akkoma:akkoma /home/yunohost.app/akkoma/static/themes/ (= own by akkoma) and sudo chmod 750 /home/yunohost.app/akkoma/static/themes/ (=only akkoma can read and edit the file).
  • Then edit /home/yunohost.app/akkoma/static/styles.json for instance with sudo su akkoma nano /home/yunohost.app/akkoma/static/styles.json.

Admin Tasks

Connect with SSH to your Yunohost as YNH admin user. For the commands syntax, have in mind the specificities of Yunohost Akkoma install.

Adding users

sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user new <userName> <userEmail>"

Password reset

sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user reset_password <userName>"

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.

sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user set <userName> --admin"

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