Merge pull request #4 from YunoHost-Apps/enh-testing

Add badges

README.md

@@ -1,6 +1,6 @@
 # Tvheadend for YunoHost
 
-[![Integration level](https://dash.yunohost.org/integration/tvheadend.svg)](https://dash.yunohost.org/appci/app/tvheadend)  
+[![Integration level](https://dash.yunohost.org/integration/tvheadend.svg)](https://dash.yunohost.org/appci/app/tvheadend) ![](https://ci-apps.yunohost.org/ci/badges/tvheadend.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/tvheadend.maintain.svg)  
 [![Install tvheadend with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=tvheadend)
 
 *[Lire ce readme en français.](./README_fr.md)*
@@ -23,7 +23,6 @@ Tvheadend works as backend PVR live TV for Kodi.
 
 ![](http://docs.tvheadend.org/images/overall_screenshot.png)
 
-
 ## Configuration
 
 Once the Tvheadend package is installed, go to the chosen URL, login with the superuser credentials and follow the setup wizard.
@@ -36,11 +35,9 @@ Once the Tvheadend package is installed, go to the chosen URL, login with the su
 
 #### Supported architectures
 
-* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/tvheadend%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/tvheadend/)
+* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/tvheadend%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/tvheadend/)
 * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/tvheadend%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/tvheadend/)
 
-
-
 ## Links
 
  * Report a bug: https://github.com/YunoHost-Apps/tvheadend_ynh/issues
@@ -50,10 +47,8 @@ Once the Tvheadend package is installed, go to the chosen URL, login with the su
 
 ---
 
-Developers info
+## Developers info
-----------------
 
-**Only if you want to use a testing branch for coding, instead of merging directly into master.**
 Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/tvheadend_ynh/tree/testing).
 
 To try the testing branch, please proceed like that.

README_fr.md

@@ -1,11 +1,11 @@
 # Tvheadend pour YunoHost
 
-[![Integration level](https://dash.yunohost.org/integration/tvheadend.svg)](https://dash.yunohost.org/appci/app/tvheadend)  
+[![Integration level](https://dash.yunohost.org/integration/tvheadend.svg)](https://dash.yunohost.org/appci/app/tvheadend) ![](https://ci-apps.yunohost.org/ci/badges/tvheadend.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/tvheadend.maintain.svg)  
 [![Install tvheadend with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=tvheadend)
 
 *[Read this readme in english.](./README.md)* 
 
-> *Ce package vous permet d'installer Tvheadend rapidement et simplement sur un serveur Yunohost.  
+> *Ce package vous permet d'installer Tvheadend 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
@@ -35,7 +35,7 @@ Une fois le paquet Tvheadend installé, allez à l'URL choisie, connectez-vous a
 
 #### Architectures supportées
 
-* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/tvheadend%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/tvheadend/)
+* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/tvheadend%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/tvheadend/)
 * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/tvheadend%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/tvheadend/)
 
 
@@ -48,10 +48,8 @@ Une fois le paquet Tvheadend installé, allez à l'URL choisie, connectez-vous a
 
 ---
 
-Informations pour les développeurs
+## Informations pour les développeurs
-----------------
 
-**Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.**
 Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/tvheadend_ynh/tree/testing).
 
 Pour essayer la branche testing, procédez comme suit.

manifest.json

@@ -3,8 +3,8 @@
     "id": "tvheadend",
     "packaging_format": 1,
     "description": {
-        "en": "A TV streaming server and recorder",
+        "en": "TV streaming server and recorder",
-        "fr": "Un serveur de streaming et d'enregistrement TV"
+        "fr": "Serveur de streaming et d'enregistrement TV"
     },
     "version": "4.2.8-36~ynh5",
     "url": "https://tvheadend.org",

scripts/backup

@@ -5,44 +5,34 @@
 #=================================================
 # IMPORT GENERIC HELPERS
 #=================================================
-#Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
+
 source ../settings/scripts/_common.sh
 source /usr/share/yunohost/helpers
 
 #=================================================
 # MANAGE SCRIPT FAILURE
 #=================================================
-# Exit if an error occurs during the execution of the script
+
 ynh_abort_if_errors
 
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading installation settings..." --weight=1
+ynh_print_info --message="Loading installation settings..."
 
 app=$YNH_APP_INSTANCE_NAME
 
 domain=$(ynh_app_setting_get --app=$app --key=domain)
-path_url=$(ynh_app_setting_get --app=$app --key=path)
-superuser=$(ynh_app_setting_get --app=$app --key=superuser)
-password=$(ynh_app_setting_get --app=$app --key=password)
 final_path=$(ynh_app_setting_get --app=$app --key=final_path)
-port=$(ynh_app_setting_get --app=$app --key=port)
-stream_port=$(ynh_app_setting_get --app=$app --key=stream_port)
 
 #=================================================
-# STANDARD BACKUP STEPS
+# DECLARE DATA AND CONF FILES TO BACKUP
 #=================================================
-# STOP TVHEADEND SERVICE
+ynh_print_info --message="Declaring files to be backed up..."
-#=================================================
-ynh_script_progression --message="Stopping $app service..." --weight=1
-
-ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app.log"
 
 #=================================================
 # BACKUP THE APP MAIN DIR AND CONFIG FILES
 #=================================================
-ynh_script_progression --message="Backing up $app main directory and config files..." --weight=4
 
 ynh_backup --src_path="/etc/default/tvheadend"
 ynh_backup --src_path="$final_path"
@@ -50,7 +40,6 @@ ynh_backup --src_path="$final_path"
 #=================================================
 # BACKUP THE NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Backing up nginx web server configuration..." --weight=1
 
 ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 
@@ -59,21 +48,11 @@ ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 #=================================================
 # BACKUP LOGROTATE AND LOG FILE
 #=================================================
-ynh_script_progression --message="Backing up logrotate configuration and log file..." --weight=1
 
 ynh_backup --src_path="/etc/logrotate.d/$app"
 ynh_backup --src_path="/var/log/$app.log"
 
-#=================================================
-# START TVHEADEND SERVICE
-#=================================================
-ynh_script_progression --message="Starting $app service..." --weight=1
-
-ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app.log"
-
 #=================================================
 # END OF SCRIPT
 #=================================================
-ynh_script_progression --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." --last
+ynh_print_info  --message="Backup script completed for Tvheadend. (YunoHost will then actually copy those files to the archive)."
-
-

scripts/change_url

@@ -52,14 +52,14 @@ fi
 #=================================================
 # STOP TVHEADEND SERVICE
 #=================================================
-ynh_script_progression --message="Stopping $app service..." --weight=1
+ynh_script_progression --message="Stopping Tvheadend service..." --weight=1
 
 ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app.log"
 
 #=================================================
 # MODIFY URL IN NGINX CONF
 #=================================================
-ynh_script_progression --message="Updating nginx web server configuration..." --weight=1
+ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1
 
 nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
 
@@ -90,7 +90,7 @@ fi
 #=================================================
 # ...
 #=================================================
-ynh_script_progression --message="Updating $app configuration..." --weight=1
+ynh_script_progression --message="Updating Tvheadend configuration..." --weight=1
 
 ynh_backup_if_checksum_is_different --file="/etc/default/tvheadend"
 cp ../conf/tvheadend /etc/default/tvheadend
@@ -106,7 +106,7 @@ ynh_store_file_checksum --file="/etc/default/tvheadend"
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_script_progression --message="Reloading nginx web server..." --weight=1
+ynh_script_progression --message="Reloading NGINX web server..." --weight=1
 
 ynh_systemd_action --service_name=nginx --action=reload
 
@@ -120,4 +120,4 @@ ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$ap
 #=================================================
 # END OF SCRIPT
 #=================================================
-ynh_script_progression --message="Change of URL completed for $app" --last
+ynh_script_progression --message="Change of URL completed for Tvheadend" --last

scripts/install

@@ -80,7 +80,7 @@ fi
 #=================================================
 # DOWNLOAD TVHEADEND DEB PACKAGE
 #=================================================
-ynh_script_progression --message="Downloading $app..." --weight=5
+ynh_script_progression --message="Downloading Tvheadend..." --weight=5
 
 temp_folder="$(mktemp -d)"
 tvheadend_deb_dst="$temp_folder/tvheadend_deb.deb"
@@ -101,7 +101,7 @@ ynh_exec_quiet "wget -q -O $tvheadend_deb_dst $tvheadend_deb_url"
 #=================================================
 # INSTALL TVHEADEND DEB PACKAGE
 #=================================================
-ynh_script_progression --message="Installing $app..." --weight=24
+ynh_script_progression --message="Installing Tvheadend..." --weight=24
 
 ynh_exec_warn_less dpkg -i $tvheadend_deb_dst
 
@@ -134,9 +134,9 @@ ynh_store_file_checksum --file="$final_path/.hts/tvheadend/superuser"
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Configuring nginx web server..." --weight=2
+ynh_script_progression --message="Configuring NGINX web server..." --weight=2
 
-# Create a dedicated nginx config
+# Create a dedicated NGINX config
 ynh_add_nginx_config
 
 #=================================================
@@ -164,26 +164,25 @@ ynh_app_setting_set --app=$app --key=skipped_uris --value="/"
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_script_progression --message="Reloading nginx web server..." --weight=1
+ynh_script_progression --message="Reloading NGINX web server..." --weight=1
 
 ynh_systemd_action --service_name=nginx --action=reload
 
 #=================================================
 # PREVENT TVHEADEND BEING UPGRADED THROUGHT APT
 #=================================================
-ynh_script_progression --message="Prevent $app being upgraded throught APT..." --weight=1
+ynh_script_progression --message="Prevent Tvheadend being upgraded throught APT..." --weight=1
 
 apt-mark hold tvheadend
 
 #=================================================
 # START TVHEADEND SERVICE
 #=================================================
-ynh_script_progression --message="Starting $app service..." --weight=1
+ynh_script_progression --message="Starting Tvheadend service..." --weight=1
 
 ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app.log"
 
 #=================================================
 # END OF SCRIPT
 #=================================================
-ynh_script_progression --message="Installation of $app completed, HTTP port is $port and HTSP port is $stream_port" --last
+ynh_script_progression --message="Installation of Tvheadend completed, HTTP port is $port and HTSP port is $stream_port" --last
-

scripts/remove

@@ -28,7 +28,7 @@ stream_port=$(ynh_app_setting_get --app=$app --key=stream_port)
 #=================================================
 # STOP AND DISABLE TVHEADEND SERVICE
 #=================================================
-ynh_script_progression --message="Stopping $app service..." --weight=2
+ynh_script_progression --message="Stopping Tvheadend service..." --weight=2
 
 ynh_systemd_action --service_name=$app --action=stop
 ynh_exec_quiet systemctl disable $app
@@ -37,7 +37,7 @@ ynh_exec_quiet systemctl daemon-reload
 #=================================================
 # UNHOLD TVHEADEND FROM APT
 #=================================================
-ynh_script_progression --message="Disable prevent $app being upgraded throught APT..." --weight=2
+ynh_script_progression --message="Disable prevent Tvheadend being upgraded throught APT..." --weight=2
 
 apt-mark unhold tvheadend
 
@@ -67,15 +67,15 @@ ynh_secure_remove --file="/var/log/$app.log"
 #=================================================
 # REMOVE NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Removing nginx web server configuration..." --weight=1
+ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1
 
-# Remove the dedicated nginx config
+# Remove the dedicated NGINX config
 ynh_remove_nginx_config
 
 #=================================================
 # REMOVE APP MAIN DIR AND CONFIG FILES
 #=================================================
-ynh_script_progression --message="Removing $app main directory and config files..." --weight=2
+ynh_script_progression --message="Removing Tvheadend main directory and config files..." --weight=2
 
 # Remove the app directory securely (/home/hts folder)
 ynh_secure_remove --file="$final_path"
@@ -84,7 +84,7 @@ ynh_secure_remove --file="/etc/default/tvheadend"
 #=================================================
 # REMOVE TVHEADEND
 #=================================================
-ynh_script_progression --message="Removing $app..." --weight=6
+ynh_script_progression --message="Removing Tvheadend..." --weight=6
 
 ynh_package_autopurge $app
 
@@ -122,5 +122,4 @@ fi
 #=================================================
 # END OF SCRIPT
 #=================================================
-ynh_script_progression --message="Removal of $app completed" --last
+ynh_script_progression --message="Removal of Tvheadend completed" --last
-

scripts/restore

@@ -72,7 +72,7 @@ fi
 #=================================================
 # DOWNLOAD TVHEADEND DEB PACKAGE
 #=================================================
-ynh_script_progression --message="Downloading $app..." --weight=3
+ynh_script_progression --message="Downloading Tvheadend..." --weight=3
 
 temp_folder="$(mktemp -d)"
 tvheadend_deb_dst="$temp_folder/tvheadend_deb.deb"
@@ -93,7 +93,7 @@ ynh_exec_quiet "wget -q -O $tvheadend_deb_dst $tvheadend_deb_url"
 #=================================================
 # INSTALL TVHEADEND DEB PACKAGE
 #=================================================
-ynh_script_progression --message="Installing $app..." --weight=13
+ynh_script_progression --message="Installing Tvheadend..." --weight=13
 
 ynh_exec_warn_less dpkg -i $tvheadend_deb_dst
 
@@ -108,7 +108,7 @@ ynh_systemd_action --service_name=$app --action="stop"
 #=================================================
 # RESTORE TVHEADEND CONFIG FILES
 #=================================================
-ynh_script_progression --message="Restoring $app main directory and config files..." --weight=1
+ynh_script_progression --message="Restoring Tvheadend main directory and config files..." --weight=1
 
 ynh_restore_file --origin_path="/etc/default/tvheadend"
 ynh_restore_file --origin_path="$final_path"
@@ -116,7 +116,7 @@ ynh_restore_file --origin_path="$final_path"
 #=================================================
 # RESTORE THE NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Restoring nginx web server configuration..." --weight=1
+ynh_script_progression --message="Restoring NGINX web server configuration..." --weight=1
 
 ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 
@@ -143,26 +143,26 @@ ynh_app_setting_set --app=$app --key=skipped_uris --value="/"
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_script_progression --message="Reloading nginx web server..." --weight=1
+ynh_script_progression --message="Reloading NGINX web server..." --weight=1
 
 ynh_systemd_action --service_name=nginx --action=reload
 
 #=================================================
 # PREVENT TVHEADEND BEING UPGRADED THROUGHT APT
 #=================================================
-ynh_script_progression --message="Prevent $app being upgraded throught APT..." --weight=1
+ynh_script_progression --message="Prevent Tvheadend being upgraded throught APT..." --weight=1
 
 apt-mark hold tvheadend
 
 #=================================================
 # START TVHEADEND SERVICE
 #=================================================
-ynh_script_progression --message="Starting $app service..." --weight=1
+ynh_script_progression --message="Starting Tvheadend service..." --weight=1
 
 ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app.log"
 
 #=================================================
 # END OF SCRIPT
 #=================================================
-ynh_script_progression --message="Installation of $app completed, HTTP port is $port and HTSP port is $stream_port" --last
+ynh_script_progression --message="Installation of Tvheadend completed, HTTP port is $port and HTSP port is $stream_port" --last
 

scripts/upgrade

@@ -31,7 +31,7 @@ upgrade_type=$(ynh_check_app_version_changed)
 #=================================================
 # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
 #=================================================
-ynh_script_progression --message="Backing up $app before upgrading (may take a while)..." --weight=4
+ynh_script_progression --message="Backing up Tvheadend before upgrading (may take a while)..." --weight=4
 
 # Backup the current version of the app
 ynh_backup_before_upgrade
@@ -47,7 +47,7 @@ ynh_abort_if_errors
 #=================================================
 # STOP SYSTEMD SERVICE
 #=================================================
-ynh_script_progression --message="Stopping $app service..." --weight=3
+ynh_script_progression --message="Stopping Tvheadend service..." --weight=3
 
 ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app.log"
 
@@ -71,7 +71,7 @@ then
     #=================================================
     # DOWNLOAD TVHEADEND DEB PACKAGE
     #=================================================
-    ynh_script_progression --message="Downloading $app..." --weight=5
+    ynh_script_progression --message="Downloading Tvheadend..." --weight=5
 
     temp_folder="$(mktemp -d)"
     tvheadend_deb_dst="$temp_folder/tvheadend_deb.deb"
@@ -92,7 +92,7 @@ then
     #=================================================
     # INSTALL TVHEADEND DEB PACKAGE
     #=================================================
-    ynh_script_progression --message="Upgrading $app..." --weight=24
+    ynh_script_progression --message="Upgrading Tvheadend..." --weight=24
 
     ynh_exec_warn_less dpkg -i $tvheadend_deb_dst
 
@@ -123,7 +123,7 @@ ynh_app_setting_set --app=$app --key=skipped_uris --value="/"
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_script_progression --message="Reloading nginx web server..." --weight=1
+ynh_script_progression --message="Reloading NGINX web server..." --weight=1
 
 ynh_systemd_action --service_name=nginx --action=reload
 
@@ -135,15 +135,11 @@ apt-mark hold tvheadend
 #=================================================
 # START TVHEADEND SERVICE
 #=================================================
-ynh_script_progression --message="Starting $app service..." --weight=1
+ynh_script_progression --message="Starting Tvheadend service..." --weight=1
 
 ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app.log"
 
 #=================================================
 # END OF SCRIPT
 #=================================================
-ynh_script_progression --message="Upgrade of $app completed, HTTP port is $port and HTSP port is $stream_port" --last
+ynh_script_progression --message="Upgrade of Tvheadend completed, HTTP port is $port and HTSP port is $stream_port" --last
-
-
-
-