README.md 2.72 KB
Newer Older
Ilja's avatar
Ilja committed
1 2 3
# Pleroma for YunoHost

- [Yunohost project](https://yunohost.org)
root's avatar
root committed
4
- [Pleroma project](https://git.pleroma.social/pleroma/pleroma)
Ilja's avatar
Ilja committed
5 6 7 8 9 10 11

## About Pleroma

Pleroma is an OStatus and Activity Pub-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 briqueinternet/internet cube.

For clients it supports both the [GNU Social API with Qvitter extensions](https://twitter-api.readthedocs.io/en/latest/index.html) and the [Mastodon client API](https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md).

root's avatar
root committed
12
Client applications that are committed to supporting Pleroma:
Ilja's avatar
Ilja committed
13

root's avatar
root committed
14 15 16 17
* Mastalab (Android)
* Tusky (Android)
* Twidere (Android)
* Mast (iOS)
Ilja's avatar
Ilja committed
18
* Amaroq (iOS)
root's avatar
root committed
19 20 21 22

Client applications that are known to work well:

* Pawoo (Android + iOS)
Ilja's avatar
Ilja committed
23 24
* Tootdon (Android + iOS)
* Tootle (iOS)
root's avatar
root committed
25
* Whalebird (Windows + Mac + Linux)
Ilja's avatar
Ilja committed
26 27 28

## About this package

root's avatar
root committed
29 30
* You need a dedicated domain or subdomain
* Changing the URL is technically impossible at this time due to the nature of federation
Ilja's avatar
Ilja committed
31 32
* There is no LDAP integration. Users on Pleroma are seperate from the yunohost users
* There is no integration with a mailbox and/or -service. This means that mails won't be sent from the application
root's avatar
root committed
33
* Changing the URL is technically impossible at this time due to the nature of federation
Ilja's avatar
Ilja committed
34

Ilja's avatar
Ilja committed
35
* Multiple installs are possible
root's avatar
root committed
36
* On installation you can choose to enable scopes on the Pleroma-FE
Ilja's avatar
Ilja committed
37
* You can choose to close regstrations on installation, but then you'll need to create invite tokens if you want others to join your instance. You can do this by accessing your yunohost server over ssh and run `cd /var/www/pleroma/pleroma/ && mix pleroma.user invite`. See: https://git.pleroma.social/pleroma/pleroma/wikis/Admin%20tasks
root's avatar
root committed
38 39
* On installation you'll need to chose a dedicated domain for Pleroma. You'll also be asked for a username and password for a user. This user will have admin and moderator rights

40
* Pleroma will be listed in the admin-panel under services, so you can stop and start the service there
Ilja's avatar
Ilja committed
41
* Postgresql will also be listed in the admin-panel
root's avatar
root committed
42
* You can upgrade your Pleroma instance by logging in over ssh as root and run `yunohost app upgrade pleroma_ynh -u https://gitlab.com/Spctrl/pleroma_ynh`
Ilja's avatar
Ilja committed
43
* Your current Pleroma version and other iformation can be found on `yourdomain.tld/api/v1/instance` and `yourdomain.tld/nodeinfo/2.0.json`
root's avatar
root committed
44
* If you're not afraid of the terminal, check out https://git.pleroma.social/pleroma/pleroma/wikis/home to see what more you can do with your awesome instance!
Ilja's avatar
Ilja committed
45

root's avatar
root committed
46 47 48 49 50
## Contribute

If you have problems, recommendations or whatever, you can contact me at `@ilja@ilja.space`

You can also add a bug on the issue-tracker at https://gitlab.com/Spctrl/pleroma_ynh