mirror of https://github.com/YunoHost-Apps/dendrite_ynh.git synced 2024-09-03 18:25:58 +02:00

Matrix homeserver of second-generation, packaged for YunoHost

Find a file

yunohost-bot df5d2be8ef Upgrade to v0.10.1		2022-09-30 18:17:41 +00:00
.github	Apply last example_ynh	2022-09-26 01:18:29 +02:00
conf	Upgrade to v0.10.1	2022-09-30 18:17:41 +00:00
doc	Implement user registration in config panel and fix service status detection	2022-08-25 23:14:22 +02:00
scripts	Apply last example_ynh	2022-09-26 01:18:29 +02:00
.gitignore	Initial commit	2020-12-16 21:11:31 +01:00
check_process	Apply last example_ynh	2022-09-26 01:18:29 +02:00
config_panel.toml	Implement user registration in config panel and fix service status detection	2022-08-25 23:14:22 +02:00
LICENSE	upgrade sources	2021-05-01 21:47:44 +02:00
manifest.json	Upgrade to v0.10.1	2022-09-30 18:17:41 +00:00
README.md	Auto-update README	2022-09-30 18:16:35 +00:00
README_fr.md	Auto-update README	2022-09-30 18:16:35 +00:00

README.md

Dendrite for YunoHost

Lire ce readme en français.

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

Overview

Dendrite is a second-generation Matrix homeserver written in Go. It intends to provide an efficient, reliable and scalable alternative to Synapse:

Features

Efficient: A small memory footprint with better baseline performance than an out-of-the-box Synapse.
Reliable: Implements the Matrix specification as written, using the same test suite as Synapse as well as a brand new Go test suite.
Scalable: can run on multiple machines and eventually scale to massive homeserver deployments.

Shipped version: 0.10.0~ynh1 (⚠️ This is the testing branch. The master branch used in the catalog is currently on version 0.9.9~ynh3.)

Disclaimers / important information

⚠️ The upstream app is still in beta. Tread carefully.

Features

Registration can be opened in the app config panel.

Limitations

Dendrite does not implement secondary user registration schemes yet, so YunoHost users cannot be integrated at the moment.

🔴 Antifeatures

Alpha software: Early development stage. May contain changing or unstable features, bugs, and security vulnerability.

Documentation and resources

Official app website: https://matrix.org/
Official admin documentation: https://github.com/matrix-org/dendrite/tree/master/docs
Upstream app code repository: https://github.com/matrix-org/dendrite
YunoHost documentation for this app: https://yunohost.org/app_dendrite
Report a bug: https://github.com/YunoHost-Apps/dendrite_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/dendrite_ynh/tree/testing --debug
or
sudo yunohost app upgrade dendrite -u https://github.com/YunoHost-Apps/dendrite_ynh/tree/testing --debug

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