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.
73 commits 3 branches 0 tags 79 MiB
Find a file
Yalh 75d9bf51aa invert systemd remove and from admin panel remove
2019-01-26 18:36:43 +01:00
conf Repair systemd.service 2019-01-26 18:36:43 +01:00
scripts invert systemd remove and from admin panel remove 2019-01-26 18:36:43 +01:00
check_process Applying example_ynh on check_process 2019-01-26 18:36:43 +01:00
LICENSE Added upgrade,backup and restore script 2018-11-05 19:52:26 +05:30
manifest.json Provide a default instance name 2019-01-26 18:36:43 +01:00
README.md cleanup of README.md 2019-01-26 18:36:43 +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.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 multi-instance that means you can run multiple Pleroma instances on a single server.
  4. There is No LDAP support for Pleroma yet.

License

License AGPL-3.0

Demo

Configuration

How to configure this app: by an admin panel, a plain file with SSH, or any other way.

Admin Tasks

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

Register a User

Run:

$ sudo -u pleroma MIX_ENV=prod mix register_user <name> <nickname> <email> <bio> <password>

The name appears on statuses, while the nickname corresponds to the user, e.g. @nickname@instance.tld

Password reset

Run:

$ MIX_ENV=prod mix generate_password_reset username

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:

$ MIX_ENV=prodmix set_moderator username [true|false]

True option will make the user moderator and flase will take away the moderator privileges from the user.

Documentation

  • Official documentation: Link to the official documentation of this app
  • YunoHost documentation: If specific documentation is needed, feel free to contribute.

YunoHost specific features

Multi-users support

Are LDAP and HTTP auth supported? Can the app be used by multiple users?

Supported architectures

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

Limitations

  • Any known limitations.

Additional information

  • Other information you would add about this application

More information on the documentation page:
https://yunohost.org/packaging_apps

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