mirror of https://github.com/YunoHost-Apps/plume_ynh.git synced 2024-09-03 20:15:54 +02:00

Federated blogging application for YunoHost

Find a file

yalh76 655ae344f4 Merge pull request #81 from YunoHost-Apps/testing Upgrade to 0.7.1~ynh1		2022-01-23 11:49:26 +01:00
.github	Add auto-updater	2022-01-16 22:36:23 +01:00
conf	upgrade to 0.7.1~ynh1	2022-01-21 02:01:46 +01:00
doc	Update doc/DISCLAIMER.md	2022-01-05 20:19:35 +01:00
scripts	upgrade to 0.7.1~ynh1	2022-01-21 02:01:46 +01:00
.travis.yml	Changing Travis for Python	2019-01-30 19:53:55 +01:00
check_process	upgrade to 0.7.1~ynh1	2022-01-21 02:01:46 +01:00
LICENSE	Updated readme	2018-11-11 08:04:24 +05:30
manifest.json	Upgrade to v0.7.1	2022-01-18 20:40:41 +00:00
README.md	Auto-update README	2022-01-18 20:40:45 +00:00
README_fr.md	Auto-update README	2022-01-18 20:40:45 +00:00

README.md

Plume for YunoHost

Lire ce readme en français.

This package allows you to install Plume quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

Federated blogging engine, based on ActivityPub. It uses the Rocket framework, and Diesel to interact with the database.

Shipped version: 0.7.1~ynh1

Demo: https://joinplu.me/#instances

Screenshots

Disclaimers / important information

Warning: The package can take 15 to 30 minutes to complete depending on your system configuration. Don't intrupt the installation process while installing.

Important points to read before installing

Plume is still in pre-release stage and undergoing heavy development, so there can be bugs.
Plume requires a dedicated root domain, eg. plume.domain.tld
Plume requires a valid certificate installed on the domain. YunoHost can install a Let's Encrypt certificate on the domain from admin web-interface or through command-line.
This package is multi-instance that means you can run multiple Plume instances on a single server.

Multi-user support

LDAP is activated but HTTP auth is not supported

Documentation and resources

Official app website: https://joinplu.me/
Official admin documentation: https://docs.joinplu.me/
Upstream app code repository: https://github.com/Plume-org/Plume
YunoHost documentation for this app: https://yunohost.org/app_plume
Report a bug: https://github.com/YunoHost-Apps/plume_ynh/issues

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/plume_ynh/tree/testing --debug
or
sudo yunohost app upgrade plume -u https://github.com/YunoHost-Apps/plume_ynh/tree/testing --debug

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