From 710ab166c006cd6a61f106b92b7ffecbcaa635eb Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Thu, 13 May 2021 17:45:54 +0200 Subject: [PATCH 01/15] [autopatch] Update issue and PR templates --- .github/ISSUE_TEMPLATE.md | 55 ++++++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 16 ++++++++++ 2 files changed, 71 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..2729a6b --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,55 @@ +--- +name: Bug report +about: When creating a bug report, please use the following template to provide all the relevant information and help debugging efficiently. + +--- + +**How to post a meaningful bug report** +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 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.* +--- + +### Describe the bug + +*A clear and concise description of what the bug is.* + +### Context + +- Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...* +- YunoHost version: x.x.x +- I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...* +- Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: *no / yes* + - If yes, please explain: +- Using, or trying to install package version/branch: +- If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`* + +### Steps to reproduce + +- *If you performed a command from the CLI, the command itself is enough. For example:* + ```sh + 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:* + 1. *Go to '...'* + 2. *Click on '...'* + 3. *Scroll down to '...'* + 4. *See error* + +### Expected behavior + +*A clear and concise description of what you expected to happen. You can remove this section if the command above is enough to understand your intent.* + +### Logs + +*When an operation fails, YunoHost provides a simple way to share the logs.* +- *In the webadmin, the error message contains a link to the relevant log page. On that page, you will be able to 'Share with Yunopaste'. If you missed it, the logs of previous operations are also available under Tools > Logs.* +- *In command line, the command to share the logs is displayed at the end of the operation and looks like `yunohost log display [log name] --share`. If you missed it, you can find the log ID of a previous operation using `yunohost log list`.* + +*After sharing the log, please copypaste directly the link provided by YunoHost (to help readability, no need to copypaste the entire content of the log here, just the link is enough...)* + +*If applicable and useful, add screenshots to help explain your problem.* 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) From 728f12148ac54d4b25ef436272f81fa149b8926e Mon Sep 17 00:00:00 2001 From: ericgaspar Date: Fri, 28 May 2021 23:39:58 +0200 Subject: [PATCH 02/15] Update check_process --- check_process | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/check_process b/check_process index b8aeb8d..515f2d0 100644 --- a/check_process +++ b/check_process @@ -1,11 +1,6 @@ -# See here for more information -# 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 - domain="domain.tld" (DOMAIN) + domain="domain.tld" ; Checks pkg_linter=1 setup_sub_dir=0 From 6fa6cd2e12f5033a6befbdda8ca8aee3dd066877 Mon Sep 17 00:00:00 2001 From: ericgaspar Date: Wed, 2 Jun 2021 14:01:43 +0200 Subject: [PATCH 03/15] Add template --- doc/DISCLAIMER.md | 14 ++++++++++++++ doc/DISCLAIMER_fr.md | 14 ++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 doc/DISCLAIMER.md create mode 100644 doc/DISCLAIMER_fr.md diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..486ec95 --- /dev/null +++ b/doc/DISCLAIMER.md @@ -0,0 +1,14 @@ +## Configuration + +You need to install TURN server in a root or subdomain like `turn.domain.lts` + +How to configure this app: a plain file with SSH. + +## Testing + +For testing we can use Trickle-Ice testing tool. Go to [trickle-ice page](https://webrtc.github.io/samples/src/content/peerconnection/trickle-ice) and enter following details. +``` +TURN URI : turn::5349 +TURN username: +TURN password: +``` diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md new file mode 100644 index 0000000..f0e4443 --- /dev/null +++ b/doc/DISCLAIMER_fr.md @@ -0,0 +1,14 @@ +## Configuration + +Vous devez installer coTURN à la racine ou un sous-domaine comme `turn.domain.lts` + +How to configure this app: a plain file with SSH. + +## Testing + +Pour les tests, vous pouvez utiliser l'outil de test Trickle-Ice. Accédez à la page [trickle-ice](https://webrtc.github.io/samples/src/content/peerconnection/trickle-ice) et entrez les détails suivants. +``` +TURN URI : turn::5349 +TURN username: +TURN password: +``` From 054407d893e3f6205907101643fb3c0502bf7a96 Mon Sep 17 00:00:00 2001 From: ericgaspar Date: Wed, 2 Jun 2021 14:07:23 +0200 Subject: [PATCH 04/15] Update manifest.json --- manifest.json | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/manifest.json b/manifest.json index f5c0331..ffd0bb3 100644 --- a/manifest.json +++ b/manifest.json @@ -6,8 +6,13 @@ "en": "VoIP media traffic NAT traversal server and gateway", "fr": "Serveur et passerelle NAT du trafic média VoIP" }, - "version": "4.5.1.1~ynh2", + "version": "4.5.1.1~ynh3", "url": "https://github.com/coturn/coturn", + "upstream": { + "license": "BSD-3-Clause", + "admindoc": "https://github.com/coturn/coturn/wiki", + "code": "https://github.com/coturn/coturn" + }, "license": "BSD-3-Clause", "maintainer": { "name": "eric_G", From 57e08ebe290a529c9b29f9869b1b8edaa1c3d4ee Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Wed, 2 Jun 2021 12:07:30 +0000 Subject: [PATCH 05/15] Auto-update README --- README.md | 54 +++++++++++++++++++++------------------------------ README_fr.md | 55 ++++++++++++++++++++-------------------------------- 2 files changed, 43 insertions(+), 66 deletions(-) diff --git a/README.md b/README.md index d6fedfb..9528df5 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,27 @@ -# Coturn server for YunoHost + + +# Coturn for YunoHost [![Integration level](https://dash.yunohost.org/integration/coturn.svg)](https://dash.yunohost.org/appci/app/coturn) ![](https://ci-apps.yunohost.org/ci/badges/coturn.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/coturn.maintain.svg) [![Install Coturn with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=coturn) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install Coturn 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.* +> *This package allows you to install Coturn 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 -TURN and STUN server for VoIP -STUN (Session Traversal Utilities for NAT) and TURN (Traversal Using Relays around NAT) are protocols that can be used to provide NAT traversal for VoIP and WebRTC. This package provides a VoIP media traffic NAT traversal server and gateway. -**Shipped version:** 4.5.1.1 +VoIP media traffic NAT traversal server and gateway + +**Shipped version:** 4.5.1.1~ynh3 + + + +## Disclaimers / important information ## Configuration @@ -29,33 +38,12 @@ TURN username: TURN password: ``` -## Documentation +## Documentation and resources - * Official documentation: https://github.com/coturn/coturn/wiki - * YunoHost documentation: If specific documentation is needed, feel free to contribute. - -## YunoHost specific features - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/coturn.svg)](https://ci-apps.yunohost.org/ci/apps/coturn/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/coturn.svg)](https://ci-apps-arm.yunohost.org/ci/apps/coturn/) - -## 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/coturn_ynh/issues - * Upstream app repository: https://github.com/coturn/coturn - * YunoHost website: https://yunohost.org/ - ---- +* Official admin documentation: https://github.com/coturn/coturn/wiki +* Upstream app code repository: https://github.com/coturn/coturn +* YunoHost documentation for this app: https://yunohost.org/app_coturn +* Report a bug: https://github.com/YunoHost-Apps/coturn_ynh/issues ## Developer info @@ -67,3 +55,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/coturn_ynh/tree/testi or sudo yunohost app upgrade coturn -u https://github.com/YunoHost-Apps/coturn_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 74910d3..fd3e43e 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,17 +1,23 @@ -# Coturn server pour YunoHost +# Coturn pour YunoHost -[![Integration level](https://dash.yunohost.org/integration/coturn.svg)](https://dash.yunohost.org/appci/app/coturn) ![](https://ci-apps.yunohost.org/ci/badges/coturn.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/coturn.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/coturn.svg)](https://dash.yunohost.org/appci/app/coturn) ![](https://ci-apps.yunohost.org/ci/badges/coturn.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/coturn.maintain.svg) [![Installer Coturn avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=coturn) -*[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 Coturn 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 Coturn 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.* -## Overview -Serveur TURN et STUN pour VoIP. STUN (Session Traversal Utilities for NAT) et TURN (Traversal Using Relays around NAT) sont des protocoles qui peuvent être utilisés pour fournir une traversée NAT pour VoIP et WebRTC. Ce package fournit un serveur et une passerelle de traversée NAT du trafic multimédia VoIP. +## Vue d'ensemble -**Version incluse :** 4.5.1.1 +Serveur et passerelle NAT du trafic média VoIP + +**Version incluse :** 4.5.1.1~ynh3 + + + +## Avertissements / informations importantes ## Configuration @@ -28,33 +34,12 @@ TURN username: TURN password: ``` -## Documentation +## Documentations et ressources - * Documentation officielle : https://github.com/coturn/coturn/wiki - * Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer. - -#### Support multi-utilisateur - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/coturn.svg)](https://ci-apps.yunohost.org/ci/apps/coturn/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/coturn.svg)](https://ci-apps-arm.yunohost.org/ci/apps/coturn/) - -## Limitations - -* Limitations connues. - -## Informations additionnelles - -* Autres informations que vous souhaitez ajouter sur cette application. - -## Links - - * Signaler un bug : https://github.com/YunoHost-Apps/coturn_ynh/issues - * Site de l'application : https://github.com/coturn/coturn - * Site web YunoHost : https://yunohost.org/ - ---- +* Documentation officielle de l'admin : https://github.com/coturn/coturn/wiki +* Dépôt de code officiel de l'app : https://github.com/coturn/coturn +* Documentation YunoHost pour cette app : https://yunohost.org/app_coturn +* Signaler un bug : https://github.com/YunoHost-Apps/coturn_ynh/issues ## Informations pour les développeurs @@ -66,3 +51,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/coturn_ynh/tree/testi ou sudo yunohost app upgrade coturn -u https://github.com/YunoHost-Apps/coturn_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file From 0fa0dfe9f7fbf5186e45ed8a21878ef8370066d2 Mon Sep 17 00:00:00 2001 From: ericgaspar Date: Thu, 29 Jul 2021 19:23:37 +0200 Subject: [PATCH 06/15] Update install --- scripts/install | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/install b/scripts/install index af36da6..513b12f 100644 --- a/scripts/install +++ b/scripts/install @@ -192,7 +192,7 @@ echo "Coturn server was successfully installed :) For testing we can use Trickle-Ice testing tool. Go to trickle-ice page https://webrtc.github.io/samples/src/content/peerconnection/trickle-ice/ and enter following details. -STUN or TURN URI: $domain:$turnserver_tls_port +STUN or TURN URI: turn:$domain:$turnserver_tls_port TURN username: turnserver TURN password: $turnserver_pwd From 30cd262661a41d21adca98d89b7a68c0fc5eb7de Mon Sep 17 00:00:00 2001 From: ericgaspar Date: Tue, 21 Sep 2021 23:14:59 +0200 Subject: [PATCH 07/15] Cleaning up --- manifest.json | 3 +-- scripts/install | 3 --- 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/manifest.json b/manifest.json index ffd0bb3..1982b59 100644 --- a/manifest.json +++ b/manifest.json @@ -28,8 +28,7 @@ "install" : [ { "name": "domain", - "type": "domain", - "example": "turn.example.com" + "type": "domain" } ] } diff --git a/scripts/install b/scripts/install index 513b12f..5044b4a 100644 --- a/scripts/install +++ b/scripts/install @@ -13,9 +13,6 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= -ynh_clean_setup () { - ynh_clean_check_starting -} # Exit if an error occurs during the execution of the script ynh_abort_if_errors From 5eb6ed055ce9af1431feaec2299765219a9755bd Mon Sep 17 00:00:00 2001 From: ericgaspar Date: Fri, 14 Jan 2022 15:57:02 +0100 Subject: [PATCH 08/15] Update manifest.json --- manifest.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/manifest.json b/manifest.json index 1982b59..4ba9b14 100644 --- a/manifest.json +++ b/manifest.json @@ -19,7 +19,7 @@ "email": "" }, "requirements": { - "yunohost": ">= 4.1.7" + "yunohost": ">= 4.2.4" }, "multi_instance": false, "services": [ From bd771803f311f44bf165d4023bf41cd63010da56 Mon Sep 17 00:00:00 2001 From: ericgaspar Date: Fri, 14 Jan 2022 15:58:54 +0100 Subject: [PATCH 09/15] Add description --- doc/DESCRIPTION.md | 1 + manifest.json | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 doc/DESCRIPTION.md diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 0000000..76f9df5 --- /dev/null +++ b/doc/DESCRIPTION.md @@ -0,0 +1 @@ +The TURN Server is a VoIP media traffic NAT traversal server and gateway. It can be used as a general-purpose network traffic TURN server and gateway, too. \ No newline at end of file diff --git a/manifest.json b/manifest.json index 4ba9b14..ba750f8 100644 --- a/manifest.json +++ b/manifest.json @@ -19,7 +19,7 @@ "email": "" }, "requirements": { - "yunohost": ">= 4.2.4" + "yunohost": ">= 4.3.0" }, "multi_instance": false, "services": [ From 08bdc4488b4642b975cc230d75aefe12deb0ad92 Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Fri, 14 Jan 2022 14:59:00 +0000 Subject: [PATCH 10/15] Auto-update README --- README.md | 2 +- README_fr.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9528df5..b197bf1 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -VoIP media traffic NAT traversal server and gateway +The TURN Server is a VoIP media traffic NAT traversal server and gateway. It can be used as a general-purpose network traffic TURN server and gateway, too. **Shipped version:** 4.5.1.1~ynh3 diff --git a/README_fr.md b/README_fr.md index fd3e43e..dd139e2 100644 --- a/README_fr.md +++ b/README_fr.md @@ -11,7 +11,7 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour ## Vue d'ensemble -Serveur et passerelle NAT du trafic média VoIP +The TURN Server is a VoIP media traffic NAT traversal server and gateway. It can be used as a general-purpose network traffic TURN server and gateway, too. **Version incluse :** 4.5.1.1~ynh3 From bfd5089d697a2cc1cb576285283e01fd1cef97a7 Mon Sep 17 00:00:00 2001 From: ericgaspar Date: Fri, 14 Jan 2022 16:00:39 +0100 Subject: [PATCH 11/15] Update install --- scripts/install | 2 -- 1 file changed, 2 deletions(-) diff --git a/scripts/install b/scripts/install index 5044b4a..03b7cd7 100644 --- a/scripts/install +++ b/scripts/install @@ -105,10 +105,8 @@ ynh_script_progression --message="Configuring Coturn..." --weight=1 # For any update do it in all files # Find password for turnserver -ynh_print_OFF turnserver_pwd=$(ynh_string_random --length=30) ynh_app_setting_set --app=$app --key=turnserver_pwd --value=$turnserver_pwd -ynh_print_ON coturn_config_path="/etc/turnserver.conf" From 5e3e70152a93226914d13c91b421b8433fae387a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Sun, 16 Jan 2022 22:28:55 +0100 Subject: [PATCH 12/15] Update doc/DISCLAIMER.md Co-authored-by: Alexandre Aubin --- doc/DISCLAIMER.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index 486ec95..583515b 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -1,6 +1,6 @@ ## Configuration -You need to install TURN server in a root or subdomain like `turn.domain.lts` +You need to install TURN server in a root or subdomain like `turn.domain.tld` How to configure this app: a plain file with SSH. From 51cd651bd5e3364f26d7e061752b5f682a3751c4 Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Sun, 16 Jan 2022 21:28:57 +0000 Subject: [PATCH 13/15] Auto-update README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b197bf1..b40d75d 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ The TURN Server is a VoIP media traffic NAT traversal server and gateway. It can ## Configuration -You need to install TURN server in a root or subdomain like `turn.domain.lts` +You need to install TURN server in a root or subdomain like `turn.domain.tld` How to configure this app: a plain file with SSH. From f9ca7c999e994a719b2acd0bcab1666ea0e615e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Sun, 16 Jan 2022 22:30:07 +0100 Subject: [PATCH 14/15] Update doc/DISCLAIMER_fr.md Co-authored-by: Alexandre Aubin --- doc/DISCLAIMER_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md index f0e4443..d4a294c 100644 --- a/doc/DISCLAIMER_fr.md +++ b/doc/DISCLAIMER_fr.md @@ -1,6 +1,6 @@ ## Configuration -Vous devez installer coTURN à la racine ou un sous-domaine comme `turn.domain.lts` +Vous devez installer coTURN à la racine ou un sous-domaine comme `turn.domain.tld` How to configure this app: a plain file with SSH. From 6ff21c5b334faf359118783d7ad9c476762dc12d Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Sun, 16 Jan 2022 21:30:09 +0000 Subject: [PATCH 15/15] Auto-update README --- README_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_fr.md b/README_fr.md index dd139e2..dabbb3c 100644 --- a/README_fr.md +++ b/README_fr.md @@ -21,7 +21,7 @@ The TURN Server is a VoIP media traffic NAT traversal server and gateway. It can ## Configuration -Vous devez installer coTURN à la racine ou un sous-domaine comme `turn.domain.lts` +Vous devez installer coTURN à la racine ou un sous-domaine comme `turn.domain.tld` How to configure this app: a plain file with SSH.