Patch (#17)

* Cleaning up
2024-09-03 19:25:52 +02:00 · 2021-03-12 22:47:43 +01:00 · 2021-03-12 22:47:43 +01:00 · b15b9277f9
commit b15b9277f9
parent 7079fcc54d
12 changed files with 60 additions and 71 deletions
--- a/README.md
+++ b/README.md
@ -9,7 +9,7 @@
 If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*

 ## Overview
-HedgeDoc is a real-time collaborative word processing web service. It uses Markdown language.
+HedgeDoc ([formerly known as CodiMD](https://hedgedoc.org/history/)) is an open-source collaborative markdown editor. With HedgeDoc you can easily collaborate on notes, graphs and even presentations in real-time. All you need to do is to share your note-link to your co-workers, and they’re ready to go.

 **Shipped version:** 1.7.2

@ -29,7 +29,7 @@ When you finished editing the configuration, for your changes to take effect, yo
 ## Documentation

 * Official documentation: https://github.com/hedgedoc/hedgedoc/tree/master/docs
- * YunoHost documentation: https://yunohost.org/#/app_hedgedoc
+ * YunoHost documentation: https://yunohost.org/en/app_hedgedoc

 ## YunoHost specific features

--- a/README_fr.md
+++ b/README_fr.md
@ -11,6 +11,8 @@ Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install
 ## Vue d'ensemble
 HedgeDoc est un service web de traitement de texte collaboratif en temps réel. Il utilise le langage Markdown.

+HedgeDoc ([anciennement connu sous le nom de CodiMD](https://hedgedoc.org/history/)) est un éditeur Markdown collaboratif open-source. Avec HedgeDoc, vous pouvez facilement collaborer sur des notes, des graphiques et même des présentations en temps réel. Tout ce que vous avez à faire est de partager votre lien de note avec vos collègues. 
+
 **Version incluse :** 1.7.2

 ## Captures d'écran
@ -29,7 +31,7 @@ Lorsque vous avez terminé de modifier la configuration, pour que vos modificati
 ## Documentation

 * Documentation officielle : https://github.com/hedgedoc/hedgedoc/tree/master/docs
- * Documentation YunoHost : https://yunohost.org/#/app_hedgedoc_fr
+ * Documentation YunoHost : https://yunohost.org/fr/app_hedgedoc

 ## Caractéristiques spécifiques YunoHost

--- a/8
+++ b/8
@ -12,10 +12,16 @@
 		setup_private=1
 		setup_public=1
 		upgrade=1
+		upgrade=1	from_commit=2a6ed9db5f7f0644eab251b2495c190811735832
 		backup_restore=1
 		multi_instance=1
 		port_already_use=1
 		change_url=1
 ;;; Options
 Email=
-Notification=none
+Notification=none
+;;; Upgrade options
+	; commit=2a6ed9db5f7f0644eab251b2495c190811735832
+		name=Testing (#13)
+		manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=pass&port=666&
+
--- a/conf/.sequelizerc.example
+++ b/conf/.sequelizerc.example
@ -4,5 +4,5 @@ module.exports = {
    'config':          path.resolve('config.json'),
    'migrations-path': path.resolve('lib', 'migrations'),
    'models-path':     path.resolve('lib', 'models'),
-    'url':             'postgres://__DB_USER__:__DB_PASS__@localhost:5432/__DB_NAME__'
+    'url':             'postgres://__DB_NAME__:__DB_PWD__@localhost:5432/__DB_NAME__'
 }
--- a/conf/config.json.example
+++ b/conf/config.json.example
@ -30,8 +30,8 @@
            "addGoogleAnalytics": false
        },
        "db": {
-            "username": "__DB_USER__",
-            "password": "__DB_PASS__",
+            "username": "__DB_NAME__",
+            "password": "__DB_PWD__",
            "database": "__DB_NAME__",
            "host": "localhost",
            "port": "5432",
@ -49,6 +49,3 @@
        }
    }
 }
-
-
-
--- a/manifest.json
+++ b/manifest.json
@ -13,7 +13,7 @@
        "name": "eric_G"
    },
    "requirements": {
-        "yunohost": ">= 3.8.1"
+        "yunohost": ">= 4.1.7"
    },
    "multi_instance": true,
    "services": [
--- a/pull_request_template.md
+++ b/pull_request_template.md
@ -13,6 +13,4 @@

 ## Package_check results
 ---
-*If you have access to [App Continuous Integration for packagers](https://yunohost.org/#/packaging_apps_ci) you can provide a link to the package_check results like below, replacing '-NUM-' in this link by the PR number and USERNAME by your username on the ci-apps-dev. Or you provide a screenshot or a pastebin of the results*
-
-[![Build Status](https://ci-apps-dev.yunohost.org/jenkins/job/hedgedoc_ynh%20PR-NUM-%20(USERNAME)/badge/icon)](https://ci-apps-dev.yunohost.org/jenkins/job/hedgedoc_ynh%20PR-NUM-%20(USERNAME)/)  
+* 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!"*
--- a/scripts/change_url
+++ b/scripts/change_url
@ -31,7 +31,7 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 port=$(ynh_app_setting_get --app=$app --key=port)
 db_name=$(ynh_app_setting_get --app=$app --key=db_name)
 db_user=$db_name
-db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd)
+db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd)

 #=================================================
 # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
@ -73,7 +73,7 @@ fi
 #=================================================
 ynh_script_progression --message="Stopping a systemd service..." --weight=1

-ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log"
+ynh_systemd_action --service_name=$app --action=stop --log_path="/var/log/$app/$app.log"

 #=================================================
 # MODIFY URL IN NGINX CONF
@ -117,13 +117,12 @@ path_url=$new_path

 cp ../conf/config.json.example "$final_path/config.json"

-ynh_replace_string --match_string="__PORT__"    --replace_string="$port"     --target_file="$final_path/config.json"
-ynh_replace_string --match_string="__DOMAIN__"  --replace_string="$domain"   --target_file="$final_path/config.json"
-ynh_replace_string --match_string="__PATH__"    --replace_string="${path_url:1}" --target_file="$final_path/config.json"
-ynh_replace_string --match_string="__DB_USER__" --replace_string="$db_user"  --target_file="$final_path/config.json"
-ynh_replace_string --match_string="__DB_NAME__" --replace_string="$db_name"  --target_file="$final_path/config.json"
-ynh_replace_string --match_string="__DB_PASS__" --replace_string="$db_pwd"   --target_file="$final_path/config.json"
-ynh_replace_string --match_string="__APP__"     --replace_string="$app"      --target_file="$final_path/config.json"
+ynh_replace_string --match_string="__PORT__" --replace_string="$port" --target_file="$final_path/config.json"
+ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain" --target_file="$final_path/config.json"
+ynh_replace_string --match_string="__PATH__" --replace_string="${path_url:1}" --target_file="$final_path/config.json"
+ynh_replace_string --match_string="__DB_NAME__" --replace_string="$db_name" --target_file="$final_path/config.json"
+ynh_replace_string --match_string="__DB_PWD__" --replace_string="$db_pwd" --target_file="$final_path/config.json"
+ynh_replace_string --match_string="__APP__" --replace_string="$app" --target_file="$final_path/config.json"

 ynh_store_file_checksum --file="$final_path/config.json"

@ -135,7 +134,7 @@ ynh_store_file_checksum --file="$final_path/config.json"
 ynh_script_progression --message="Starting a systemd service..." --weight=1

 # Start a systemd service
-ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="HTTP Server listening"
+ynh_systemd_action --service_name=$app --action=start --log_path=systemd --line_match="HTTP Server listening"

 #=================================================
 # RELOAD NGINX
--- a/scripts/install
+++ b/scripts/install
@ -45,9 +45,8 @@ ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
 #=================================================
 ynh_script_progression --message="Storing installation settings..." --weight=2

-ynh_app_setting_set --app=$app --key=domain    --value=$domain
-ynh_app_setting_set --app=$app --key=path      --value=$path_url
-ynh_app_setting_set --app=$app --key=is_public --value=$is_public
+ynh_app_setting_set --app=$app --key=domain --value=$domain
+ynh_app_setting_set --app=$app --key=path   --value=$path_url

 #=================================================
 # STANDARD MODIFICATIONS
@ -79,14 +78,10 @@ ynh_install_extra_app_dependencies --repo="deb https://dl.yarnpkg.com/debian/ st
 ynh_script_progression --message="Creating a PostgreSQL database..." --weight=2

 db_name=$(ynh_sanitize_dbid --db_name=$app)
-db_user=$db_name
-db_pwd=$(ynh_string_random --length=30)
-
+db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd)
 ynh_app_setting_set --app=$app --key=db_name --value=$db_name
-ynh_app_setting_set --app=$app --key=db_pwd  --value=$db_pwd
-
 ynh_psql_test_if_first_run
-ynh_psql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd
+ynh_psql_setup_db --db_user=$db_name --db_name=$db_name

 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
@ -130,8 +125,8 @@ popd || ynh_die
 #=================================================
 ynh_script_progression --message="Configuring a systemd service..." --weight=1

-ynh_replace_string --match_string="__ENV_PATH__"  --replace_string="$PATH"    --target_file="../conf/systemd.service"
-ynh_replace_string --match_string="__YNH_NPM__"   --replace_string="$ynh_npm" --target_file="../conf/systemd.service"
+ynh_replace_string --match_string="__ENV_PATH__" --replace_string="$PATH"    --target_file="../conf/systemd.service"
+ynh_replace_string --match_string="__YNH_NPM__"  --replace_string="$ynh_npm" --target_file="../conf/systemd.service"

 ynh_add_systemd_config

@ -143,22 +138,20 @@ ynh_script_progression --message="Modifying a config file..." --weight=1
 cp ../conf/config.json.example "$final_path/config.json"

 # Main config File
-ynh_replace_string --match_string="__PORT__"    --replace_string="$port"     --target_file="$final_path/config.json"
-ynh_replace_string --match_string="__DOMAIN__"  --replace_string="$domain"   --target_file="$final_path/config.json"
-ynh_replace_string --match_string="__PATH__"    --replace_string="${path_url:1}" --target_file="$final_path/config.json"
-ynh_replace_string --match_string="__DB_USER__" --replace_string="$db_user"  --target_file="$final_path/config.json"
-ynh_replace_string --match_string="__DB_NAME__" --replace_string="$db_name"  --target_file="$final_path/config.json"
-ynh_replace_string --match_string="__DB_PASS__" --replace_string="$db_pwd"   --target_file="$final_path/config.json"
-ynh_replace_string --match_string="__APP__"     --replace_string="$app"      --target_file="$final_path/config.json"
+ynh_replace_string --match_string="__PORT__" --replace_string="$port" --target_file="$final_path/config.json"
+ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain" --target_file="$final_path/config.json"
+ynh_replace_string --match_string="__PATH__" --replace_string="${path_url:1}" --target_file="$final_path/config.json"
+ynh_replace_string --match_string="__DB_NAME__" --replace_string="$db_name" --target_file="$final_path/config.json"
+ynh_replace_string --match_string="__DB_PWD__" --replace_string="$db_pwd" --target_file="$final_path/config.json"
+ynh_replace_string --match_string="__APP__" --replace_string="$app" --target_file="$final_path/config.json"

 ynh_store_file_checksum --file="$final_path/config.json"

 cp ../conf/.sequelizerc.example "$final_path/.sequelizerc"

-# DB Config File
-ynh_replace_string --match_string="__DB_USER__" --replace_string="$db_user" --target_file="$final_path/.sequelizerc"
+# # DB Config File
 ynh_replace_string --match_string="__DB_NAME__" --replace_string="$db_name" --target_file="$final_path/.sequelizerc"
-ynh_replace_string --match_string="__DB_PASS__" --replace_string="$db_pwd"  --target_file="$final_path/.sequelizerc"
+ynh_replace_string --match_string="__DB_PWD__" --replace_string="$db_pwd" --target_file="$final_path/.sequelizerc"

 ynh_store_file_checksum --file="$final_path/.sequelizerc"

@ -170,7 +163,7 @@ ynh_store_file_checksum --file="$final_path/.sequelizerc"
 ynh_script_progression --message="Securing files and directories..." --weight=1

 # Set permissions to app files
-chown -R $app:$app $final_path
+chown -R $app: $final_path

 #=================================================
 # INTEGRATE SERVICE IN YUNOHOST
@ -185,19 +178,17 @@ yunohost service add $app --description="Collaborative Markdown editor" --log="/
 ynh_script_progression --message="Starting a systemd service..." --weight=2

 # Start a systemd service
-ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="HTTP Server listening"
+ynh_systemd_action --service_name=$app --action=start --log_path=systemd --line_match="HTTP Server listening"

 #=================================================
 # SETUP SSOWAT
 #=================================================
-ynh_script_progression --message="Configuring SSOwat..." --weight=1
+ynh_script_progression --message="Configuring permissions..." --weight=1

 # Make app public if necessary or protect it
 if [ $is_public -eq 1 ]
 then
-	# Everyone can access the app.
-	# The "main" permission is automatically created before the install script.
-	ynh_permission_update --permission "main" --add "visitors"
+	ynh_permission_update --permission="main" --add="visitors"
 fi

 #=================================================
--- a/scripts/remove
+++ b/scripts/remove
@ -17,10 +17,9 @@ ynh_script_progression --message="Loading installation settings..." --weight=1
 app=$YNH_APP_INSTANCE_NAME

 domain=$(ynh_app_setting_get --app=$app --key=domain)
-port=$(ynh_app_setting_get --app=$app --key=port)
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 db_name=$(ynh_app_setting_get --app=$app --key=db_name)
 db_user=$db_name
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)

 #=================================================
 # STANDARD REMOVE
--- a/scripts/restore
+++ b/scripts/restore
@ -31,7 +31,7 @@ path_url=$(ynh_app_setting_get --app=$app --key=path)
 final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 db_name=$(ynh_app_setting_get --app=$app --key=db_name)
 db_user=$db_name
-db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd)
+db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd)

 #=================================================
 # CHECK IF THE APP CAN BE RESTORED
