Merge pull request #4 from YunoHost-Apps/testing

Testing

.github/ISSUE_TEMPLATE.md

@@ -6,11 +6,11 @@ about: When creating a bug report, please use the following template to provide
 
 **How to post a meaningful bug report**
 1. *Read this whole template first.*
-2. *Make sure you are on the right place:*
+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.*
-   - *In doubt, ask here and we will figure it out together.*
+   - *When in doubt, post here and we will figure it out together.*
-3. *Delete these italic comments as you write over them below, and remove this guide.*
+3. *Delete the italic comments as you write over them below, and remove this guide.*
 --- 
 
 ### Describe the bug
@@ -22,7 +22,7 @@ about: When creating a bug report, please use the following template to provide
 - 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*
+- 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`*
@@ -31,7 +31,7 @@ about: When creating a bug report, please use the following template to provide
 
 - *If you performed a command from the CLI, the command itself is enough. For example:*
     ```sh
-    sudo yunohost app install encryptic
+    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:*

.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.
+-->
+
 # Encryptic for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/encryptic.svg)](https://dash.yunohost.org/appci/app/encryptic) ![](https://ci-apps.yunohost.org/ci/badges/encryptic.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/encryptic.maintain.svg)  
@@ -5,60 +10,40 @@
 
 *[Lire ce readme en français.](./README_fr.md)*
 
-> *This package allows you to install Encryptic quickly and simply on a YunoHost server.  
+> *This package allows you to install Encryptic 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
+
 Encryptic (fork of Laverna) is an anonymous system, encrypted and without registration required, it is accessible via a web browser (without software installation).
 The data is private because it is stored by default on your machine (InnoDB and localstorage), it is a setting in the settings that will allow you to synchronize it via the cloud on your various devices.
 
-**Shipped version:** 0.1.0
+### Features
+
+- Markdown editor based on Pagedown
+- Synchronization with cloud storage via Dropbox or RemoteStorage
+- Multiple editing modes: normal, preview, and distraction free
+- Offline access to your notes
+- WYSIWYG control buttons
+- Syntax highlighting, MathJax support
+- Robust keyboard shortcuts
+
+
+**Shipped version:** 0.1.0~ynh3
+
+**Demo:** https://app.encryptic.org/
 
 ## Screenshots
 
-![](sources/encryptic.png)
+![](./doc/screenshots/encryptic.png)
 
-## Demo
+## Documentation and resources
 
-* [Official demo](https://app.encryptic.org/)
+* Official app website: https://www.encryptic.org/
-
+* Official admin documentation: https://github.com/encryptic-team/encryptic/wiki
-## Configuration
+* Upstream app code repository: https://github.com/encryptic-team/encryptic
-
+* YunoHost documentation for this app: https://yunohost.org/app_encryptic
-* How to configure this app: From an admin panel.
+* Report a bug: https://github.com/YunoHost-Apps/encryptic_ynh/issues
-
-## Documentation
-
- * Official documentation: https://github.com/encryptic-team/encryptic/wiki
- * YunoHost documentation: If specific documentation is needed, feel free to contribute.
-
-## YunoHost specific features
-
-#### Multi-user support
-
- * Are LDAP and HTTP auth supported? **No**
- * Can the app be used by multiple users? **Yes**
-
-#### Supported architectures
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/encryptic%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/encryptic/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/encryptic%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/encryptic/)
-
-## 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/encryptic_ynh/issues
- * App website: https://encryptic.org/
- * Upstream app repository: https://github.com/encryptic-team/encryptic
- * YunoHost website: https://yunohost.org/
-
----
 
 ## Developer info
 
@@ -70,3 +55,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/encryptic_ynh/tree/te
 or
 sudo yunohost app upgrade encryptic -u https://github.com/YunoHost-Apps/encryptic_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps

README_fr.md

@@ -1,64 +1,45 @@
 # Encryptic pour YunoHost
 
