YunoHost-Apps/matrix-puppet-discord_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh.git synced 2024-09-03 19:36:25 +02:00
Code Issues Activity Actions

Documentation

Browse source
This commit is contained in:
Florent 2021-09-17 13:12:01 +02:00 committed by Florent F
parent 012059a28d
commit 1cdeb9f003
2 changed files with 87 additions and 84 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

86
README.md
View file

@ -1,38 +1,48 @@
# Packaging your an app, starting from this example
- [DONE] Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
- [DONE] Edit the `manifest.json` with app specific info.
- [DONE] Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.
- Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
- [DONE] Add a `LICENSE` file for the package.
- [DONE] Ensure the configuration can be overridden
- [TODO] Edit `doc/DISCLAIMER*.md`
- [TODO] The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
---
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator 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. It shall NOT be edited by hand.
--> -->
# Example app for YunoHost # Matrix-Discord bridge for YunoHost
[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/matrix-puppet-discord.svg)](https://dash.yunohost.org/appci/app/matrix-puppet-discord) ![](https://ci-apps.yunohost.org/ci/badges/matrix-puppet-discord.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/matrix-puppet-discord.maintain.svg)
[![Install example with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Install Matrix-Discord bridge with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=matrix-puppet-discord)
_[Lire ce readme en français.](./README_fr.md)_ *[Lire ce readme en français.](./README_fr.md)*
> _This package allows you to install example quickly and simply on a YunoHost server. > *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._ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview ## Overview
Explain in _a few (10~15) words_ the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps) This is a discord puppeting bridge for matrix. It handles bridging private and group DMs, as well as Guilds (servers). It is based on [mx-puppet-bridge](https://github.com/Sorunome/mx-puppet-bridge).
### Features
- Direct (1:1) Chats
- DM Group Chats
- Plain Text
- Formatted Messages
- Media/files
- Redactions/Deletions
- Presence (Discord → Matrix only)
- Typing notifications (Discord → Matrix only)
- Replies
- Edits
- Reactions
- Stickers
- Multi-user
- Friends management
- Initiate chats from matrix
### How to
See <https://github.com/matrix-discord/mx-puppet-discord> for documentation.
**Shipped version:** 0.1.6~ynh1
**Shipped version:** 1.0~ynh1
**Demo:** https://demo.example.com
## Screenshots ## Screenshots
@ -40,39 +50,27 @@ Explain in _a few (10~15) words_ the purpose of the app or what it actually does
## Disclaimers / important information ## Disclaimers / important information
- Any known limitations, constrains or stuff not working, such as (but not limited to): After the install is complete, start a chat with `@_discordpuppet_bot:yourserver.com`. When it joins, type `help` in the chat to see instructions.
- requiring a full dedicated domain ? You also may modify the `/etc/matrix-puppet-discord/user.config.yaml` file to customize some configuration (like permissions to use the bridge). Ensure then to restart the bridge (`systemctl restart matrix-puppet-discord`).
- architectures not supported ?
- not-working single-sign on or LDAP integration ?
- 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 ?
## Documentation and resources ## Documentation and resources
- Official app website: https://example.com * Official app website: https://github.com/matrix-discord/mx-puppet-discord
- Official user documentation: https://yunohost.org/apps * Official admin documentation: https://github.com/matrix-discord/mx-puppet-discord
- Official admin documentation: https://yunohost.org/packaging_apps * Upstream app code repository: https://github.com/matrix-discord/mx-puppet-discord
- Upstream app code repository: https://some.forge.com/example/example * YunoHost documentation for this app: https://yunohost.org/app_matrix-puppet-discord
- YunoHost documentation for this app: https://yunohost.org/app_example * Report a bug: https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/issues
- Report a bug: https://github.com/YunoHost-Apps/example_ynh/issues
## Developer info ## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing). Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing).
To try the testing branch, please proceed like that. To try the testing branch, please proceed like that.
``` ```
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing --debug
or or
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app upgrade matrix-puppet-discord -u https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** https://yunohost.org/packaging_apps **More info regarding app packaging:** https://yunohost.org/packaging_apps

81
README_fr.md
View file

@ -1,66 +1,71 @@
# Example app pour YunoHost # Matrix-Discord bridge pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Niveau d'intégration](https://dash.yunohost.org/integration/matrix-puppet-discord.svg)](https://dash.yunohost.org/appci/app/matrix-puppet-discord) ![](https://ci-apps.yunohost.org/ci/badges/matrix-puppet-discord.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/matrix-puppet-discord.maintain.svg)
[![Installer example avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Installer Matrix-Discord bridge avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=matrix-puppet-discord)
*[Read this readme in english.](./README.md)* _[Read this readme in english.](./README.md)_
*[Lire ce readme en français.](./README_fr.md)* _[Lire ce readme en français.](./README_fr.md)_
> *This package allows you to install example quickly and simply on a YunoHost server. > _Ce package vous permet d'installer Matrix-Discord bridge rapidement et simplement sur un serveur YunoHost.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* > Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter._
## Vue d'ensemble ## Vue d'ensemble
Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'objectif est de donner une idée grossière pour des utilisateurs qui naviguent dans un catalogue de 100+ apps) Ceci est une passerelle vers Discord pour Matrix. Il gère la messagerie privée ou en groupe, tout comme la discussion dans une guilde (serveur Discord). Le projet est basé sur [mx-puppet-bridge](https://github.com/Sorunome/mx-puppet-bridge).
**Version incluse:** 1.0~ynh1 ### Fonctionnalités
**Démo:** https://demo.example.com - Messagerie directe (1:1)
- Discussion privée en groupe
- Plein texte
- Messages formattés
- Fichiers / médias
- Notification de rédaction / suppression
- Présence (Discord → Matrix seulement)
- Notification de saisie (Discord → Matrix seulement)
- Réponses
- Modifications de messages
- Réactions
- Stickers
- Multi-utilisateur·rices
- Gestion des ami·es
- initier des chats depuis matrix
### Comment faire
Voir la documentation sur <https://github.com/matrix-discord/mx-puppet-discord> (en anglais).
**Version incluse :** 0.1.6~ynh1
## Captures d'écran ## Captures d'écran
![](./doc/screenshots/example.jpg) ![](./doc/screenshots/example.jpg)
## Avertissements / informations importantes ## Avertissements / informations importantes
* Any known limitations, constrains or stuff not working, such as (but not limited to): Après l'installation, lancer une conversation privée avec `@_discordpuppet_bot:yourserver.com`. Ensuite, entrer `help` dans le chat pour lire les instructions.
* requiring a full dedicated domain ?
* architectures not supported ?
* not-working single-sign on or LDAP integration ?
* 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 ?
Vous pouvez par ailleurs modifier le fichier `/etc/matrix-puppet-discord/user.config.yaml` pour personnaliser la configuration (notamment les permissions pour utiliser la passerelle). Redémarrez bien ensuite la passerelle pour que les modifications soient effectives (`systemctl restart matrix-puppet-discord`).
## Documentations et ressources ## Documentations et ressources
* Site official de l'app : https://example.com - Site officiel de l'app : https://github.com/matrix-discord/mx-puppet-discord
* Documentation officielle utilisateur: https://yunohost.org/apps - Documentation officielle de l'admin : https://github.com/matrix-discord/mx-puppet-discord
* Documentation officielle de l'admin: https://yunohost.org/packaging_apps - Dépôt de code officiel de l'app : https://github.com/matrix-discord/mx-puppet-discord
* Dépôt de code officiel de l'app: https://some.forge.com/example/example - Documentation YunoHost pour cette app : https://yunohost.org/app_matrix-puppet-discord
* Documentation YunoHost pour cette app: https://yunohost.org/app_example - Signaler un bug : https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/issues
* Signaler un bug: https://github.com/YunoHost-Apps/example_ynh/issues
## Informations pour les développeurs ## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing). Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit. Pour essayer la branche testing, procédez comme suit.
``` ```
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing --debug
or ou
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app upgrade matrix-puppet-discord -u https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing --debug
``` ```
**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps **Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps