diff --git a/issue_template.md b/.github/ISSUE_TEMPLATE.md similarity index 94% rename from issue_template.md rename to .github/ISSUE_TEMPLATE.md index 567f6ab..2729a6b 100644 --- a/issue_template.md +++ b/.github/ISSUE_TEMPLATE.md @@ -8,7 +8,7 @@ about: When creating a bug report, please use the following template to provide 1. *Read this whole template first.* 2. *Determine if you are on the right place:* - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!* - - *Otherwise, the issue may be due to Matterbridge itself. Refer to its documentation or repository for help.* + - *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.* - *When in doubt, post here and we will figure it out together.* 3. *Delete the italic comments as you write over them below, and remove this guide.* --- @@ -31,7 +31,7 @@ about: When creating a bug report, please use the following template to provide - *If you performed a command from the CLI, the command itself is enough. For example:* ```sh - sudo yunohost app install matterbridge + sudo yunohost app install the_app ``` - *If you used the webadmin, please perform the equivalent command from the CLI first.* - *If the error occurs in your browser, explain what you did:* diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..ef70e18 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +## Problem + +- *Description of why you made this PR* + +## Solution + +- *And how do you fix that problem* + +## PR Status + +- [ ] Code finished and ready to be reviewed/tested +- [ ] The fix/enhancement were manually tested (if applicable) + +## Automatic tests + +Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization) diff --git a/README.md b/README.md index 193f927..96757eb 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,39 @@ + + # Matterbridge for YunoHost [![Integration level](https://dash.yunohost.org/integration/matterbridge.svg)](https://dash.yunohost.org/appci/app/matterbridge) ![](https://ci-apps.yunohost.org/ci/badges/matterbridge.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/matterbridge.maintain.svg) -[![Install matterbridge with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=matterbridge) +[![Install Matterbridge with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=matterbridge) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install Matterbridge quickly and simply on a YunoHost server. +> *This package allows you to install Matterbridge 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 -Matterbridge is a bridge between a series of chat protocols and offers a REST-API. Supported protocols are among others IRC, XMPP, Gitter, Mattermost, Slack, Discord, Telegram, Rocket.Chat, Hipchat(via xmpp), Matrix, Steam, ssh-chat and Zulip. -**Shipped version:** 1.22.1 +Multi-protocols bridge for online communications + +**Shipped version:** 1.22.2~ynh1 + + + +## Disclaimers / important information ## Configuration How to configure this app: a plain file with SSH `/opt/yunohost/matterbridge/matterbridge.toml`. You can follow this [doc](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) on how to create your config. -## Documentation +## Documentation and resources - * Official documentation: https://github.com/42wim/matterbridge/wiki - * YunoHost documentation: If specific documentation is needed, feel free to contribute. - -## YunoHost specific features - -#### Multi-user support - - * Are LDAP and HTTP auth supported? **No** - * Can the app be used by multiple users? **No** - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/matterbridge.svg)](https://ci-apps.yunohost.org/ci/apps/matterbridge/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/matterbridge.svg)](https://ci-apps-arm.yunohost.org/ci/apps/matterbridge/) - -## Limitations - -* Any known limitations. - -## Additional information - -* Other info you would like to add about this app. - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/matterbridge_ynh/issues - * Upstream app repository: https://github.com/42wim/matterbridge - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: https://github.com/42wim/matterbridge +* Official admin documentation: https://github.com/42wim/matterbridge/wiki +* Upstream app code repository: https://github.com/42wim/matterbridge +* YunoHost documentation for this app: https://yunohost.org/app_matterbridge +* Report a bug: https://github.com/YunoHost-Apps/matterbridge_ynh/issues ## Developer info @@ -60,3 +45,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/matterbridge_ynh/tree or sudo yunohost app upgrade matterbridge -u https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index 0186e30..40b4c7a 100644 --- a/README_fr.md +++ b/README_fr.md @@ -3,52 +3,33 @@ [![Niveau d'intégration](https://dash.yunohost.org/integration/matterbridge.svg)](https://dash.yunohost.org/appci/app/matterbridge) ![](https://ci-apps.yunohost.org/ci/badges/matterbridge.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/matterbridge.maintain.svg) [![Installer Matterbridge avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=matterbridge) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer Matterbridge rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.* +> *Ce package vous permet d'installer Matterbridge rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* ## Vue d'ensemble -Matterbridge est un pont entre une série de protocoles de discussion et propose une REST-API. Les protocoles pris en charge sont entre autres IRC, XMPP, Gitter, Mattermost, Slack, Discord, Telegram, Rocket.Chat, Hipchat (via xmpp), Matrix, Steam, ssh-chat et Zulip. -**Version incluse :** 1.22.1 +Connecteur entre une série de protocoles de discussion + +**Version incluse :** 1.22.2~ynh1 + + + +## Avertissements / informations importantes ## Configuration Comment configurer cette application : un fichier brut en SSH `/opt/yunohost/matterbridge/matterbridge.toml`. Vous pouvez suivre cette [documentation](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) sur la façon de créer votre config. -## Documentation +## Documentations et ressources - * Documentation officielle : https://github.com/42wim/matterbridge/wiki - * Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer. - -## Caractéristiques spécifiques YunoHost - -#### Support multi-utilisateur - -* L'authentification LDAP et HTTP est-elle prise en charge ? **Non** -* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Non** - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/matterbridge.svg)](https://ci-apps.yunohost.org/ci/apps/matterbridge/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/matterbridge.svg)](https://ci-apps-arm.yunohost.org/ci/apps/matterbridge/) - -## Limitations - -* Limitations connues. - -## Informations additionnelles - -* Autres informations que vous souhaitez ajouter sur cette application. - -## Links - - * Signaler un bug : https://github.com/YunoHost-Apps/matterbridge_ynh/issues - * Dépôt de l'application principale : https://github.com/42wim/matterbridge - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : https://github.com/42wim/matterbridge +* Documentation officielle de l'admin : https://github.com/42wim/matterbridge/wiki +* Dépôt de code officiel de l'app : https://github.com/42wim/matterbridge +* Documentation YunoHost pour cette app : https://yunohost.org/app_matterbridge +* Signaler un bug : https://github.com/YunoHost-Apps/matterbridge_ynh/issues ## Informations pour les développeurs @@ -60,3 +41,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/matterbridge_ynh/tree ou sudo yunohost app upgrade matterbridge -u https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/check_process b/check_process index a00dc67..51abe64 100644 --- a/check_process +++ b/check_process @@ -1,8 +1,3 @@ -# See here for more informations -# https://github.com/YunoHost/package_check#syntax-check_process-file - -# Move this file from check_process.default to check_process when you have filled it. - ;; Test complet ; Manifest ; Checks @@ -13,10 +8,14 @@ setup_private=0 setup_public=0 upgrade=1 + upgrade=1 from_commit=58cf8e614d7b4396816b4073f58af75c5c4b075f backup_restore=1 multi_instance=0 - port_already_use=0 - change_url=0 ;;; Options Email= Notification=none +;;; Upgrade options + ; commit=58cf8e614d7b4396816b4073f58af75c5c4b075f + name=Merge pull request #5 from YunoHost-Apps/testing + manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=pass&port=666& + diff --git a/conf/arm.src b/conf/arm.src index f4bc6bf..4254d75 100644 --- a/conf/arm.src +++ b/conf/arm.src @@ -1,5 +1,5 @@ -SOURCE_URL=https://github.com/42wim/matterbridge/releases/download/v1.22.1/matterbridge-1.22.1-linux-armv6 -SOURCE_SUM=b4fd18774d402c0e0f107a00d6eb81a885976e97ffea2e65e849400809595ece +SOURCE_URL=https://github.com/42wim/matterbridge/releases/download/v1.22.2/matterbridge-1.22.2-linux-armv6 +SOURCE_SUM=f5d9458e678214e4e8f21bd51a41d7ee29f2541a856e327af2c04c047e3b2b42 SOURCE_SUM_PRG=sha256sum SOURCE_IN_SUBDIR=false SOURCE_FILENAME=matterbridge diff --git a/conf/arm64.src b/conf/arm64.src index 60ed06e..be97af4 100644 --- a/conf/arm64.src +++ b/conf/arm64.src @@ -1,5 +1,5 @@ -SOURCE_URL=https://github.com/42wim/matterbridge/releases/download/v1.22.1/matterbridge-1.22.1-linux-arm64 -SOURCE_SUM=75a43447e8152ef760ed2bd81151e331b5b8865dc96b4e96f2227d96789ad4c5 +SOURCE_URL=https://github.com/42wim/matterbridge/releases/download/v1.22.2/matterbridge-1.22.2-linux-arm64 +SOURCE_SUM=f755e4fcdd4ecd51177062d966f120c6a7fcc9ba3d4551d8d9942ba8fec8c179 SOURCE_SUM_PRG=sha256sum SOURCE_IN_SUBDIR=false SOURCE_FILENAME=matterbridge diff --git a/conf/x86-64.src b/conf/x86-64.src index f037a55..6e779e7 100644 --- a/conf/x86-64.src +++ b/conf/x86-64.src @@ -1,5 +1,5 @@ -SOURCE_URL=https://github.com/42wim/matterbridge/releases/download/v1.22.1/matterbridge-1.22.1-linux-64bit -SOURCE_SUM=655719e489a8d146e31cb604da7874cf6a0be52a40c6f2bc1314bee8f00e07e7 +SOURCE_URL=https://github.com/42wim/matterbridge/releases/download/v1.22.2/matterbridge-1.22.2-linux-64bit +SOURCE_SUM=00e243ffaa5560645dbedf49b0945d77c0ecb154813d745cd8ab32cd86b9f753 SOURCE_SUM_PRG=sha256sum SOURCE_IN_SUBDIR=false SOURCE_FILENAME=matterbridge diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..56489f9 --- /dev/null +++ b/doc/DISCLAIMER.md @@ -0,0 +1,3 @@ +## Configuration + +How to configure this app: a plain file with SSH `/opt/yunohost/matterbridge/matterbridge.toml`. You can follow this [doc](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) on how to create your config. diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md new file mode 100644 index 0000000..88fcca7 --- /dev/null +++ b/doc/DISCLAIMER_fr.md @@ -0,0 +1,3 @@ +## Configuration + +Comment configurer cette application : un fichier brut en SSH `/opt/yunohost/matterbridge/matterbridge.toml`. Vous pouvez suivre cette [documentation](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) sur la façon de créer votre config. diff --git a/manifest.json b/manifest.json index af42fc7..83803a7 100644 --- a/manifest.json +++ b/manifest.json @@ -6,15 +6,21 @@ "en": "Multi-protocols bridge for online communications", "fr": "Connecteur entre une série de protocoles de discussion" }, - "version": "1.22.1~ynh1", + "version": "1.22.2~ynh1", "url": "https://github.com/42wim/matterbridge", + "upstream": { + "license": "Apache-2.0", + "website": "https://github.com/42wim/matterbridge", + "admindoc": "https://github.com/42wim/matterbridge/wiki", + "code": "https://github.com/42wim/matterbridge" + }, "license": "Apache-2.0", "maintainer": { "name": "liberodark", "email": "liberodark@gmail.com" }, "requirements": { - "yunohost": ">= 4.1.7" + "yunohost": ">= 4.2.4" }, "multi_instance": false, "services": [],