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.
489 commits 3 branches 0 tags 79 MiB
Find a file
yalh76 96ddfa8f9b typo
2021-04-13 01:12:21 +02:00
conf Upgrade to 2.3.0 2021-04-01 21:17:57 +02:00
scripts typo 2021-04-13 01:12:21 +02:00
.travis.yml Changing Travis for python 2019-01-30 19:53:14 +01:00
check_process Update check_process 2021-04-10 16:53:16 +02:00
issue_template.md Apply last example_ynh 2021-02-17 20:01:14 +01:00
LICENSE Added upgrade,backup and restore script 2018-11-05 19:52:26 +05:30
manifest.json Apply example_ynh 2021-04-10 18:58:51 +02:00
pull_request_template.md Apply last example_ynh 2021-02-17 20:01:14 +01:00
README.md Apply example_ynh 2021-04-09 22:50:44 +02:00

README.md

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

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 currently set to single-instance that means you can run a single Pleroma instance on a single server.
  4. The admin password entered when installing must not contain special characters. (See issue #132)

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