@ -73,7 +73,7 @@ ynh_system_user_create --username=$app
 ynh_script_progression --message="Restoring user rights..." --weight=2

 # Restore permissions on app files
-chown -R $app:$app $final_path
+chown -R $app: $final_path

 #=================================================
 # SPECIFIC RESTORATION
@ -120,7 +120,7 @@ yunohost service add $app --description="Collaborative Markdown editor" --log="/
 #=================================================
 ynh_script_progression --message="Starting a systemd service..." --weight=1

-ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="HTTP Server listening"
+ynh_systemd_action --service_name=$app --action=start --log_path=systemd --line_match="HTTP Server listening"

 #=================================================
 # GENERIC FINALIZATION
--- a/scripts/upgrade
+++ b/scripts/upgrade
@ -18,13 +18,11 @@ app=$YNH_APP_INSTANCE_NAME

 domain=$(ynh_app_setting_get --app=$app --key=domain)
 path_url=$(ynh_app_setting_get --app=$app --key=path)
-is_public=$(ynh_app_setting_get --app=$app --key=is_public)
 final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 port=$(ynh_app_setting_get --app=$app --key=port)
-
 db_name=$(ynh_app_setting_get --app=$app --key=db_name)
 db_user=$db_name
-db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd)
+db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd)

 #=================================================
 # CHECK VERSION
