Testing (#9)

Add templates

.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.
+-->
+
 # PrivateBin for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/privatebin.svg)](https://dash.yunohost.org/appci/app/privatebin) ![](https://ci-apps.yunohost.org/ci/badges/privatebin.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/privatebin.maintain.svg)  
@@ -5,65 +10,45 @@
 
 *[Lire ce readme en français.](./README_fr.md)*
 
-> *This package allow you to install PrivateBin quickly and simply on a YunoHost server.  
+> *This package allows you to install PrivateBin 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
 
-PrivateBin is a minimalist, open source online pastebin where the server has zero knowledge of pasted data.
+Minimalist pastebin where the server has zero knowledge of pasted data
+
+**Shipped version:** 1.3.5~ynh1
+
+**Demo:** https://privatebin.net/
+
+## Screenshots
+
+![](./doc/screenshots/bootstrap.png)
+
+## Disclaimers / important information
+
+## Additional information
 
 Data is encrypted/decrypted in the browser using 256bit AES in Galois Counter mode.
 
 This is a fork of ZeroBin, originally developed by Sébastien Sauvage. It was refactored to allow easier and cleaner extensions and has now much more features than the original. It is however still fully compatible to the original ZeroBin 0.19 data storage scheme. Therefore such installations can be upgraded to this fork without loosing any data.
 
-**Shipped version:** 1.3.5
-
-## Screenshots
-
-![](https://privatebin.info/img/1.0/bootstrap.png)
-
-## Demo
-
-* [Official demo](https://privatebin.net/)
-
-## Configuration
-
-## Documentation
-
- * Official documentation: https://github.com/PrivateBin/PrivateBin/wiki
- * YunoHost documentation: https://yunohost.org/#/app_privatebin
-
-## YunoHost specific features
-
-#### Multi-users support
-
-#### Supported architectures
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/privatebin.svg)](https://ci-apps.yunohost.org/ci/apps/privatebin/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/privatebin.svg)](https://ci-apps-arm.yunohost.org/ci/apps/privatebin/)
-
-## Limitations
-
-## Additional information
-
 In the [update documentation](https://github.com/PrivateBin/PrivateBin/wiki/Configuration#zerobincompatibility) of ParsteBin, it is specified that:
 
 For full compatibility with ZeroBin and to be able to decrypt old pastes, you would enable this option. However this is not recommend for new installations as it weakens the security of your PrivateBin instance.
 
 This means that we have decided to delete the directory that allows us to save the data. You can save the 'data' directory, if you want to keep your data. But you should know that this weakens the security of this application.
+## Documentation and resources
 
-## Links
+* Official app website: https://privatebin.info/
+* Official admin documentation: https://github.com/PrivateBin/PrivateBin/wiki
+* Upstream app code repository: https://github.com/PrivateBin/PrivateBin
+* YunoHost documentation for this app: https://yunohost.org/app_privatebin
+* Report a bug: https://github.com/YunoHost-Apps/privatebin_ynh/issues
 
- * Report a bug: https://github.com/YunoHost-Apps/privatebin_ynh/issues
+## Developer info
- * PrivateBin website: https://privatebin.info/
- * PrivateBin repository: https://github.com/PrivateBin/PrivateBin
- * YunoHost website: https://yunohost.org/
 
----
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/privatebin_ynh/tree/testing).
-
-## Developers info
-
-Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/privatebin_ynh/tree/testing).
 
 To try the testing branch, please proceed like that.
 ```
@@ -71,3 +56,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/privatebin_ynh/tree/t
 or
 sudo yunohost app upgrade privatebin -u https://github.com/YunoHost-Apps/privatebin_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps

README_fr.md

@@ -3,67 +3,48 @@
 [![Niveau d'intégration](https://dash.yunohost.org/integration/privatebin.svg)](https://dash.yunohost.org/appci/app/privatebin) ![](https://ci-apps.yunohost.org/ci/badges/privatebin.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/privatebin.maintain.svg)  
 [![Installer PrivateBin avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=privatebin)
 
-*[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 PrivateBin rapidement et simplement sur un serveur YunoHost.  
+> *Ce package vous permet d'installer PrivateBin 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
 
-PrivateBin est un logiciel libre, minimaliste, qui joue le rôle de pastebin (coller-corbeille) où le serveur n'a aucune connaissance des données qu'il stocke.
+Pastebin minimaliste où le serveur n'a aucune connaissance des données copiées
+
+**Version incluse :** 1.3.5~ynh1
+
+**Démo :** https://privatebin.net/
+
+## Captures d'écran
+
+![](./doc/screenshots/bootstrap.png)
+
+## Avertissements / informations importantes
+
+## Informations additionnelles
 
 Les données sont chiffrées et déchiffrées dans le navigateur en utilisant la technologie AES 256bits en mode Galois Counter (GCM).
 
 Ce projet est un fork de ZeroBin, développé à l'origine par Sébastien Sauvage. Il a été ré-écrit pour accepter plus facilement des extensions en rajoutant plus de fonctionnalités. Il reste cependant compatible avec le schéma original de stockage des données Zerobin 0.19. Ainsi toutes les installations peuvent être mises à jour vers ce projet, sans perte de données.
 
-**Version incluse :** 1.3.5
-
-## Captures d'écran
-
-![](https://privatebin.info/img/1.0/bootstrap.png)
-
-## Démo
-
-* [Démo Privatebin](https://privatebin.net/)
-
-## Configuration
-
-## Documentation
-
- * Documentation officielle : https://github.com/PrivateBin/PrivateBin/wiki
- * Documentation YunoHost : https://yunohost.org/#/app_privatebin_fr
-
-## Caractéristiques spécifiques YunoHost
-
-#### Support multi-utilisateurs
-
-#### Architectures supportées
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/privatebin.svg)](https://ci-apps.yunohost.org/ci/apps/privatebin/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/privatebin.svg)](https://ci-apps-arm.yunohost.org/ci/apps/privatebin/)
-
-## Limitations
-
-## Informations additionnelles
-
 Dans la [documentation de mise à jour](https://github.com/PrivateBin/PrivateBin/wiki/Configuration#zerobincompatibility) de PrivateBin, il est précisé que :
 
 Pour une compatibilité complète avec Zerobin et le déchiffrement de tous les vieux "paste", vous devriez activer cette option. Cependant, ce n'est pas recommandé pour les nouvelles installations car cela affaiblit la sécurité de votre instance PrivateBin.
 
 Ceci signifie que nous avons décidé de supprimer ce répertoire pour permettre la sécurisation des données. Vous pouvez sauvegarder le répertoire 'data', si vous voulez conservez vos données. Mais vous devriez savoir que cela réduit la sécurité de votre application.
+## Documentations et ressources
 
-## Liens
+* Site officiel de l'app : https://privatebin.info/
-
+* Documentation officielle de l'admin : https://github.com/PrivateBin/PrivateBin/wiki
- * Signaler un bug : https://github.com/YunoHost-Apps/privatebin_ynh/issues
+* Dépôt de code officiel de l'app : https://github.com/PrivateBin/PrivateBin
- * Site de l'application PrivateBin : https://privatebin.info/
+* Documentation YunoHost pour cette app : https://yunohost.org/app_privatebin
- * Dépot de l'application principale : https://github.com/PrivateBin/PrivateBin
+* Signaler un bug : https://github.com/YunoHost-Apps/privatebin_ynh/issues
- * Site web YunoHost : https://yunohost.org/
-
----
 
 ## Informations pour les développeurs
 
-Merci de faire vos pull request dans la [branche testing](https://github.com/YunoHost-Apps/privatebin_ynh/tree/testing).
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/privatebin_ynh/tree/testing).
 
 Pour essayer la branche testing, procédez comme suit.
 ```
@@ -71,3 +52,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/privatebin_ynh/tree/t
 ou
 sudo yunohost app upgrade privatebin -u https://github.com/YunoHost-Apps/privatebin_ynh/tree/testing --debug
 ```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps

check_process

@@ -1,8 +1,8 @@
 ;; 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
@@ -14,8 +14,6 @@
 		upgrade=1	from_commit=8ce6cac57048e5df294269989c2432d67bef4c5c
 		backup_restore=1
 		multi_instance=1
-		incorrect_path=1
-		port_already_use=0
 		change_url=1
 ;;; Options
 Email=

doc/DISCLAIMER.md

@@ -0,0 +1,11 @@
+## Additional information
+
+Data is encrypted/decrypted in the browser using 256bit AES in Galois Counter mode.
+
+This is a fork of ZeroBin, originally developed by Sébastien Sauvage. It was refactored to allow easier and cleaner extensions and has now much more features than the original. It is however still fully compatible to the original ZeroBin 0.19 data storage scheme. Therefore such installations can be upgraded to this fork without loosing any data.
+
+In the [update documentation](https://github.com/PrivateBin/PrivateBin/wiki/Configuration#zerobincompatibility) of ParsteBin, it is specified that:
+
+For full compatibility with ZeroBin and to be able to decrypt old pastes, you would enable this option. However this is not recommend for new installations as it weakens the security of your PrivateBin instance.
+
+This means that we have decided to delete the directory that allows us to save the data. You can save the 'data' directory, if you want to keep your data. But you should know that this weakens the security of this application.

doc/DISCLAIMER_fr.md

@@ -0,0 +1,11 @@
+## Informations additionnelles
+
+Les données sont chiffrées et déchiffrées dans le navigateur en utilisant la technologie AES 256bits en mode Galois Counter (GCM).
+
+Ce projet est un fork de ZeroBin, développé à l'origine par Sébastien Sauvage. Il a été ré-écrit pour accepter plus facilement des extensions en rajoutant plus de fonctionnalités. Il reste cependant compatible avec le schéma original de stockage des données Zerobin 0.19. Ainsi toutes les installations peuvent être mises à jour vers ce projet, sans perte de données.
+
+Dans la [documentation de mise à jour](https://github.com/PrivateBin/PrivateBin/wiki/Configuration#zerobincompatibility) de PrivateBin, il est précisé que :
+
+Pour une compatibilité complète avec Zerobin et le déchiffrement de tous les vieux "paste", vous devriez activer cette option. Cependant, ce n'est pas recommandé pour les nouvelles installations car cela affaiblit la sécurité de votre instance PrivateBin.
+
+Ceci signifie que nous avons décidé de supprimer ce répertoire pour permettre la sécurisation des données. Vous pouvez sauvegarder le répertoire 'data', si vous voulez conservez vos données. Mais vous devriez savoir que cela réduit la sécurité de votre application.

manifest.json

@@ -8,13 +8,20 @@
     },
     "version": "1.3.5~ynh1",
     "url": "https://github.com/PrivateBin/PrivateBin",
+    "upstream": {
+        "license": "Zlib",
+        "website": "https://privatebin.info/",
+        "demo": "https://privatebin.net/",
+        "admindoc": "https://github.com/PrivateBin/PrivateBin/wiki",
+        "code": "https://github.com/PrivateBin/PrivateBin"
+    },
     "license": "Zlib",
     "maintainer": {
         "name": "julien",
         "email": "julien.malik@paraiso.me"
     },
     "requirements": {
-        "yunohost": ">= 4.1.7"
+        "yunohost": ">= 4.2.4"
     },
     "multi_instance": true,
     "services": [
@@ -25,8 +32,7 @@
         "install" : [
             {
                 "name": "domain",
-                "type": "domain",
+                "type": "domain"
-                "example": "domain.org"
             },
             {
                 "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/restore

@@ -33,8 +33,6 @@ phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 #=================================================
 ynh_script_progression --message="Validating restoration parameters..." --weight=2
 
-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 "