From 70ed6bd954ab5962d447d8874cf2bc74c6a80b37 Mon Sep 17 00:00:00 2001 From: Alexandre Aubin Date: Sat, 21 Jan 2023 23:22:59 +0100 Subject: [PATCH 1/5] Add upstream section to the manifest + doc folder to be able to autogenerate README --- doc/DESCRIPTION.md | 14 ++++++++++++++ doc/DESCRIPTION_fr.md | 8 ++++++++ doc/DISCLAIMER.md | 5 +++++ doc/DISCLAIMER_fr.md | 5 +++++ manifest.json | 4 ++++ 5 files changed, 36 insertions(+) create mode 100644 doc/DESCRIPTION.md create mode 100644 doc/DESCRIPTION_fr.md create mode 100644 doc/DISCLAIMER.md create mode 100644 doc/DISCLAIMER_fr.md diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 0000000..b328f9c --- /dev/null +++ b/doc/DESCRIPTION.md @@ -0,0 +1,14 @@ +This application allows you to easily install a custom Web application, +providing files access with [SFTP](https://yunohost.org/en/filezilla). + +It can also create a MySQL database - which will be backed up and restored with +your application. The connection details will be stored in the file +`db_access.txt` located in the root directory. + +PHP-FPM version can also be selected among 7.3, 7.4, and 8.0. + +**Once installed, go to the chosen URL to know the user, domain and port +you will have to use for the SFTP access.** The password is one you chosen +during the installation. Under the Web directory, you will see a `www` folder +which contains the public files served by this app. You can put all the files +of your custom Web application inside. diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md new file mode 100644 index 0000000..ce12745 --- /dev/null +++ b/doc/DESCRIPTION_fr.md @@ -0,0 +1,8 @@ +Cette application vous permet d'installer facilement une application vide personnalisée, +fourni un accès aux fichiers avec [SFTP](https://yunohost.org/fr/filezilla). + +Elle peut également créer une base de données MySQL - qui sera sauvegardée et +restaurée avec votre application. Les détails de connexion seront stockés dans +le fichier `db_accesss.txt` situé dans le répertoire racine. + +La version de PHP-FPM peut aussi être choisie, parmi 7.3, 7.4, et 8.0. diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..8d2bd65 --- /dev/null +++ b/doc/DISCLAIMER.md @@ -0,0 +1,5 @@ +#### SFTP port + +You may have change the SSH port as described in this section: +[Modify the SSH port](https://yunohost.org/en/security#modify-the-ssh-port); +then you should use this port to update your website with SFTP. diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md new file mode 100644 index 0000000..b36bd1b --- /dev/null +++ b/doc/DISCLAIMER_fr.md @@ -0,0 +1,5 @@ +#### Port SFTP + +Vous avez peut-être changé le port SSH comme décrit dans cette section : +[Modifier le port SSH](https://yunohost.org/fr/security#modify-the-ssh-port) ; +alors vous devriez utiliser ce port pour mettre à jour votre site Web avec SFTP. diff --git a/manifest.json b/manifest.json index 69f6b2e..b72acea 100644 --- a/manifest.json +++ b/manifest.json @@ -9,6 +9,10 @@ "version": "1.0~ynh12", "url": "https://github.com/YunoHost-Apps/my_webapp_ynh", "license": "GPL-3.0-only", + "upstream": { + "license": "GPL-3.0-only", + "code": "https://github.com/YunoHost-Apps/my_webapp_ynh" + }, "maintainer": { "name": "", "email": "" From f997d537a04be2091518ee79934c12473728ebab Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sat, 21 Jan 2023 22:30:31 +0000 Subject: [PATCH 2/5] Auto-update README --- README.md | 47 +++++++++++++++++++++++++++-------------------- README_fr.md | 48 ++++++++++++++++++++++++++++-------------------- 2 files changed, 55 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 386d834..86ab935 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,26 @@ -# Custom Webapp for YunoHost + -[![Integration level](https://dash.yunohost.org/integration/my_webapp.svg)](https://dash.yunohost.org/appci/app/my_webapp) ![](https://ci-apps.yunohost.org/ci/badges/my_webapp.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/my_webapp.maintain.svg) -[![Install Custom Webapp with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=my_webapp) +# My Webapp for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/my_webapp.svg)](https://dash.yunohost.org/appci/app/my_webapp) ![Working status](https://ci-apps.yunohost.org/ci/badges/my_webapp.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/my_webapp.maintain.svg) +[![Install My Webapp with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=my_webapp) *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install Custom Webapp 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.* +> *This package allows you to install My Webapp 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 This application allows you to easily install a custom Web application, -providing files access with [SFTP](https://yunohost.org/en/filezilla). It can also create a MySQL database - -which will be backed up and restored with your application. The connection -details will be stored in the file `db_accesss.txt` located in the root -directory. +providing files access with [SFTP](https://yunohost.org/en/filezilla). + +It can also create a MySQL database - which will be backed up and restored with +your application. The connection details will be stored in the file +`db_access.txt` located in the root directory. PHP-FPM version can also be selected among 7.3, 7.4, and 8.0. @@ -24,9 +30,9 @@ during the installation. Under the Web directory, you will see a `www` folder which contains the public files served by this app. You can put all the files of your custom Web application inside. -**Shipped version:** 1.0 -## Additional information +**Shipped version:** 1.0~ynh12 +## Disclaimers / important information #### SFTP port @@ -34,21 +40,22 @@ You may have change the SSH port as described in this section: [Modify the SSH port](https://yunohost.org/en/security#modify-the-ssh-port); then you should use this port to update your website with SFTP. -## Links +## Documentation and resources - * YunoHost documentation for this app: https://yunohost.org/en/app_my_webapp - * Report a bug: https://github.com/YunoHost-Apps/my_webapp_ynh/issues - * YunoHost website: https://yunohost.org/ +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ---- +## Developer info -## Developers info - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/my_webapp_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/my_webapp_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/my_webapp_ynh/tree/testing --debug or sudo yunohost app upgrade my_webapp -u https://github.com/YunoHost-Apps/my_webapp_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 07cd068..476fa37 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,25 +1,32 @@ -# Application vide avec accès SFTP au répertoire Web personnalisé pour YunoHost + -[![Niveau d'intégration](https://dash.yunohost.org/integration/my_webapp.svg)](https://dash.yunohost.org/appci/app/my_webapp) ![](https://ci-apps.yunohost.org/ci/badges/my_webapp.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/my_webapp.maintain.svg) -[![Installer Custom Webapp avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=my_webapp) +# My Webapp pour YunoHost -*[Read this readme in english.](./README.md)* +[![Niveau d’intégration](https://dash.yunohost.org/integration/my_webapp.svg)](https://dash.yunohost.org/appci/app/my_webapp) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/my_webapp.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/my_webapp.maintain.svg) +[![Installer My Webapp avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=my_webapp) -> *Ce package vous permet d'installer une Application vide avec accès SFTP au répertoire Web personnalisé 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.* +*[Read this readme in english.](./README.md)* -## Vue d'ensemble +> *Ce package vous permet d’installer My Webapp 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 Cette application vous permet d'installer facilement une application vide personnalisée, -fourni un accès aux fichiers avec [SFTP](https://yunohost.org/fr/filezilla). Elle peut également créer une base de données MySQL - -qui sera sauvegardée et restaurée avec votre application. Les détails de connexion -seront stockés dans le fichier `db_accesss.txt` situé dans le répertoire racine. +fourni un accès aux fichiers avec [SFTP](https://yunohost.org/fr/filezilla). + +Elle peut également créer une base de données MySQL - qui sera sauvegardée et +restaurée avec votre application. Les détails de connexion seront stockés dans +le fichier `db_accesss.txt` situé dans le répertoire racine. La version de PHP-FPM peut aussi être choisie, parmi 7.3, 7.4, et 8.0. -**Version incluse :** 1.0 -## Informations additionnelles +**Version incluse :** 1.0~ynh12 +## Avertissements / informations importantes #### Port SFTP @@ -27,21 +34,22 @@ Vous avez peut-être changé le port SSH comme décrit dans cette section : [Modifier le port SSH](https://yunohost.org/fr/security#modify-the-ssh-port) ; alors vous devriez utiliser ce port pour mettre à jour votre site Web avec SFTP. -## Liens +## Documentations et ressources - * Documentation YunoHost pour cette app : https://yunohost.org/fr/app_my_webapp - * Signaler un bug : https://github.com/YunoHost-Apps/my_webapp_ynh/issues - * Site web YunoHost : https://yunohost.org/ - ---- +* Dépôt de code officiel de l’app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs -Merci de faire vos pull request dans la [branche testing](https://github.com/YunoHost-Apps/my_webapp_ynh/tree/testing). +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/my_webapp_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/my_webapp_ynh/tree/testing --debug ou sudo yunohost app upgrade my_webapp -u https://github.com/YunoHost-Apps/my_webapp_ynh/tree/testing --debug ``` + +**Plus d’infos sur le packaging d’applications :** \ No newline at end of file From 6b84c9daecfee2ce6ff60854101a13a44c73d22d Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Wed, 25 Jan 2023 11:59:20 +0000 Subject: [PATCH 3/5] Auto-update README --- README.md | 15 ++++----------- README_fr.md | 13 ++++--------- 2 files changed, 8 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 86ab935..068332d 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It shall NOT be edited by hand. # My Webapp for YunoHost -[![Integration level](https://dash.yunohost.org/integration/my_webapp.svg)](https://dash.yunohost.org/appci/app/my_webapp) ![Working status](https://ci-apps.yunohost.org/ci/badges/my_webapp.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/my_webapp.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/my_webapp.svg)](https://dash.yunohost.org/appci/app/my_webapp) ![Working status](https://ci-apps.yunohost.org/ci/badges/my_webapp.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/my_webapp.maintain.svg) [![Install My Webapp with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=my_webapp) *[Lire ce readme en français.](./README_fr.md)* @@ -15,20 +15,13 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -This application allows you to easily install a custom Web application, -providing files access with [SFTP](https://yunohost.org/en/filezilla). +This application allows you to easily install a custom Web application, providing files access with [SFTP](https://yunohost.org/en/filezilla). -It can also create a MySQL database - which will be backed up and restored with -your application. The connection details will be stored in the file -`db_access.txt` located in the root directory. +It can also create a MySQL database - which will be backed up and restored with your application. The connection details will be stored in the file `db_access.txt` located in the root directory. PHP-FPM version can also be selected among 7.3, 7.4, and 8.0. -**Once installed, go to the chosen URL to know the user, domain and port -you will have to use for the SFTP access.** The password is one you chosen -during the installation. Under the Web directory, you will see a `www` folder -which contains the public files served by this app. You can put all the files -of your custom Web application inside. +**Once installed, go to the chosen URL to know the user, domain and port you will have to use for the SFTP access.** The password is one you chosen during the installation. Under the Web directory, you will see a `www` folder which contains the public files served by this app. You can put all the files of your custom Web application inside. **Shipped version:** 1.0~ynh12 diff --git a/README_fr.md b/README_fr.md index 476fa37..63a2878 100644 --- a/README_fr.md +++ b/README_fr.md @@ -5,7 +5,7 @@ It shall NOT be edited by hand. # My Webapp pour YunoHost -[![Niveau d’intégration](https://dash.yunohost.org/integration/my_webapp.svg)](https://dash.yunohost.org/appci/app/my_webapp) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/my_webapp.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/my_webapp.maintain.svg) +[![Niveau d’intégration](https://dash.yunohost.org/integration/my_webapp.svg)](https://dash.yunohost.org/appci/app/my_webapp) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/my_webapp.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/my_webapp.maintain.svg) [![Installer My Webapp avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=my_webapp) *[Read this readme in english.](./README.md)* @@ -15,12 +15,9 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po ## Vue d’ensemble -Cette application vous permet d'installer facilement une application vide personnalisée, -fourni un accès aux fichiers avec [SFTP](https://yunohost.org/fr/filezilla). +Cette application vous permet d'installer facilement une application vide personnalisée, fourni un accès aux fichiers avec [SFTP](https://yunohost.org/fr/filezilla). -Elle peut également créer une base de données MySQL - qui sera sauvegardée et -restaurée avec votre application. Les détails de connexion seront stockés dans -le fichier `db_accesss.txt` situé dans le répertoire racine. +Elle peut également créer une base de données MySQL - qui sera sauvegardée et restaurée avec votre application. Les détails de connexion seront stockés dans le fichier `db_accesss.txt` situé dans le répertoire racine. La version de PHP-FPM peut aussi être choisie, parmi 7.3, 7.4, et 8.0. @@ -30,9 +27,7 @@ La version de PHP-FPM peut aussi être choisie, parmi 7.3, 7.4, et 8.0. #### Port SFTP -Vous avez peut-être changé le port SSH comme décrit dans cette section : -[Modifier le port SSH](https://yunohost.org/fr/security#modify-the-ssh-port) ; -alors vous devriez utiliser ce port pour mettre à jour votre site Web avec SFTP. +Vous avez peut-être changé le port SSH comme décrit dans cette section : [Modifier le port SSH](https://yunohost.org/fr/security#modify-the-ssh-port) ; alors vous devriez utiliser ce port pour mettre à jour votre site Web avec SFTP. ## Documentations et ressources From 2b36952f22e6aeecd0a416b74d376f639d871518 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Wed, 25 Jan 2023 13:00:59 +0100 Subject: [PATCH 4/5] Add translation --- doc/DESCRIPTION_fr.md | 2 ++ doc/DISCLAIMER.md | 4 +--- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md index 21f4760..c439f61 100644 --- a/doc/DESCRIPTION_fr.md +++ b/doc/DESCRIPTION_fr.md @@ -3,3 +3,5 @@ Cette application vous permet d'installer facilement une application vide person Elle peut également créer une base de données MySQL - qui sera sauvegardée et restaurée avec votre application. Les détails de connexion seront stockés dans le fichier `db_accesss.txt` situé dans le répertoire racine. La version de PHP-FPM peut aussi être choisie, parmi 7.3, 7.4, et 8.0. + +**Une fois installé, rendez-vous sur l'URL choisie pour connaître l'utilisateur, le domaine et le port que vous devrez utiliser pour l'accès SFTP.** Le mot de passe est celui que vous avez choisi lors de l'installation. Sous le répertoire Web, vous verrez un dossier `www` qui contient les fichiers publics servis par cette application. Vous pouvez mettre tous les fichiers de votre application Web personnalisée à l'intérieur. diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index 8d2bd65..1f6de18 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -1,5 +1,3 @@ #### SFTP port -You may have change the SSH port as described in this section: -[Modify the SSH port](https://yunohost.org/en/security#modify-the-ssh-port); -then you should use this port to update your website with SFTP. +You may have change the SSH port as described in this section: [Modify the SSH port](https://yunohost.org/en/security#modify-the-ssh-port); then you should use this port to update your website with SFTP. From b46bfc3c562b0a7d595784a1141688a1f230af0b Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Wed, 25 Jan 2023 12:01:09 +0000 Subject: [PATCH 5/5] Auto-update README --- README.md | 4 +--- README_fr.md | 2 ++ 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 068332d..d7b670d 100644 --- a/README.md +++ b/README.md @@ -29,9 +29,7 @@ PHP-FPM version can also be selected among 7.3, 7.4, and 8.0. #### SFTP port -You may have change the SSH port as described in this section: -[Modify the SSH port](https://yunohost.org/en/security#modify-the-ssh-port); -then you should use this port to update your website with SFTP. +You may have change the SSH port as described in this section: [Modify the SSH port](https://yunohost.org/en/security#modify-the-ssh-port); then you should use this port to update your website with SFTP. ## Documentation and resources diff --git a/README_fr.md b/README_fr.md index 63a2878..6c53beb 100644 --- a/README_fr.md +++ b/README_fr.md @@ -21,6 +21,8 @@ Elle peut également créer une base de données MySQL - qui sera sauvegardée e La version de PHP-FPM peut aussi être choisie, parmi 7.3, 7.4, et 8.0. +**Une fois installé, rendez-vous sur l'URL choisie pour connaître l'utilisateur, le domaine et le port que vous devrez utiliser pour l'accès SFTP.** Le mot de passe est celui que vous avez choisi lors de l'installation. Sous le répertoire Web, vous verrez un dossier `www` qui contient les fichiers publics servis par cette application. Vous pouvez mettre tous les fichiers de votre application Web personnalisée à l'intérieur. + **Version incluse :** 1.0~ynh12 ## Avertissements / informations importantes