@ -138,14 +136,13 @@ ynh_backup_if_checksum_is_different --file="$final_path/config.json"

 cp ../conf/config.json.example "$final_path/config.json"

-# Main config File
-ynh_replace_string --match_string="__PORT__"    --replace_string="$port"     --target_file="$final_path/config.json"
-ynh_replace_string --match_string="__DOMAIN__"  --replace_string="$domain"   --target_file="$final_path/config.json"
-ynh_replace_string --match_string="__PATH__"    --replace_string="${path_url:1}" --target_file="$final_path/config.json"
-ynh_replace_string --match_string="__DB_USER__" --replace_string="$db_user"  --target_file="$final_path/config.json"
-ynh_replace_string --match_string="__DB_NAME__" --replace_string="$db_name"  --target_file="$final_path/config.json"
-ynh_replace_string --match_string="__DB_PASS__" --replace_string="$db_pwd"   --target_file="$final_path/config.json"
-ynh_replace_string --match_string="__APP__"     --replace_string="$app"      --target_file="$final_path/config.json"
+# # Main config File
+ynh_replace_string --match_string="__PORT__" --replace_string="$port" --target_file="$final_path/config.json"
+ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain" --target_file="$final_path/config.json"
+ynh_replace_string --match_string="__PATH__" --replace_string="${path_url:1}" --target_file="$final_path/config.json"
+ynh_replace_string --match_string="__DB_NAME__" --replace_string="$db_name" --target_file="$final_path/config.json"
+ynh_replace_string --match_string="__DB_PWD__" --replace_string="$db_pwd" --target_file="$final_path/config.json"
+ynh_replace_string --match_string="__APP__" --replace_string="$app" --target_file="$final_path/config.json"

 # Recalculate and store the checksum of the file for the next upgrade.
 ynh_store_file_checksum --file="$final_path/config.json"
