From 70ed6bd954ab5962d447d8874cf2bc74c6a80b37 Mon Sep 17 00:00:00 2001
From: Alexandre Aubin <alex.aubin@mailoo.org>
Date: Sat, 21 Jan 2023 23:22:59 +0100
Subject: [PATCH] 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": ""