Merge pull request #1 from YunoHost-Apps/testing

Fix

issue_template.md

@@ -1,55 +0,0 @@
----
-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 Etherpad 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 etherpad
-    ```
-- *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.*

manifest.json

@@ -12,13 +12,12 @@
         "license": "Apache-2.0",
         "website": "https://n8n.io/",
         "demo": "https://demo.example.com",
-        "admindoc": "https://yunohost.org/packaging_apps",
+        "admindoc": "https://docs.n8n.io/",
-        "userdoc": "https://yunohost.org/apps",
         "code": "https://github.com/n8n-io/n8n"
     },
     "license": "",
     "maintainer": {
-        "name": "eric_G"
+        "name": ""
     },
     "requirements": {
         "yunohost": ">= 4.2.4"

scripts/_common.sh

@@ -4,9 +4,6 @@
 # COMMON VARIABLES
 #=================================================
 
-# dependencies used by the app
-pkg_dependencies="postgresql postgresql-contrib"
-
 nodejs_version=14
 
 n8n_version=0.138.0

scripts/backup

@@ -37,6 +37,12 @@ ynh_print_info --message="Declaring files to be backed up..."
 
 ynh_backup --src_path="$final_path"
 
+#=================================================
+# BACKUP THE DATA DIR
+#=================================================
+
+ynh_backup --src_path="$datadir" --is_big
+
 #=================================================
 # BACKUP THE NGINX CONFIGURATION
 #=================================================
@@ -50,11 +56,11 @@ ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 ynh_backup --src_path="/etc/systemd/system/$app.service"
 
 #=================================================
-# BACKUP THE POSTQRESQL DATABASE
+# BACKUP THE MYSQL DATABASE
 #=================================================
-ynh_print_info --message="Backing up the PostgreSQL database..."
+ynh_print_info --message="Backing up the MySQL database..."
 
-ynh_psql_dump_db --database="$db_name" > db.sql
+ynh_mysql_dump_db --database="$db_name" > db.sql
 
 #=================================================
 # END OF SCRIPT

scripts/install

@@ -64,8 +64,6 @@ ynh_app_setting_set --app=$app --key=port --value=$port
 #=================================================
 ynh_script_progression --message="Installing dependencies..." --weight=6
 
-ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies
-
 ynh_install_nodejs --nodejs_version=$nodejs_version
 
 #=================================================
@@ -94,7 +92,7 @@ ynh_script_progression --message="Setting up source files..." --weight=1
 ynh_app_setting_set --app=$app --key=final_path --value=$final_path
 # Download, check integrity, uncompress and patch the source from app.src
 #ynh_setup_source --dest_dir=$final_path
-mkdir $final_path
+mkdir -p $final_path
 
 #=================================================
 # INSTALL ETHERPAD

scripts/remove

@@ -41,6 +41,23 @@ ynh_script_progression --message="Stopping and removing the systemd service..."
 # Remove the dedicated systemd config
 ynh_remove_systemd_config
 
+
+#=================================================
+# REMOVE THE MYSQL DATABASE
+#=================================================
+ynh_script_progression --message="Removing the MySQL database..." --weight=1
+
+# Remove a database if it exists, along with the associated user
+ynh_mysql_remove_db --db_user=$db_user --db_name=$db_name
+
+#=================================================
+# REMOVE DEPENDENCIES
+#=================================================
+ynh_script_progression --message="Removing dependencies..." --weight=1
+
+# Remove metapackage and its dependencies
+ynh_remove_nodejs
+
 #=================================================
 # REMOVE ETHERPAD MAIN DIR
 #=================================================

scripts/restore

@@ -13,9 +13,6 @@ source /usr/share/yunohost/helpers
 # MANAGE SCRIPT FAILURE
 #=================================================
 
-ynh_clean_setup () {
-	ynh_clean_check_starting
-}
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
 
@@ -28,7 +25,10 @@ app=$YNH_APP_INSTANCE_NAME
 
 domain=$(ynh_app_setting_get --app=$app --key=domain)
 path_url=$(ynh_app_setting_get --app=$app --key=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)
+datadir=$(ynh_app_setting_get --app=$app --key=datadir)
 
 #=================================================
 # CHECK IF ETHERPAD CAN BE RESTORED
@@ -65,17 +65,36 @@ chmod 750 "$final_path"
 chmod -R o-rwx "$final_path"
 chown -R $app:www-data "$final_path"
 
+#=================================================
+# RESTORE THE DATA DIRECTORY
+#=================================================
+ynh_script_progression --message="Restoring the data directory..." --weight=1
+
+ynh_restore_file --origin_path="$datadir" --not_mandatory
+
+mkdir -p $datadir
+
+chmod 750 "$datadir"
+chmod -R o-rwx "$datadir"
+chown -R $app:www-data "$datadir"
+
 #=================================================
 # REINSTALL DEPENDENCIES
 #=================================================
 ynh_script_progression --message="Reinstalling dependencies..." --weight=7
 
-# Define and install dependencies
-ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies
-
 # Install Nodejs
 ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version
 
+#=================================================
+# RESTORE THE MYSQL DATABASE
+#=================================================
+ynh_script_progression --message="Restoring the MySQL database..." --weight=1
+
+db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
+ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd
+ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql
+
 #=================================================
 # INTEGRATE SERVICE IN YUNOHOST
 #=================================================

scripts/upgrade

@@ -18,10 +18,9 @@ app=$YNH_APP_INSTANCE_NAME
 
 domain=$(ynh_app_setting_get --app=$app --key=domain)
 path_url=$(ynh_app_setting_get --app=$app --key=path)
-admin=$(ynh_app_setting_get --app=$app --key=admin)
 final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 port=$(ynh_app_setting_get --app=$app --key=port)
-password=$(ynh_app_setting_get --app=$app --key=password)
+db_name=$(ynh_app_setting_get --app=$app --key=db_name)
 
 #=================================================
 # CHECK VERSION
@@ -92,31 +91,17 @@ ynh_add_nginx_config
 #=================================================
 ynh_script_progression --message="Installing dependencies..." --weight=12
 
-ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies
-
 ynh_install_nodejs --nodejs_version=$nodejs_version
 
 #=================================================
-# INSTALL ETHERPAD
+# UPDATE A CONFIG FILE
 #=================================================
-ynh_script_progression --message="Installing Etherpad..." --weight=90
+ynh_script_progression --message="Updating a configuration file..." --weight=1
 
-chown -R $app: $final_path
+ynh_add_config --template="../conf/.env" --destination="$final_path/.env"
 
-pushd $final_path
+chmod 400 "$final_path/.env"
- 	ynh_use_nodejs
+chown $app:$app "$final_path/.env"
-popd
-
-#=================================================
-# GENERIC FINALIZATION
-#=================================================
-# SECURE FILES AND DIRECTORIES
-#=================================================
-
-# Set permissions on app files
-chown -R $app: $final_path
-chmod o-rwx $final_path
-chmod 600 $final_path/credentials.json
 
 #=================================================
 # SETUP SYSTEMD
@@ -124,7 +109,7 @@ chmod 600 $final_path/credentials.json
 ynh_script_progression --message="Upgrading systemd configuration..." --weight=2
 
 # Create a dedicated systemd config
-ynh_add_systemd_config --others_var="ynh_node_load_PATH"
+ynh_add_systemd_config
 
 #=================================================
 # INTEGRATE SERVICE IN YUNOHOST
@@ -138,7 +123,7 @@ yunohost service add $app --description="" --log="/var/log/$app/$app.log"
 #=================================================
 ynh_script_progression --message="Starting a systemd service..." --weight=6
 
-ynh_systemd_action --service_name=$app --action=restart --log_path=systemd --line_match=""
+ynh_systemd_action --service_name=$app --action=restart --log_path=systemd #--line_match=""
 
 #=================================================
 # RELOAD NGINX