-[![Integration level](https://dash.yunohost.org/integration/encryptic.svg)](https://dash.yunohost.org/appci/app/encryptic) ![](https://ci-apps.yunohost.org/ci/badges/encryptic.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/encryptic.maintain.svg)  
+[![Niveau d'intégration](https://dash.yunohost.org/integration/encryptic.svg)](https://dash.yunohost.org/appci/app/encryptic) ![](https://ci-apps.yunohost.org/ci/badges/encryptic.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/encryptic.maintain.svg)  
 [![Installer Encryptic avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=encryptic)
 
-*[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 Encryptic rapidement et simplement sur un serveur YunoHost.  
+> *Ce package vous permet d'installer Encryptic 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
-Encryptic est un système anonyme, crypté et sans inscription requise, il est accessible via un navigateur web (sans installation de logiciel).
-Les données sont privées, car stockées par défaut sur votre machine (InnoDB et localstorage), c’est un réglage dans les paramètres qui vous permettra de les synchroniser via le cloud sur vos différents périphériques.
 
-**Version incluse :** 0.1.0
+Encryptic (fork of Laverna) is an anonymous system, encrypted and without registration required, it is accessible via a web browser (without software installation).
+The data is private because it is stored by default on your machine (InnoDB and localstorage), it is a setting in the settings that will allow you to synchronize it via the cloud on your various devices.
+
+### Features
+
+- Markdown editor based on Pagedown
+- Synchronization with cloud storage via Dropbox or RemoteStorage
+- Multiple editing modes: normal, preview, and distraction free
+- Offline access to your notes
+- WYSIWYG control buttons
+- Syntax highlighting, MathJax support
+- Robust keyboard shortcuts
+
+
+**Version incluse :** 0.1.0~ynh3
+
+**Démo :** https://app.encryptic.org/
 
 ## Captures d'écran
 
-![](sources/encryptic.png)
+![](./doc/screenshots/encryptic.png)
 
-## Démo
+## Documentations et ressources
 
-* [Démo officielle](https://app.encryptic.org/)
+* Site officiel de l'app : https://www.encryptic.org/
-
+* Documentation officielle de l'admin : https://github.com/encryptic-team/encryptic/wiki
-## Configuration
+* Dépôt de code officiel de l'app : https://github.com/encryptic-team/encryptic
-
+* Documentation YunoHost pour cette app : https://yunohost.org/app_encryptic
-Comment configurer cette application : via le panneau d'administration, un fichier brut en SSH ou tout autre moyen.
+* Signaler un bug : https://github.com/YunoHost-Apps/encryptic_ynh/issues
-
-## Documentation
-
- * Documentation officielle : https://github.com/encryptic-team/encryptic/wiki
- * Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer.
-
-## Caractéristiques spécifiques YunoHost
-
-#### Support multi-utilisateur
-
-* L'authentification LDAP et HTTP est-elle prise en charge ? **Non**
-* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui**
-
-#### Architectures supportées
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/encryptic%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/encryptic/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/encryptic%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/encryptic/)
-
-## Limitations
-
-* Limitations connues.
-
-## Informations additionnelles
-
-* Autres informations que vous souhaitez ajouter sur cette application.
-
-## Liens
-
- * Signaler un bug : https://github.com/YunoHost-Apps/encryptic_ynh/issues
- * Site de l'application : https://encryptic.org/
- * Dépôt de l'application principale : https://github.com/encryptic-team/encryptic
- * Site web YunoHost : https://yunohost.org/
-
----
 
 ## Informations pour les développeurs
 
@@ -70,3 +51,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/encryptic_ynh/tree/te
 ou
 sudo yunohost app upgrade encryptic -u https://github.com/YunoHost-Apps/encryptic_ynh/tree/testing --debug
 ```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps

check_process

@@ -1,13 +1,8 @@
-# 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"
-		path="/path"	(PATH)
+		path="/path"
-		is_public=1	(PUBLIC|public=1|private=0)
+		is_public=1
 	; Checks
 		pkg_linter=1
 		setup_sub_dir=1

conf/app.src

@@ -3,4 +3,3 @@ SOURCE_SUM=f59d2cf4fbfec704404c35b8c5aba3c4361a6f3afee95a0beccc16fcc34985e4
 SOURCE_SUM_PRG=sha256sum
 SOURCE_FORMAT=zip
 SOURCE_IN_SUBDIR=true
-SOURCE_FILENAME=

doc/DESCRIPTION.md

@@ -0,0 +1,12 @@
+Encryptic (fork of Laverna) is an anonymous system, encrypted and without registration required, it is accessible via a web browser (without software installation).
+The data is private because it is stored by default on your machine (InnoDB and localstorage), it is a setting in the settings that will allow you to synchronize it via the cloud on your various devices.
+
+### Features
+
+- Markdown editor based on Pagedown
+- Synchronization with cloud storage via Dropbox or RemoteStorage
+- Multiple editing modes: normal, preview, and distraction free
+- Offline access to your notes
+- WYSIWYG control buttons
+- Syntax highlighting, MathJax support
+- Robust keyboard shortcuts

manifest.json

@@ -3,18 +3,25 @@
     "id": "encryptic",
     "packaging_format": 1,
     "description": {
-        "en": "Open-source note-taking application heavily focused on encryption.",
+        "en": "Open-source note-taking application heavily focused on encryption",
-        "fr": "Application de prise de notes open source axée sur le chiffrement."
+        "fr": "Application de prise de notes open source axée sur le chiffrement"
     },
         "version": "0.1.0~ynh3",
     "url": "https://www.encryptic.org/",
+    "upstream": {
+        "license": "MPL-2.0",
+        "website": "https://www.encryptic.org/",
+        "demo": "https://app.encryptic.org/",
+        "admindoc": "https://github.com/encryptic-team/encryptic/wiki",
+        "code": "https://github.com/encryptic-team/encryptic"
+    },
     "license": "MPL-2.0",
     "maintainer": {
         "name": "eric_G",
         "email": ""
     },
     "requirements": {
-        "yunohost": ">> 4.1.7"
+        "yunohost": ">> 4.2.4"
     },
     "multi_instance": true,
     "services": [
@@ -24,8 +31,7 @@
         "install" : [
             {
             "name": "domain",
-            "type": "domain",
+            "type": "domain"
-            "example": "example.com"
             },
             {
             "name": "path",

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/install

@@ -43,6 +43,14 @@ ynh_script_progression --message="Storing installation settings..." --weight=1
 ynh_app_setting_set --app=$app --key=domain --value=$domain
 ynh_app_setting_set --app=$app --key=path --value=$path_url
 
+#=================================================
+# 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
 #=================================================
@@ -52,6 +60,10 @@ 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
 #=================================================
@@ -60,21 +72,6 @@ ynh_script_progression --message="Configuring NGINX web server..." --weight=2
 # Create a dedicated NGINX config
 ynh_add_nginx_config
 
-#=================================================
-# CREATE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Configuring system user..." --weight=1
-
-# Create a system user
-ynh_system_user_create --username=$app
-
-#=================================================
-# SECURE FILES AND DIRECTORIES
-#=================================================
-
-# Set permissions to app files
-chown -R $app: $final_path
-
 #=================================================
 # SETUP SSOWAT
 #=================================================

scripts/restore

@@ -30,8 +30,6 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 #=================================================
 ynh_script_progression --message="Validating restoration parameters..." --weight=1
 
-ynh_webpath_available --domain=$domain --path_url=$path_url \
-	|| ynh_die --message="Path not available: ${domain}${path_url}"
 test ! -d $final_path \
 	|| ynh_die --message="There is already a directory: $final_path "
 
@@ -43,6 +41,14 @@ test ! -d $final_path \
 
 ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 
+#=================================================
+# RECREATE THE DEDICATED USER
+#=================================================
+ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
+
+# Create the dedicated user (if not existing)
+ynh_system_user_create --username=$app --home_dir="$final_path"
+
 #=================================================
 # RESTORE THE APP MAIN DIR
 #=================================================
@@ -50,20 +56,9 @@ ynh_script_progression --message="Restoring Encryptic main directory..." --weigh
 
 ynh_restore_file --origin_path="$final_path"
 
-#=================================================
+chmod 750 "$final_path"
-# RECREATE THE DEDICATED USER
+chmod -R o-rwx "$final_path"
-#=================================================
+chown -R $app:www-data "$final_path"
-ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
-
-# Create the dedicated user (if not existing)
-ynh_system_user_create --username=$app
-
-#=================================================
-# RESTORE USER RIGHTS
-#=================================================
-
-# Restore permissions on app files
-chown -R $app: $final_path
 
 #=================================================
 # GENERIC FINALIZATION

scripts/upgrade

@@ -25,6 +25,20 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 
 upgrade_type=$(ynh_check_app_version_changed)
 
+#=================================================
+# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
+#=================================================
+ynh_script_progression --message="Backing up Encryptic before upgrading..." --weight=3
+
+# Backup the current version of the app
+ynh_backup_before_upgrade
+ynh_clean_setup () {
+	# restore it if the upgrade fails
+	ynh_restore_upgradebackup
+}
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
+
 #=================================================
 # ENSURE DOWNWARD COMPATIBILITY
 #=================================================
@@ -44,18 +58,12 @@ if ynh_legacy_permissions_exists; then
 fi
 
 #=================================================
-# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
+# CREATE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Backing up Encryptic before upgrading..." --weight=3
+ynh_script_progression --message="Configuring system user..." --weight=1
 
-# Backup the current version of the app
+# Create a system user
-ynh_backup_before_upgrade
+ynh_system_user_create --username=$app --home_dir="$final_path"
-ynh_clean_setup () {
-	# restore it if the upgrade fails
-	ynh_restore_upgradebackup
-}
-# Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
 
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
@@ -69,6 +77,10 @@ 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"
+
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
@@ -77,21 +89,6 @@ ynh_script_progression --message="Upgrading NGINX web server configuration..." -
 # Create a dedicated NGINX config
 ynh_add_nginx_config
 
-#=================================================
-# CREATE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Configuring system user..." --weight=1
-
-# Create a system user
-ynh_system_user_create --username=$app
-
-#=================================================
-# SECURE FILES AND DIRECTORIES
-#=================================================
-
-# Set permissions on app files
-chown -R $app: $final_path
-
 #=================================================
 # RELOAD NGINX
 #=================================================