1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/pleroma_ynh.git synced 2024-09-03 20:15:59 +02:00
pleroma_ynh/doc/ADMIN.md
2024-01-12 18:28:38 +01:00

46 lines
2.1 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Pleroma and Yunohost
Some information, for all intents and purposes, on the differences between a direct installation of Pleroma (from the _releases_) and installation with the Yunohost application package.
| | Official Package | With Yunohost |
| --------------------------- | -------------------------- | --------------------------------------- |
| Install directory | `/opt/pleroma` | `/var/www/pleroma/live/` |
| Static directory | `/var/lib/pleroma/static` | `/etc/pleroma/config.exs` |
| Configuration file | `/etc/pleroma/config.exs` | `/etc/pleroma/config.exs` |
| Command line path | `/bin/pleroma_ctl` | `/var/www/pleroma/live/bin/pleroma_ctl` |
## Things to remember
- The installation of Pleroma with Yunohost is a so-called OTP installation (and not MIX, i.e. from the sources). Have this in mind, as the administration _commands_ are not the same in either case.
- All commands must be run as the `pleroma` user, who is _not_ part of Yunohost `admin` group, its not possible to invoque these commands directly with `sudo`.
Connect with SSH to your Yunohost server as YNH admin user.
For the commands syntax, have in mind the specificities of [Yunohost Pleroma install](./doc/yunohost.md).
## Administration tasks
### Adding users
```bash
sudo su pleroma -s $SHELL -lc "/var/www/pleroma/live/bin/pleroma_ctl user new <userName> <userEmail>"
```
### Password reset
```bash
sudo su pleroma -s $SHELL -lc "/var/www/pleroma/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_.
```bash
sudo su pleroma -s $SHELL -lc "/var/www/pleroma/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.