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.
203 commits 3 branches 0 tags 79 MiB
Find a file
yalh76 a1e67a54e7 Upgrade to 0.9.999
2019-03-17 22:50:36 +01:00
conf Add new media proxy parameters 2019-03-16 15:42:50 +01:00
scripts Fix ynh_psql_execute_as_root 2019-03-17 03:52:56 +01:00
.travis.yml Changing Travis for python 2019-01-30 19:53:14 +01:00
check_process Add notifications 2019-02-25 14:55:09 +01:00
LICENSE Added upgrade,backup and restore script 2018-11-05 19:52:26 +05:30
manifest.json Upgrade to 0.9.999 2019-03-17 22:50:36 +01:00
pull_request_template.md fix template 2019-03-14 01:11:47 +01:00
README.md Upgrade to 0.9.999 2019-03-17 22:50:36 +01:00

README.md

Pleroma app for Yunohost

Integration level
Install pleroma with YunoHost

This package allow you to install pleroma quickly and simply on a YunoHost server.
If you don't have YunoHost, please see here to know how to install and enjoy 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: 0.9.999

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.
  4. There is No LDAP support for Pleroma yet.

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

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 - Build Status
  • ARMv8-A - Build Status
  • Jessie x86-64b - Build Status

Limitations

  • No known limitations.

Links

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.

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