mirror of
https://github.com/YunoHost-Apps/pleroma_ynh.git
synced 2024-09-03 20:15:59 +02:00
114 lines
4.2 KiB
Markdown
114 lines
4.2 KiB
Markdown
# Pleroma app for Yunohost
|
|
|
|
[](https://dash.yunohost.org/appci/app/pleroma)
|
|
[](https://install-app.yunohost.org/?app=pleroma)
|
|
|
|
> *This package allow you to install pleroma quickly and simply on a YunoHost server.
|
|
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
|
|
|
|
## Overview
|
|
[Pleroma](https://pleroma.social/) is an **OStatus and ActivityPub compatible social networking server** written in Elixir, compatible with **GNU Social** and **Mastodon**. It is high-performance and can run on small devices like a **Raspberry Pi**.
|
|
|
|
For clients it supports both the **GNU Social API** with **Qvitter extensions** and the **Mastodon client API**.<br>
|
|
|
|
For user friendly details about Pleroma: [see here](https://blog.soykaf.com/post/what-is-pleroma/)<br>
|
|
|
|
**Mastodon web front-end for Pleroma:** Add **/web** in front of your Pleroma domain, eg. pleroma.domain.tld/web
|
|
|
|
## Mobile clients that work with Pleroma:
|
|
|
|
- Twidere
|
|
- Tusky
|
|
- Pawoo (Android + iOS)
|
|
- Subway Tooter
|
|
- Amaroq (iOS)
|
|
- Tootdon (Android + iOS)
|
|
- Tootle (iOS)
|
|
|
|
**Shipped version:** 0.9.999
|
|
|
|
## Important points to read before installing
|
|
|
|
1. **Pleroma** require a dedicated **root domain**, eg. pleroma.domain.tld
|
|
1. **Pleroma** require a valid **certificate** installed on the domain. Yunohost can **install Letsencrypt certificate** on the domain from **admin web-interface** or through **command-line**.
|
|
1. This package is **multi-instance** that means you can run **multiple Pleroma instances** on a **single server**.
|
|
1. There is **No LDAP** support for Pleroma yet.
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Demo
|
|
|
|
* [List of instances](http://distsn.org/pleroma-instances.html)
|
|
|
|
## Admin Tasks
|
|
Go to **cd /var/www/pleroma/pleroma**.
|
|
|
|
### Adding users
|
|
|
|
**Run:**
|
|
|
|
$ ( cd /var/www/pleroma/pleroma && sudo -u pleroma MIX_ENV=prod mix pleroma.user new <NICKNAME> <EMAIL> )
|
|
|
|
### Password reset
|
|
|
|
**Run:**
|
|
|
|
$ ( cd /var/www/pleroma/pleroma && sudo -u pleroma MIX_ENV=prod mix pleroma.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/pleroma && sudo -u pleroma MIX_ENV=prod mix pleroma.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
|
|
|
|
* Official documentation: https://git.pleroma.social/pleroma/pleroma/wikis/home
|
|
|
|
## YunoHost specific features
|
|
|
|
#### Multi-users support
|
|
|
|
LDAP and HTTP auth are not supported.
|
|
|
|
The app can be used by multiple users.
|
|
|
|
#### Supported architectures
|
|
|
|
* x86-64b - [](https://ci-apps.yunohost.org/ci/apps/pleroma/)
|
|
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/pleroma/)
|
|
* Jessie x86-64b - [](https://ci-stretch.nohost.me/ci/apps/pleroma/)
|
|
|
|
## Limitations
|
|
|
|
* No known limitations.
|
|
|
|
## Links
|
|
|
|
* Report a bug: https://github.com/YunoHost-Apps/pleroma_ynh/issues
|
|
* App website: https://pleroma.social/
|
|
* Pleroma Gitlab repo: https://git.pleroma.social/pleroma/pleroma/
|
|
* YunoHost website: https://yunohost.org/
|
|
|
|
---
|
|
|
|
Developers info
|
|
----------------
|
|
|
|
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
|
|
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/pleroma_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
```
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/pleroma_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade pleroma -u https://github.com/YunoHost-Apps/pleroma_ynh/tree/testing --debug
|
|
```
|