Merge pull request #6 from YunoHost-Apps/Cleaning

Cleaning

.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,44 +1,42 @@
-# YunoMonitor
+<!--
+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.
+-->
 
-[![Integration level](https://dash.yunohost.org/integration/yunomonitor.svg)](https://dash.yunohost.org/appci/app/yunomonitor)  
+# YunoMonitor for YunoHost
-[![Install yunomonitor with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=yunomonitor)
 
+[![Integration level](https://dash.yunohost.org/integration/yunomonitor.svg)](https://dash.yunohost.org/appci/app/yunomonitor) ![](https://ci-apps.yunohost.org/ci/badges/yunomonitor.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/yunomonitor.maintain.svg)  
+[![Install YunoMonitor with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=yunomonitor)
 
-> *This package allow you to install yunomonitor quickly and simply on a YunoHost server.  
+*[Lire ce readme en français.](./README_fr.md)*
-If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
+
+> *This package allows you to install YunoMonitor 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
+
+Home made tool to monitor automatically your servers
+
+**Shipped version:** 1.1.0~ynh2
+
+
+
+## Disclaimers / important information
+
 YunoMonitor is a simple tools to auto-configure monitoring on a remote YunoHost server. So you need one server to monitor and another to run monitoring task.
 
 YunoMonitor can send you email or SMS if you give him an URL API to do it (like the API from the operator "free mobile").
+## Documentation and resources
 
-**Shipped version:** 1.0
+* Official app website: https://github.com/zamentur/yunomonitor
+* Official admin documentation: https://github.com/zamentur/yunomonitor/blob/master/README.md
+* Upstream app code repository: https://github.com/zamentur/yunomonitor
+* YunoHost documentation for this app: https://yunohost.org/app_yunomonitor
+* Report a bug: https://github.com/YunoHost-Apps/yunomonitor_ynh/issues
 
-## Documentation
+## Developer info
 
- * Official documentation: https://github.com/zamentur/yunomonitor/blob/master/README.md
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/yunomonitor_ynh/tree/testing).
-
-## YunoHost specific features
-
-#### Supported architectures
-
-* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/yunomonitor%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/yunomonitor/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/yunomonitor%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/yunomonitor/)
-
-## Links
-
- * Report a bug: https://github.com/YunoHost-Apps/yunomonitor_ynh/issues
- * App website: https://github.com/zamentur/yunomonitor
- * Upstream app repository: https://github.com/zamentur/yunomonitor
- * YunoHost website: https://yunohost.org/
-
----
-
-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/yunomonitor_ynh/tree/testing).
 
 To try the testing branch, please proceed like that.
 ```
@@ -46,3 +44,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/yunomonitor_ynh/tree/
 or
 sudo yunohost app upgrade yunomonitor -u https://github.com/YunoHost-Apps/yunomonitor_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps

README_fr.md

@@ -0,0 +1,44 @@
+# YunoMonitor pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/yunomonitor.svg)](https://dash.yunohost.org/appci/app/yunomonitor) ![](https://ci-apps.yunohost.org/ci/badges/yunomonitor.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/yunomonitor.maintain.svg)  
+[![Installer YunoMonitor avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=yunomonitor)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *Ce package vous permet d'installer YunoMonitor 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
+
+Outil pour surveiller automatiquement vos serveurs
+
+**Version incluse :** 1.1.0~ynh2
+
+
+
+## Avertissements / informations importantes
+
+YunoMonitor is a simple tools to auto-configure monitoring on a remote YunoHost server. So you need one server to monitor and another to run monitoring task.
+
+YunoMonitor can send you email or SMS if you give him an URL API to do it (like the API from the operator "free mobile").
+## Documentations et ressources
+
+* Site officiel de l'app : https://github.com/zamentur/yunomonitor
+* Documentation officielle de l'admin : https://github.com/zamentur/yunomonitor/blob/master/README.md
+* Dépôt de code officiel de l'app : https://github.com/zamentur/yunomonitor
+* Documentation YunoHost pour cette app : https://yunohost.org/app_yunomonitor
+* Signaler un bug : https://github.com/YunoHost-Apps/yunomonitor_ynh/issues
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/yunomonitor_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/yunomonitor_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade yunomonitor -u https://github.com/YunoHost-Apps/yunomonitor_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps

conf/systemd.service

@@ -4,6 +4,8 @@ After=network.target
 
 [Service]
 Type=oneshot
+User=__APP__
+Group=__APP__
 WorkingDirectory=__FINALPATH__
 ExecStart=__FINALPATH__/yunomonitor.py -c __FINALPATH__/conf/__APP__.yml 
 User=root

doc/DISCLAIMER.md

@@ -0,0 +1,3 @@
+YunoMonitor is a simple tools to auto-configure monitoring on a remote YunoHost server. So you need one server to monitor and another to run monitoring task.
+
+YunoMonitor can send you email or SMS if you give him an URL API to do it (like the API from the operator "free mobile").

manifest.json

@@ -6,8 +6,14 @@
         "en": "Home made tool to monitor automatically your servers",
         "fr": "Outil pour surveiller automatiquement vos serveurs"
     },
-    "version": "1.1.0~ynh1",
+    "version": "1.1.0~ynh2",
     "url": "https://github.com/zamentur/yunomonitor",
+    "upstream": {
+        "license": "AGPL-3.0",
+        "website": "https://github.com/zamentur/yunomonitor",
+        "admindoc": "https://github.com/zamentur/yunomonitor/blob/master/README.md",
+        "code": "https://github.com/zamentur/yunomonitor"
+    },
     "license": "AGPL-3.0",
     "maintainer": {
         "name": "ljf",

pull_request_template.md

@@ -1,18 +0,0 @@
-## Problem
-- *Description of why you made this PR*
-
-## Solution
-- *And how do you fix that problem*
-
-## PR Status
-- [ ] Code finished.
-- [ ] Tested with Package_check.
-- [ ] Fix or enhancement tested.
-- [ ] Upgrade from last version tested.
-- [ ] Can be reviewed and tested.
-
-## Package_check results
----
-*If you have access to [App Continuous Integration for packagers](https://yunohost.org/#/packaging_apps_ci) you can provide a link to the package_check results like below, replacing '-NUM-' in this link by the PR number and USERNAME by your username on the ci-apps-dev. Or you provide a screenshot or a pastebin of the results*
-
-[![Build Status](https://ci-apps-dev.yunohost.org/jenkins/job/APP_ynh%20PR-NUM-%20(USERNAME)/badge/icon)](https://ci-apps-dev.yunohost.org/jenkins/job/APP_ynh%20PR-NUM-%20(USERNAME)/)  

scripts/_common.sh

@@ -28,6 +28,7 @@ ynh_export () {
 }
 # Save listed var in YunoHost app settings 
 # usage: ynh_save_args VARNAME1 [VARNAME2 [...]]
+
 ynh_save_args () {
     for var in $@;
     do

scripts/install

@@ -46,9 +46,15 @@ ynh_script_progression --message="Storing installation settings..." --weight=1
 ynh_save_args domain path_url monitored_servers monitoring_servers mails sms_api
 
 #=================================================
-# STANDARD MODIFICATIONS
+# 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"
+
+#=================================================
+# STANDARD MODIFICATIONS
 #=================================================
 # INSTALL DEPENDENCIES
 #=================================================
@@ -65,10 +71,14 @@ ynh_app_setting_set --app=$app --key=final_path --value=$final_path
 # Download, check integrity, uncompress and patch the source from app.src
 ynh_setup_source --dest_dir="$final_path"
 
+chmod 750 "$final_path"
+chmod -R o-rwx "$final_path"
+chown -R $app:www-data "$final_path"
+
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Configuring nginx web server..." --weight=1
+ynh_script_progression --message="Configuring NGINX web server..." --weight=1
 
 # Create a dedicated nginx config
 # Note: i don't use the helper because i need this file to be named "000-"
@@ -79,14 +89,6 @@ ynh_replace_string --match_string="__FINALPATH__" --replace_string="$final_path"
 ynh_store_file_checksum --file="$finalnginxconf"
 ynh_systemd_action --service_name=nginx --action=reload
 
-#=================================================
-# CREATE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Configuring system user..." --weight=1
-
-# Create a system user
-ynh_system_user_create --username=$app
-
 #=================================================
 # SPECIFIC SETUP
 #=================================================
@@ -136,23 +138,14 @@ echo "method level server message target" > $final_path/conf/ignore_alert.csv
 #=================================================
 
 # Set permissions to app files
-chown -R root: $final_path
-chown $app:$app $final_path/yunomonitor.py
 chmod u+x $final_path/yunomonitor.py
 chmod u+w $final_path/conf
 chmod u+w $final_path/well-known
 
-#=================================================
-# SETUP SSOWAT
-#=================================================
-ynh_script_progression --message="Configuring SSOwat..." --weight=1
-
-ynh_app_setting_set --app=$app --key=unprotected_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
 

scripts/remove

@@ -55,7 +55,7 @@ ynh_secure_remove --file="$final_path"
 #=================================================
 # 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
 ynh_remove_nginx_config

scripts/restore

@@ -51,7 +51,7 @@ ynh_install_app_dependencies $pkg_dependencies
 ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
 
 # Create the dedicated user (if not existing)
-ynh_system_user_create --username=$app
+ynh_system_user_create --username=$app --home_dir="$final_path"
 
 #=================================================
 # RESTORE FILES
@@ -65,9 +65,12 @@ ynh_restore
 #=================================================
 
 # Restore permissions on app files
-chown -R root: $final_path
+chmod 750 "$final_path"
-chown $app:$app $final_path/yunomonitor.py
+chmod -R o-rwx "$final_path"
+chown -R $app:www-data "$final_path"
 chmod u+x $final_path/yunomonitor.py
+chmod u+w $final_path/conf
+chmod u+w $final_path/well-known
 
 #=================================================
 # RESTORE SYSTEMD
@@ -84,7 +87,7 @@ systemctl start $app.timer
 #=================================================
 # RELOAD NGINX AND PHP-FPM
 #=================================================
-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
 

scripts/upgrade

@@ -23,12 +23,6 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 # CHECK VERSION
 #=================================================
 
-### This helper will compare the version of the currently installed app and the version of the upstream package.
-### $upgrade_type can have 2 different values
-### - UPGRADE_APP if the upstream app version has changed
-### - UPGRADE_PACKAGE if only the YunoHost package has changed
-### ynh_check_app_version_changed will stop the upgrade if the app is up to date.
-### UPGRADE_APP should be used to upgrade the core app only if there's an upgrade to do.
 upgrade_type=$(ynh_check_app_version_changed)
 
 #=================================================
@@ -54,6 +48,14 @@ ynh_clean_setup () {
 ## Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
 
+#=================================================
+# CREATE DEDICATED USER
+#=================================================
+ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
+
+# Create a dedicated user (if not existing)
+ynh_system_user_create --username=$app --home_dir="$final_path"
+
 #=================================================
 # STANDARD UPGRADE STEPS
 #=================================================
@@ -68,10 +70,17 @@ then
 	ynh_setup_source --dest_dir="$final_path"
 fi
 
+chmod 750 "$final_path"
+chmod -R o-rwx "$final_path"
+chown -R $app:www-data "$final_path"
+chmod u+x $final_path/yunomonitor.py
+chmod u+w $final_path/conf
+chmod u+w $final_path/well-known
+
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Upgrading nginx web server configuration..." --weight=1
+ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1
 
 # Create a dedicated nginx config
 # Note: i don't use the helper because i need this file to be named "000-"
@@ -89,14 +98,6 @@ ynh_script_progression --message="Upgrading dependencies..." --weight=1
 
 ynh_install_app_dependencies $pkg_dependencies
 
-#=================================================
-# CREATE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
-
-# Create a dedicated user (if not existing)
-ynh_system_user_create --username=$app
-
 #=================================================
 # SETUP SYSTEMD
 #=================================================
@@ -115,28 +116,10 @@ ynh_backup_if_checksum_is_different --file="$final_path/conf/$app.yml"
 # Recalculate and store the checksum of the file for the next upgrade.
 ynh_store_file_checksum --file="$final_path/conf/$app.yml"
 
-#=================================================
-# GENERIC FINALIZATION
-#=================================================
-# SECURE FILES AND DIRECTORIES
-#=================================================
-
-# Set permissions on app files
-chown -R root: $final_path
-chown $app:$app $final_path/yunomonitor.py
-chmod u+x $final_path/yunomonitor.py
-
-#=================================================
-# SETUP SSOWAT
-#=================================================
-ynh_script_progression --message="Configuring SSOwat..." --weight=1
-
-ynh_app_setting_set --app=$app --key=unprotected_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