mautrix_discord_ynh/README.md

<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->

# Matrix-Discord bridge for YunoHost

[![Integration level](https://dash.yunohost.org/integration/mautrix_discord.svg)](https://dash.yunohost.org/appci/app/mautrix_discord) ![Working status](https://ci-apps.yunohost.org/ci/badges/mautrix_discord.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/mautrix_discord.maintain.svg)

[![Install Matrix-Discord bridge with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mautrix_discord)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install Matrix-Discord bridge quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*

## Overview

A puppeting bridge between Matrix and Discord packaged as a YunoHost service. Messages, media and notifications are bridged between a Discord user and a matrix user. The "Mautrix-Discord" bridge consists in a synapse app service and relies on postgresql. Therefore, Synapse for YunoHost should be installed beforehand.

**Attention: always backup and restore the Yunohost matrix_synapse et mautrix_discord apps together!**


**Shipped version:** 0.6.5~ynh1

## Screenshots

![Screenshot of Matrix-Discord bridge](./doc/screenshots/example.jpg)

## Documentation and resources

* Official admin documentation: <https://docs.mau.fi/bridges/go/discord/index.html>
* Upstream app code repository: <https://github.com/mautrix/discord>
* YunoHost Store: <https://apps.yunohost.org/app/mautrix_discord>
* Report a bug: <https://github.com/YunoHost-Apps/mautrix_discord_ynh/issues>

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/mautrix_discord_ynh/tree/testing).

To try the testing branch, please proceed like that.

``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/mautrix_discord_ynh/tree/testing --debug
or
sudo yunohost app upgrade mautrix_discord -u https://github.com/YunoHost-Apps/mautrix_discord_ynh/tree/testing --debug
```

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