Merge pull request #200 from ericgaspar/add-dummies

Add dummies

config_panel.toml.example

@@ -246,14 +246,14 @@ services = ["__APP__"]
         type = "file"
         accept = ".png"
         help = "Fill with an already resized logo"
-        bind = "__FINALPATH__/img/logo.png"
+        bind = "__INSTALL_DIR__/img/logo.png"
         
         [main.customization.favicon]
         ask = "Favicon"
         type = "file"
         accept = ".png"
         help = "Fill with an already sized favicon"
-        bind = "__FINALPATH__/img/favicon.png"
+        bind = "__INSTALL_DIR__/img/favicon.png"
 
         
     [main.stripe]

doc/ADMIN.md

@@ -0,0 +1,3 @@
+This is a dummy admin doc for this app
+
+The app install dir is `__INSTALL_DIR__`

doc/ADMIN_fr.md

@@ -0,0 +1,3 @@
+Ceci est une fausse doc d'admin pour cette app
+
+Le dossier d'install de l'app est `__INSTALL_DIR__`

doc/DESCRIPTION.md

@@ -1,9 +1 @@
-Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+This is a dummy description of this app features
-
-### Features
-
-- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
-- Laboris nisi ut aliquip ex ea commodo consequat ;
-- Duis aute irure dolor in reprehenderit in voluptate ;
-- Velit esse cillum dolore eu fugiat nulla pariatur ;
-- Excepteur sint occaecat cupidatat non proident, sunt in culpa."

doc/DESCRIPTION_fr.md

@@ -0,0 +1 @@
+Ceci est une fausse description des fonctionalités de l'app

doc/DISCLAIMER.md

@@ -1,12 +0,0 @@
-* Any known limitations, constrains or stuff not working, such as (but not limited to):
-    * requiring a full dedicated domain ?
-    * architectures not supported ?
-    * not-working single-sign on or LDAP integration ?
-    * the app requires an important amount of RAM / disk / .. to install or to work properly
-    * etc...
-
-* Other infos that people should be aware of, such as:
-    * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
-    * how to configure / administrate the application if it ain't obvious
-    * upgrade process / specificities / things to be aware of ?
-    * security considerations ?

doc/POST_INSTALL.md

@@ -0,0 +1,7 @@
+This is a dummy disclaimer to display after the install
+
+The app url is `__DOMAIN____PATH__`
+
+The app install dir is `__INSTALL_DIR__`
+
+The app id is `__ID__`

doc/POST_UPGRADE.md

@@ -0,0 +1 @@
+This is a dummy disclaimer to display after upgrades

doc/PRE_INSTALL.md

@@ -0,0 +1 @@
+This is a dummy disclaimer to display prior to the install

doc/PRE_INSTALL_fr.md

@@ -0,0 +1 @@
+Ceci est un faux disclaimer à présenter avant l'installation

doc/PRE_UPGRADE.md

@@ -0,0 +1 @@
+This is a dummy disclaimer to display prior to any upgrade

manifest.toml

@@ -23,7 +23,7 @@ cpe = "???"
 fund = "???"
 
 [integration]
-yunohost = ">= 11.0.0"
+yunohost = ">= 11.1.6"
 # FIXME: can be replaced by a list of supported archs using the dpkg --print-architecture nomenclature (amd64/i386/armhf/arm64), for example: ["amd64", "i386"]
 architectures = "all"
 multi_instance = true
@@ -31,7 +31,7 @@ multi_instance = true
 ldap = "?" 
 # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "ldap" key : the "sso" key corresponds to wether or not a user is *automatically logged-in* on the app when logged-in on the YunoHost portal.
 sso = "?"
-# FIXME: replace with an **estimate** minimum disk and RAM requirements. e.g. 20M, 400M, 1G, ...
+# FIXME: replace with an **estimate** minimum disk and RAM requirements. e.g. 20M, 400M, 1G...
 disk = "50M"
 ram.build = "50M"
 ram.runtime = "50M"

scripts/config

@@ -22,7 +22,7 @@ ynh_abort_if_errors
 # RETRIEVE ARGUMENTS
 #=================================================
 
-final_path=$(ynh_app_setting_get $app final_path)
+install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
 
 #=================================================
 # SPECIFIC GETTERS FOR TOML SHORT KEY
@@ -52,7 +52,7 @@ EOF
 }
 
 get__prices() {
-    local prices = "$(grep "DONATION\['" "$final_path/settings.py" | sed -r "s@^DONATION\['([^']*)'\]\['([^']*)'\] = '([^']*)'@\1/\2/\3@g" | sed -z 's/\n/,/g;s/,$/\n/')"
+    local prices = "$(grep "DONATION\['" "$install_dir/settings.py" | sed -r "s@^DONATION\['([^']*)'\]\['([^']*)'\] = '([^']*)'@\1/\2/\3@g" | sed -z 's/\n/,/g;s/,$/\n/')"
     if [ "$prices" == "," ];
     then
         # Return YNH_NULL if you prefer to not return a value at all.
@@ -85,9 +85,9 @@ set__prices() {
         frequency=$(echo $price | cut -d/ -f1)
         currency=$(echo $price | cut -d/ -f2)
         price_id=$(echo $price | cut -d/ -f3)
-        sed "d/DONATION\['$frequency'\]\['$currency'\]" "$final_path/settings.py"
+        sed "d/DONATION\['$frequency'\]\['$currency'\]" "$install_dir/settings.py"
 
-        echo "DONATION['$frequency']['$currency'] = '$price_id'" >> "$final_path/settings.py"
+        echo "DONATION['$frequency']['$currency'] = '$price_id'" >> "$install_dir/settings.py"
     done
     
     #---------------------------------------------

scripts/install

@@ -49,7 +49,6 @@ ynh_setup_source --dest_dir="$install_dir"
 # ownership to all files such as after the ynh_setup_source step
 chown -R $app:www-data "$install_dir"
 
-
 #=================================================
 # SYSTEM CONFIGURATION
 #=================================================

scripts/upgrade

@@ -35,7 +35,7 @@ upgrade_type=$(ynh_check_app_version_changed)
 #=================================================
 # ENSURE DOWNWARD COMPATIBILITY
 #=================================================
-#ynh_script_progression --message="Ensuring downward compatibility..." --time --weight=1
+#ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
 
 #
 # N.B. : the followings setting migrations snippets are provided as *EXAMPLES*
@@ -81,7 +81,6 @@ fi
 # ownership to all files such as after the ynh_setup_source step
 chown -R $app:www-data "$install_dir"
 
-
 #=================================================
 # REAPPLY SYSTEM CONFIGURATIONS
 #=================================================
@@ -101,7 +100,6 @@ ynh_use_logrotate --non-append
 
 ynh_add_fail2ban_config --logpath="/var/log/nginx/${domain}-error.log" --failregex="Regex to match into the log for a failed login"
 
-
 #=================================================
 # RECONFIGURE THE APP (UPDATE CONF, APPLY MIGRATIONS, ...)
 #=================================================