@ -155,8 +152,8 @@ ynh_store_file_checksum --file="$final_path/config.json"
 #=================================================
 ynh_script_progression --message="Configuring a systemd service..." --weight=2

-ynh_replace_string --match_string="__ENV_PATH__" --replace_string="$PATH"    --target_file="../conf/systemd.service"
-ynh_replace_string --match_string="__YNH_NPM__"  --replace_string="$ynh_npm" --target_file="../conf/systemd.service"
+ynh_replace_string --match_string="__ENV_PATH__" --replace_string="$PATH" --target_file="../conf/systemd.service"
+ynh_replace_string --match_string="__YNH_NPM__" --replace_string="$ynh_npm" --target_file="../conf/systemd.service"

 # Create a dedicated systemd config
 ynh_add_systemd_config
@ -169,7 +166,7 @@ ynh_add_systemd_config
 ynh_script_progression --message="Securing files and directories..." --weight=1

 # Set permissions on app files
-chown -R $app:$app $final_path
+chown -R $app: $final_path

 #=================================================
 # INTEGRATE SERVICE IN YUNOHOST
@ -183,7 +180,7 @@ yunohost service add $app --description="Collaborative Markdown editor" --log="/
 #=================================================
 ynh_script_progression --message="Starting a systemd service..." --weight=1

-ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="HTTP Server listening"
+ynh_systemd_action --service_name=$app --action=start --log_path=systemd --line_match="HTTP Server listening"

 #=================================================
 # RELOAD NGINX