Merge pull request #3 from YunoHost-Apps/testing

Testing

.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.*

.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)

README.md

@@ -1,3 +1,8 @@
+<!--
+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.
+-->
+
 # OpenTracker for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/opentracker.svg)](https://dash.yunohost.org/appci/app/opentracker) ![](https://ci-apps.yunohost.org/ci/badges/opentracker.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/opentracker.maintain.svg)  
@@ -5,17 +10,18 @@
 
 *[Lire ce readme en français.](./README_fr.md)*
 
-> *This package allows you to install OpenTracker quickly and simply on a YunoHost server.  
+> *This package allows you to install OpenTracker 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
-OpenTracker is a open and free bittorrent tracker project. It aims for minimal resource usage.
 
-**Shipped version:** 1.0
+Bittorrent tracker
 
-## Screenshots
+**Shipped version:** 1.0~ynh2
 
-![](Link to a screenshot of this app.)
+**Demo:** https://dispatch.khlieng.com/connect
+
+## Disclaimers / important information
 
 ## Configuration
 
@@ -25,39 +31,12 @@ by default the tracker will run on 6969 port on both UDP and TCP.
 
 visit `http://serverIP:6969/stats` to view the tracker stats.
 
-## Documentation
+## Documentation and resources
 
- * Official documentation: http://erdgeist.org/arts/software/opentracker/index/#overview
+* Official app website: http://erdgeist.org/arts/software/opentracker/
- * YunoHost documentation: If specific documentation is needed, feel free to contribute.
+* Official admin documentation: http://erdgeist.org/arts/software/opentracker/
-
+* YunoHost documentation for this app: https://yunohost.org/app_opentracker
-## YunoHost specific features
+* Report a bug: https://github.com/YunoHost-Apps/opentracker_ynh/issues
-
-#### 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/opentracker%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/opentracker/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/opentracker%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/opentracker/)
-
-## 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/opentracker_ynh/issues
- * App website: http://erdgeist.org/arts/software/opentracker/
- * Upstream app repository: http://erdgeist.org/gitweb/opentracker/
- * YunoHost website: https://yunohost.org/
-
----
 
 ## Developer info
 
@@ -69,3 +48,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/opentracker_ynh/tree/
 or
 sudo yunohost app upgrade opentracker -u https://github.com/YunoHost-Apps/opentracker_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps

README_fr.md

@@ -1,71 +1,48 @@
 # OpenTracker pour YunoHost
 
-[![Integration level](https://dash.yunohost.org/integration/opentracker.svg)](https://dash.yunohost.org/appci/app/opentracker) ![](https://ci-apps.yunohost.org/ci/badges/opentracker.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/opentracker.maintain.svg)  
+[![Niveau d'intégration](https://dash.yunohost.org/integration/opentracker.svg)](https://dash.yunohost.org/appci/app/opentracker) ![](https://ci-apps.yunohost.org/ci/badges/opentracker.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/opentracker.maintain.svg)  
 [![Installer OpenTracker avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=opentracker)
 
-*[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 OpenTracker rapidement et simplement sur un serveur YunoHost.  
+> *Ce package vous permet d'installer OpenTracker 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.*
+Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
 
 ## Vue d'ensemble
-OpenTracker est un projet de tracker bittorrent ouvert et gratuit. Il vise une utilisation minimale des ressources.
 
-**Version incluse :** 1.0
+Tracker Bittorrent
 
-## Screenshots
+**Version incluse :** 1.0~ynh2
 
-![](Link to a screenshot of this app.)
+**Démo :** https://dispatch.khlieng.com/connect
+
+## Avertissements / informations importantes
 
 ## Configuration
 
 `udp://serverIP:6969`
 
-by default the tracker will run on 6969 port on both UDP and TCP.
+par défaut, le tracker s'exécutera sur le port 6969 à la fois sur UDP et TCP.
 
-visit `http://serverIP:6969/stats` to view the tracker stats.
+visitez `http://serverIP:6969/stats` pour afficher les statistiques du tracker. 
 
-## Documentation
+## Documentations et ressources
 
- * Documentation officielle : http://erdgeist.org/arts/software/opentracker/index/#overview
+* Site officiel de l'app : http://erdgeist.org/arts/software/opentracker/
- * Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer.
+* Documentation officielle de l'admin : http://erdgeist.org/arts/software/opentracker/
-
+* Documentation YunoHost pour cette app : https://yunohost.org/app_opentracker
-## Caractéristiques spécifiques YunoHost
+* Signaler un bug : https://github.com/YunoHost-Apps/opentracker_ynh/issues
-
-#### 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/opentracker%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/opentracker/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/opentracker%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/opentracker/)
-
-## Limitations
-
-* Limitations connues.
-
-## Informations additionnelles
-
-* Autres informations que vous souhaitez ajouter sur cette application.
-
-## Liens
-
- * Signaler un bug : https://github.com/YunoHost-Apps/opentracker_ynh/issues
- * Site de l'application : http://erdgeist.org/arts/software/opentracker/
- * Dépôt de l'application principale : http://erdgeist.org/gitweb/opentracker/
- * Site web YunoHost : https://yunohost.org/
-
----
 
 ## Informations pour les développeurs
 
-Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/opentracker_ynh/tree/testing).
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/opentracker_ynh/tree/testing).
 
-To try the testing branch, please proceed like that.
+Pour essayer la branche testing, procédez comme suit.
 ```
 sudo yunohost app install https://github.com/YunoHost-Apps/opentracker_ynh/tree/testing --debug
-or
+ou
 sudo yunohost app upgrade opentracker -u https://github.com/YunoHost-Apps/opentracker_ynh/tree/testing --debug
 ```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps

check_process

@@ -1,11 +1,6 @@
-# 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
-		domain="domain.tld"	(DOMAIN)
+		domain="domain.tld"
 	; Checks
 		pkg_linter=1
 		setup_sub_dir=0

doc/DISCLAIMER.md

@@ -0,0 +1,7 @@
+## Configuration
+
+`udp://serverIP:6969`
+
+by default the tracker will run on 6969 port on both UDP and TCP.
+
+visit `http://serverIP:6969/stats` to view the tracker stats.

doc/DISCLAIMER_fr.md

@@ -0,0 +1,7 @@
+## Configuration
+
+`udp://serverIP:6969`
+
+par défaut, le tracker s'exécutera sur le port 6969 à la fois sur UDP et TCP.
+
+visitez `http://serverIP:6969/stats` pour afficher les statistiques du tracker. 

manifest.json

@@ -6,15 +6,21 @@
         "en": "Bittorrent tracker",
         "fr": "Tracker Bittorrent"
     },
-    "version": "1.0~ynh1",
+    "version": "1.0~ynh2",
     "url": "http://erdgeist.org/arts/software/opentracker/",
+    "upstream": {
+        "license": "Beerware",
+        "website": "http://erdgeist.org/arts/software/opentracker/",
+        "demo": "https://dispatch.khlieng.com/connect",
+        "admindoc": "http://erdgeist.org/arts/software/opentracker/"
+    },
     "license": "Beerware",
     "maintainer": {
         "name": "liberodark",
         "email": "liberodark@gmail.com"
     },
     "requirements": {
-        "yunohost": ">= 4.0.1"
+        "yunohost": ">= 4.2.4"
     },
     "multi_instance": false,
     "services": [

scripts/install

@@ -61,6 +61,14 @@ ynh_script_progression --message="Installing dependencies..." --weight=2
 
 ynh_install_app_dependencies $pkg_dependencies
 
+#=================================================
+# CREATE DEDICATED USER
+#=================================================
+ynh_script_progression --message="Configuring system user..." --weight=1
+
+# Create a system user
+ynh_system_user_create --username=$app --home_dir="$final_path"
+
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
@@ -74,14 +82,6 @@ pushd $final_path
 	ynh_exec_warn_less make
  popd
 
-#=================================================
-# CREATE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Configuring system user..." --weight=1
-
-# Create a system user
-ynh_system_user_create --username=$app
-
 #=================================================
 # SETUP SYSTEMD
 #=================================================
@@ -105,7 +105,7 @@ chmod +x $final_path/$app
 #=================================================
 ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
 
-yunohost service add $app --description="Bittorrent tracker" --log=systemd --needs_exposed_ports $port
+yunohost service add $app --description="Bittorrent tracker" --log="systemd" --needs_exposed_ports="$port"
 
 #=================================================
 # START SYSTEMD SERVICE

scripts/restore

@@ -74,7 +74,7 @@ systemctl enable $app.service --quiet
 #=================================================
 ynh_script_progression --message="Integrating service in YunoHost..." --weight=2
 
-yunohost service add $app --description="Bittorrent tracker" --log=systemd --needs_exposed_ports $port
+yunohost service add $app --description="Bittorrent tracker" --log="systemd" --needs_exposed_ports="$port"
 
 #=================================================
 # START SYSTEMD SERVICE

scripts/upgrade

@@ -48,6 +48,14 @@ ynh_script_progression --message="Stopping a systemd service..." --weight=5
 
 ynh_systemd_action --service_name=$app --action=stop --log_path="/var/log/$app/$app.log"
 
+#=================================================
+# CREATE DEDICATED USER
+#=================================================
+ynh_script_progression --message="Making sure dedicated system user exists..." --weight=5
+
+# Create a dedicated user (if not existing)
+ynh_system_user_create --username=$app --home_dir="$final_path"
+
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
@@ -72,14 +80,6 @@ ynh_script_progression --message="Upgrading dependencies..." --weight=2
 
 ynh_install_app_dependencies $pkg_dependencies
 
-#=================================================
-# CREATE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Making sure dedicated system user exists..." --weight=5
-
-# Create a dedicated user (if not existing)
-ynh_system_user_create --username=$app
-
 #=================================================
 # SETUP SYSTEMD
 #=================================================
@@ -103,7 +103,7 @@ chmod +x $final_path/$app
 #=================================================
 ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
 
-yunohost service add $app --description="Bittorrent tracker" --log=systemd --needs_exposed_ports $port
+yunohost service add $app --description="Bittorrent tracker" --log="systemd" --needs_exposed_ports="$port"
 
 #=================================================
 # START SYSTEMD SERVICE