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) diff --git a/README.md b/README.md index d6fedfb..b40d75d 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,31 @@ -# 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 +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 + + + +## Disclaimers / important information ## 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. @@ -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..dabbb3c 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,21 +1,27 @@ -# 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 +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 + + + +## Avertissements / informations importantes ## 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. @@ -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 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 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/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..583515b --- /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.tld` + +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..d4a294c --- /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.tld` + +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: +``` diff --git a/manifest.json b/manifest.json index f5c0331..ba750f8 100644 --- a/manifest.json +++ b/manifest.json @@ -6,15 +6,20 @@ "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", "email": "" }, "requirements": { - "yunohost": ">= 4.1.7" + "yunohost": ">= 4.3.0" }, "multi_instance": false, "services": [ @@ -23,8 +28,7 @@ "install" : [ { "name": "domain", - "type": "domain", - "example": "turn.example.com" + "type": "domain" } ] } diff --git a/scripts/install b/scripts/install index af36da6..03b7cd7 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 @@ -108,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" @@ -192,7 +187,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