Merge pull request #85 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.
+-->
+
 # Rainloop for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/rainloop.svg)](https://dash.yunohost.org/appci/app/rainloop) ![](https://ci-apps.yunohost.org/ci/badges/rainloop.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/rainloop.maintain.svg)  
@@ -5,70 +10,28 @@
 
 *[Lire ce readme en français.](./README_fr.md)*
 
-> *This package allow you to install Rainloop quickly and simply on a YunoHost server.  
+> *This package allows you to install Rainloop quickly and simply on a YunoHost server.
-If you don't have YunoHost, please see [here](https://yunohost.org/install) to know how to install and enjoy it.*
+If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
 
 ## Overview
 
-Rainloop is a lightweight webmail.
+Lightweight multi-account webmail
 
-**Shipped version:** 1.15.0
+**Shipped version:** 1.16.0~ynh2
 
-## Screenshots
+**Demo:** https://mail.rainloop.net/
 
-![](https://www.rainloop.net/static/media/screenshots/v2/12.png)
+## Documentation and resources
-
-## Demo
-
-* [YunoHost demo](https://demo.yunohost.org/rainloop/app/)
-* [Official demo](https://mail.rainloop.net/)
-
-## Configuration
-
-Go to http://DOMAIN.TLD/rainloop/app/?admin
-
-- The default login: admin
-- The default password: password chosen during install
-
-- If you lost the admin password, you can retrieve it using `sudo yunohost app setting rainloop password`
-
-Each user can add a remote carddav server from their own parameters interface.
-
-- If you use Baïkal, the CardDav address is `https://DOMAIN.TLD/baikal/card.php/addressbooks/USER/default/`
-- If you use Nextcloud, the CardDav address is `https://DOMAIN.TLD/nextcloud/remote.php/carddav/addressbooks/USER/contacts`
-
-## Documentation
-
- * Official documentation: https://www.rainloop.net/docs/configuration/
- * YunoHost documentation: https://yunohost.org/en/app_rainloop
-
-## YunoHost specific features
-
-#### Multi-users support
-
-#### Supported architectures
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/rainloop.svg)](https://ci-apps.yunohost.org/ci/apps/rainloop/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/rainloop.svg)](https://ci-apps-arm.yunohost.org/ci/apps/rainloop/)
-
-## Limitations
-
-## Additional information
-
-* Rainloop saves your PGP private keys in the browser storage. This means that you will loose your private keys if you clear your browser storage (e.g., private browsing, different computer...). This packages integrates [PGPback by chtixof](https://github.com/chtixof/pgpback_ynh) so you can store your PGP private keys on the server securely. Go to **http://DOMAIN.TLD/rainloop/pgpback** to backup your PGP keys on the server or restore them.
-
-## Links
 
+* Official app website: https://www.rainloop.net/
+* Official admin documentation: https://www.rainloop.net/docs/configuration/
+* Upstream app code repository: https://github.com/RainLoop/rainloop-webmail
+* YunoHost documentation for this app: https://yunohost.org/app_rainloop
 * Report a bug: https://github.com/YunoHost-Apps/rainloop_ynh/issues
- * Rainloop website: https://www.rainloop.net/
- * Rainloop GitHub website: https://github.com/RainLoop/rainloop-webmail
- * YunoHost website: https://yunohost.org/
 
----
+## Developer info
 
-## Developers info
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/rainloop_ynh/tree/testing).
-
-Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/rainloop_ynh/tree/testing).
 
 To try the testing branch, please proceed like that.
 ```
@@ -76,3 +39,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/rainloop_ynh/tree/tes
 or
 sudo yunohost app upgrade rainloop -u https://github.com/YunoHost-Apps/rainloop_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps

README_fr.md

@@ -1,69 +1,29 @@
 # Rainloop pour YunoHost
 
-[![Integration level](https://dash.yunohost.org/integration/rainloop.svg)](https://dash.yunohost.org/appci/app/rainloop) ![](https://ci-apps.yunohost.org/ci/badges/rainloop.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/rainloop.maintain.svg)  
+[![Niveau d'intégration](https://dash.yunohost.org/integration/rainloop.svg)](https://dash.yunohost.org/appci/app/rainloop) ![](https://ci-apps.yunohost.org/ci/badges/rainloop.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/rainloop.maintain.svg)  
 [![Installer Rainloop avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=rainloop)
 
 *[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
 
 > *Ce package vous permet d'installer Rainloop 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.*
+Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
 
 ## Vue d'ensemble
 
-Rainloop est un webmail léger.
+Webmail léger multi-comptes
 
-**Version incluse:** 1.16.0
+**Version incluse :** 1.16.0~ynh2
 
-## Captures d'écran
+**Démo :** https://mail.rainloop.net/
 
-![](https://www.rainloop.net/static/media/screenshots/v2/12.png)
+## Documentations et ressources
 
-## Démo
+* Site officiel de l'app : https://www.rainloop.net/
-
+* Documentation officielle de l'admin : https://www.rainloop.net/docs/configuration/
-* [Démo YunoHost](https://demo.yunohost.org/rainloop/app/)
+* Dépôt de code officiel de l'app : https://github.com/RainLoop/rainloop-webmail
-* [Démo officielle](https://mail.rainloop.net/)
+* Documentation YunoHost pour cette app : https://yunohost.org/app_rainloop
-
+* Signaler un bug : https://github.com/YunoHost-Apps/rainloop_ynh/issues
-## Configuration
-
-Veuillez vous rendre sur http://DOMAIN.TLD/rainloop/app/?admin
-
-- Le nom d'utilisateur admin par défaut : admin
-- Le mot de passe admin par défaut : Mot de passe choisi lors de l'installation
-- Si vous avez oublié votre mot de passe, vous pouvez le retrouver avec `sudo yunohost app setting rainloop password`
-
-Chaque utilisateur peut ajouter un carnet d'adresse distant CardDav via leurs propres paramètres.
-
-- Si vous utilisez Baïkal, l'adresse à renseigner est du type `https://DOMAIN.TLD/baikal/card.php/addressbooks/UTILISATEUR/default`
-- Si vous utilisez Nextcloud, l'adresse à renseigner est du type `https://DOMAIN.TLD/nextcloud/remote.php/carddav/addressbooks/USER/contacts`
-
-## Documentation
-
- * Documentation officielle : https://www.rainloop.net/docs/configuration/
- * Documentation YunoHost : https://yunohost.org/fr/app_rainloop
-
-## Caractéristiques spécifiques YunoHost
-
-#### Support multi-utilisateurs
-
-#### Supported architectures
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/rainloop.svg)](https://ci-apps.yunohost.org/ci/apps/rainloop/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/rainloop.svg)](https://ci-apps-arm.yunohost.org/ci/apps/rainloop/)
-
-## Limitations
-
-## Informations additionnelles
-
-* Rainloop stocke les clés PGP privées dans le stockage de navigateur. Cela implique que vos clés seront perdues quand vous videz le stockage de navigateur (navigation incognito, changement d'ordinateur...). Ce paquet intègre [PGPback de chtixof](https://github.com/chtixof/pgpback_ynh) pour que vous puissiez stocker vos clés privées PGP de manière sécurisée sur le serveur. Rendez-vous **http://DOMAIN.TLD/rainloop/pgpback** pour stocker vos clés privées PGP sur le serveur ou les restaurer dans un nouveau navigateur.
-
-## Links
-
- * Signaler un bug : https://github.com/YunoHost-Apps/rainloop_ynh/issues
- * Site de Rainloop : https://www.rainloop.net/
- * GitHub de Rainloop : https://github.com/RainLoop/rainloop-webmail
- * Site web YunoHost : https://yunohost.org/
-
----
 
 ## Informations pour les développeurs
 
@@ -75,3 +35,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/rainloop_ynh/tree/tes
 ou
 sudo yunohost app upgrade rainloop -u https://github.com/YunoHost-Apps/rainloop_ynh/tree/testing --debug
 ```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps

check_process

@@ -1,9 +1,9 @@
 ;; Test complet
 	; Manifest
-        domain="domain.tld"    (DOMAIN)
+        domain="domain.tld"
-        path="/rainloop"    (PATH)
+        path="/rainloop"
         language="en"
-        is_public=1 (PUBLIC|public=1|private=0)
+        is_public=1
 	    password="pass"
         ldap=1
     ; Checks

conf/app.src

@@ -3,4 +3,3 @@ SOURCE_SUM=db949c4363b048a02eaa0f06a26a8386979b8734198c2939ee1e8cc54362ca67
 SOURCE_SUM_PRG=sha256sum
 SOURCE_FORMAT=zip
 SOURCE_IN_SUBDIR=false
-SOURCE_FILENAME=

conf/nginx.conf

@@ -4,11 +4,6 @@ location __PATH__/ {
 	# Path to source
 	alias __FINALPATH__/;
 
-	# Force usage of https
-	if ($scheme = http) {
-		rewrite ^ https://$server_name$request_uri? permanent;
-	}
-
 	location ^~ __PATH__/app/data {
 		deny all;
 	}

manifest.json

@@ -6,14 +6,21 @@
 		"en": "Lightweight multi-account webmail",
 		"fr": "Webmail léger multi-comptes"
 	},
-	"version": "1.16.0~ynh1",
+	"version": "1.16.0~ynh2",
 	"url": "https://www.rainloop.net/",
+	"upstream": {
+        "license": "AGPL-3.0-or-later",
+        "website": "https://www.rainloop.net/",
+        "demo": "https://mail.rainloop.net/",
+        "admindoc": "https://www.rainloop.net/docs/configuration/",
+        "code": "https://github.com/RainLoop/rainloop-webmail"
+    },
 	"license": "AGPL-3.0-or-later",
 	"maintainer": {
 		"name": "scith, Djip007, polytan02"
 	},
 	"requirements": {
-		"yunohost": ">= 4.1.7"
+		"yunohost": ">= 4.3.0"
 	},
 	"multi_instance": true,
 	"services": [
@@ -25,8 +32,7 @@
 		"install" : [
 			{
 				"name": "domain",
-				"type": "domain",
+				"type": "domain"
-                "example": "example.com"
 			},
 			{
 				"name": "path",
@@ -41,8 +47,7 @@
 			},
 			{
 				"name": "password",
-				"type": "password",
+				"type": "password"
-				"example": "Choose a password"
 			},
 			{
 				"name": "ldap",

pull_request_template.md

@@ -1,16 +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
----
-* An automatic package_check will be launch at https://ci-apps-dev.yunohost.org/, when you add a specific comment to your Pull Request: "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!"*

scripts/backup

@@ -51,12 +51,6 @@ ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 
 ynh_backup --src_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
 
-#=================================================
-# BACKUP THE MYSQL DATABASE
-#=================================================
-
-ynh_mysql_dump_db --database="$db_name" > db.sql
-
 #=================================================
 # BACKUP FAIL2BAN CONFIGURATION
 #=================================================
@@ -72,6 +66,12 @@ ynh_backup --src_path="/etc/fail2ban/filter.d/$app.conf"
 
 ynh_backup --src_path="/etc/logrotate.d/$app"
 
+#=================================================
+# BACKUP THE MYSQL DATABASE
+#=================================================
+
+ynh_mysql_dump_db --database="$db_name" > db.sql
+
 #=================================================
 # END OF SCRIPT
 #=================================================

scripts/restore

@@ -34,10 +34,7 @@ phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 #=================================================
 ynh_script_progression --message="Validating restoration parameters..." --weight=1
 
-ynh_webpath_available --domain=$domain --path_url=$path_url \
+test ! -d $final_path || ynh_die --message="There is already a directory: $final_path "
-	|| ynh_die --message="Path not available: ${domain}${path_url}"
-test ! -d $final_path \
-	|| ynh_die --message="There is already a directory: $final_path "
 
 #=================================================
 # STANDARD RESTORATION STEPS