YunoHost-Apps/pleroma_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/pleroma_ynh.git synced 2024-09-03 20:15:59 +02:00
Code Issues Activity Actions
Pleroma package for YunoHost: A free, federated social networking server built on open protocols.
402 commits 3 branches 0 tags 79 MiB
Find a file
yalh76 b72ed64e94 Apply last example_ynh
2020-06-13 21:28:56 +02:00
conf Upgrade to 2.0.7~ynh1 2020-06-13 21:15:18 +02:00
scripts Apply last example_ynh 2020-06-13 21:28:56 +02:00
.travis.yml Changing Travis for python 2019-01-30 19:53:14 +01:00
check_process Upgrade to 2.0.7~ynh1 2020-06-13 21:15:18 +02:00
issue_template.md Apply last example_ynh 2020-06-13 21:28:56 +02:00
LICENSE Added upgrade,backup and restore script 2018-11-05 19:52:26 +05:30
manifest.json Apply last example_ynh 2020-06-13 21:28:56 +02:00
pull_request_template.md Update pull_request_template.md 2019-06-13 23:53:01 +02:00
README.md Apply last example_ynh 2020-06-13 21:28:56 +02:00

README.md

Pleroma app for Yunohost

Integration level
Install Pleroma with YunoHost

This package allows you to install Pleroma quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

Pleroma 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.

For user friendly details about Pleroma: see here

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: 2.0.7

Important points to read before installing

  1. Pleroma require a dedicated root domain, eg. pleroma.domain.tld
  2. 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.
  3. This package is multi-instance that means you can run multiple Pleroma instances on a single server.

Screenshots

pleroma-screenshot1

Demo

Admin Tasks

Go to cd /var/www/pleroma/pleroma.

Adding users

Run:

$ ( cd /var/www/pleroma/pleroma && sudo -u pleroma MIX_ENV=prod ./bin/pleroma_ctl user new <NICKNAME> <EMAIL> )

Password reset

Run:

$ ( cd /var/www/pleroma/pleroma && sudo -u pleroma MIX_ENV=prod ./bin/pleroma_ctl 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 ./bin/pleroma_ctl 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

YunoHost specific features

Multi-user support

LDAP supported but HTTP auth not.

The app can be used by multiple users.

Supported architectures

  • x86-64 - Build Status
  • ARMv8-A - Build Status

Links

Developer info

Please send your pull request to the testing branch.

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