Skip to content

Latest commit

 

History

History
107 lines (66 loc) · 4.18 KB

README.md

File metadata and controls

107 lines (66 loc) · 4.18 KB

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 a microblogging server software that can federate (= exchange messages with) other servers that support ActivityPub. What that means is that you can host a server for yourself or your friends and stay in control of your online identity, but still exchange messages with people on larger servers. Pleroma will federate with all servers that implement ActivityPub, like Friendica, GNU Social, Hubzilla, Mastodon, Misskey, Peertube, and Pixelfed.

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