Commit b9e1dc3c authored by root's avatar root

Update readme

parent 9ef977db
......@@ -9,33 +9,42 @@ Pleroma is an OStatus and Activity Pub-compatible social networking server writt
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).
Mobile clients that are known to work well:
Client applications that are committed to supporting Pleroma:
* Twidere
* Tusky
* Pawoo (Android + iOS)
* Subway Tooter
* Mastalab (Android)
* Tusky (Android)
* Twidere (Android)
* Mast (iOS)
* Amaroq (iOS)
Client applications that are known to work well:
* Pawoo (Android + iOS)
* Tootdon (Android + iOS)
* Tootle (iOS)
* Whalebird (Windows + Mac + Linux)
## About this package
I'm using this package as a way to learn packaging for yunohost. This package is not completely ready yet, but installation, removal and upgrade should work. Backup should work as well, but restore may have some quirks. If you have recommendations, please let me know on the fediverse at `@ilja@ilja.space`
What is not implemented:
* You need a dedicated domain or subdomain
* Changing the URL is technically impossible at this time due to the nature of federation
* 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
* Changing the URL is technically impossible at this time due to the nature of federation
Extra info:
* Multiple installs are possible
* On installation you can choose to enable scopes on the Pleroma-FE
* 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
* 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.
* 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
* Pleroma will be listed in the admin-panel under services, so you can stop and start the service there
* Postgresql will also be listed in the admin-panel
* 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`
* Your current Pleroma version and other iformation can be found on `yourdomain.tld/api/v1/instance` and `yourdomain.tld/nodeinfo/2.0.json`
* 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!
## 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
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment