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.
512 commits 3 branches 0 tags 79 MiB
Find a file
yalh76 eb82acc8ef Upgrade to 2.4.1~ynh1
2021-08-31 20:07:15 +02:00
.github [autopatch] Update issue and PR templates 2021-05-13 17:51:38 +02:00
conf Upgrade to 2.4.1~ynh1 2021-08-31 20:07:15 +02:00
doc Apply example_ynh 2021-08-25 19:59:06 +02:00
scripts Fix migration 2021-08-26 21:22:10 +02:00
.travis.yml Changing Travis for python 2019-01-30 19:53:14 +01:00
check_process Apply example_ynh 2021-08-25 19:59:06 +02:00
LICENSE Added upgrade,backup and restore script 2018-11-05 19:52:26 +05:30
manifest.json Upgrade to 2.4.1~ynh1 2021-08-31 20:07:15 +02:00
README.md Upgrade to 2.4.1~ynh1 2021-08-31 20:07:15 +02:00
README_fr.md Upgrade to 2.4.1~ynh1 2021-08-31 20:07:15 +02:00

README.md

Pleroma for YunoHost

Integration level
Install Pleroma with YunoHost

Lire ce readme en français.

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

A free, federated social networking server built on open protocols.

Shipped version: 2.4.1~ynh1

Demo: http://distsn.org/pleroma-instances.html

Screenshots

Disclaimers / important information

  • Any known limitations, constrains or stuff not working, such as (but not limited to):

    • Pleroma require a dedicated root domain, eg. pleroma.domain.tld
    • 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.
    • This package is currently set to single-instance that means you can run a single Pleroma instance on a single server.
    • The admin password entered when installing must not contain special characters. (See issue #132)
    • requiring a full dedicated domain ?
    • architectures not supported ?
    • LDAP supported but HTTP auth not.
    • the app requires an important amount of RAM / disk / .. to install or to work properly
    • etc...

  • Other infos that people should be aware of, such as:

    • any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
    • how to configure / administrate the application if it ain't obvious
    • upgrade process / specificities / things to be aware of ?
    • security considerations ?

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

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

More info regarding app packaging: https://yunohost.org/packaging_apps