Merge branch 'master' into eng-testing

2024-09-03 20:36:09 +02:00 · 2021-05-13 22:09:15 +02:00 · 2021-05-13 22:09:15 +02:00 · 8b0bba39c7
commit 8b0bba39c7
parent 5903dc99c2 17ee20b13b
12 changed files with 80 additions and 82 deletions
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@ -8,7 +8,7 @@ about: When creating a bug report, please use the following template to provide
 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 Wiki.js itself. Refer to its documentation or repository for help.*
+   - *Otherwise, the issue may be due to the app 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.*
 --- 
@ -31,7 +31,7 @@ about: When creating a bug report, please use the following template to provide

 - *If you performed a command from the CLI, the command itself is enough. For example:*
    ```sh
-    sudo yunohost app install wikijs
+    sudo yunohost app install the_app
    ```
 - *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:*
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@ -0,0 +1,16 @@
+## Problem
+
+- *Description of why you made this PR*
+
+## Solution
+
+- *And how do you fix that problem*
+
+## PR Status
+
+- [ ] Code finished and ready to be reviewed/tested
+- [ ] The fix/enhancement were manually tested (if applicable)
+
+## Automatic tests
+
+Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization)
--- a/README.md
+++ b/README.md
@ -40,8 +40,8 @@ The app can be used by multiple users.

 #### Supported architectures

-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wikijs%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/wikijs/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/wikijs%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/wikijs/)
+* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wikijs.svg)](https://ci-apps.yunohost.org/ci/apps/wikijs/)
+* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/wikijs.svg)](https://ci-apps-arm.yunohost.org/ci/apps/wikijs/)

 ## Limitations

--- a/4
+++ b/4
@ -32,6 +32,8 @@
 		upgrade=1	from_commit=f241d2586694d9aff19ae6d67209142faa8b25ca
 		# 2.5.197~ynh1
 		upgrade=1	from_commit=3c9ab32ee147ef1f39aff2773fc3be506164d873
+		# 2.5.201~ynh1
+		upgrade=1	from_commit=bce2bfa3f9f0e28ffdde79df17a34bd5302559ea
 		backup_restore=1
 		multi_instance=1
 		port_already_use=0
@ -62,3 +64,5 @@ Notification=yes
 		name=2.5.191~ynh1
 	; commit=3c9ab32ee147ef1f39aff2773fc3be506164d873
 		name=2.5.197~ynh1
+	; commit=bce2bfa3f9f0e28ffdde79df17a34bd5302559ea
+		name=2.5.201~ynh1
--- a/manifest.json
+++ b/manifest.json
@ -6,7 +6,7 @@
        "en": "Open source, modern and powerful wiki app built on Node.js, Git and Markdown.",
        "fr": "Wiki moderne et open source propulsé Node.js, Git et Markdown."
    },
-    "version": "2.5.170~ynh2",
+    "version": "2.5.201~ynh3",
    "url": "https://wiki.js.org/",
    "license": "AGPL-3.0-or-later",
    "maintainer": {
--- a/pull_request_template.md
+++ b/pull_request_template.md
@ -1,16 +0,0 @@
-## Problem
- *Description of why you made this PR*
-
-## Solution
- *And how do you fix that problem*
-
-## PR Status
- [ ] Code finished.
- [ ] Tested with Package_check.
- [ ] Fix or enhancement tested.
- [ ] Upgrade from last version tested.
- [ ] Can be reviewed and tested.
-
-## Package_check results
---
-* 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/backup
+++ b/scripts/backup
@ -6,7 +6,7 @@
 # IMPORT GENERIC HELPERS
 #=================================================

-#Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
+# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
 source ../settings/scripts/_common.sh
 source /usr/share/yunohost/helpers

--- a/scripts/change_url
+++ b/scripts/change_url
@ -32,7 +32,7 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 port=$(ynh_app_setting_get --app=$app --key=port)

 #=================================================
-# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
+# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP
 #=================================================
 ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..."

@ -42,7 +42,7 @@ ynh_clean_setup () {
 	# Remove the new domain config file, the remove script won't do it as it doesn't know yet its location.
 	ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"

-	# restore it if the upgrade fails
+	# Restore it if the upgrade fails
 	ynh_restore_upgradebackup
 }
 # Exit if an error occurs during the execution of the script
--- a/scripts/install
+++ b/scripts/install
@ -74,6 +74,14 @@ ynh_install_nodejs --nodejs_version=$NODEJS_VERSION
 ynh_use_nodejs
 ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies

+#=================================================
+# CREATE DEDICATED USER
+#=================================================
+ynh_script_progression --message="Configuring system user..."
+
+# Create a system user
+ynh_system_user_create --username=$app --home_dir="$final_path"
+
 #=================================================
 # CREATE A POSTGRESQL DATABASE
 #=================================================
@ -97,6 +105,10 @@ 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"

+chmod 750 "$final_path"
+chmod -R o-rwx "$final_path"
+chown -R $app:$app "$final_path"
+
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
@ -105,14 +117,6 @@ ynh_script_progression --message="Configuring NGINX web server..."
 # Create a dedicated NGINX config
 ynh_add_nginx_config

-#=================================================
-# CREATE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Configuring system user..."
-
-# Create a system user
-ynh_system_user_create --username=$app --home_dir="$final_path"
-
 #=================================================
 # SPECIFIC SETUP
 #=================================================
@ -122,6 +126,16 @@ ynh_script_progression --message="Creating LDAP user..."

 yunohost user create $ldap_user --firstname "SvcWikijsLdap" --lastname "SvcWikijsLdap" --mail ${ldap_user}@$domain --password $ldap_password -q 0

+#=================================================
+# ADD A CONFIGURATION
+#=================================================
+ynh_script_progression --message="Adding a config file..."
+
+ynh_add_config --template="../conf/config.sample.yml" --destination="$final_path/config.yml"
+
+chmod 400 "$final_path/config.yml"
+chown $app:$app "$final_path/config.yml"
+
 #=================================================
 # SETUP SYSTEMD
 #=================================================
@ -130,23 +144,8 @@ ynh_script_progression --message="Configuring a systemd service..."
 # Create a dedicated systemd config
 ynh_add_systemd_config --others_var="ynh_node ynh_node_load_PATH"

-#=================================================
-# MODIFY A CONFIG FILE
-#=================================================
-ynh_script_progression --message="Modifying a config file..."
-
-ynh_add_config --template="../conf/config.sample.yml" --destination="$final_path/config.yml"
-
 #=================================================
 # GENERIC FINALIZATION
-#=================================================
-# SECURE FILES AND DIRECTORIES
-#=================================================
-ynh_script_progression --message="Securing files and directories..."
-
-# Set permissions to app files
-chown -R $app: $final_path
-
 #=================================================
 # INTEGRATE SERVICE IN YUNOHOST
 #=================================================
--- a/scripts/remove
+++ b/scripts/remove
@ -29,7 +29,7 @@ ldap_user=$(ynh_app_setting_get --app=$app --key=ldap_user)
 # REMOVE SERVICE INTEGRATION IN YUNOHOST
 #=================================================

-# Remove the service from the list of services known by Yunohost (added from `yunohost service add`)
+# Remove the service from the list of services known by YunoHost (added from `yunohost service add`)
 if ynh_exec_warn_less yunohost service status $app >/dev/null
 then
 	ynh_script_progression --message="Removing $app service integration..."
@ -58,8 +58,8 @@ ynh_psql_remove_db --db_user="$db_user" --db_name="$db_name"
 ynh_script_progression --message="Removing dependencies..."

 # Remove metapackage and its dependencies
-ynh_remove_app_dependencies
 ynh_remove_nodejs
+ynh_remove_app_dependencies

 #=================================================
 # REMOVE APP MAIN DIR
--- a/scripts/restore
+++ b/scripts/restore
@ -6,7 +6,7 @@
 # IMPORT GENERIC HELPERS
 #=================================================

-#Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
+# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
 source ../settings/scripts/_common.sh
 source /usr/share/yunohost/helpers

@ -23,7 +23,7 @@ ynh_abort_if_errors
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading settings..."
+ynh_script_progression --message="Loading installation settings..."

 app=$YNH_APP_INSTANCE_NAME

@ -51,17 +51,10 @@ test ! -d $final_path \
 #=================================================
 # RESTORE THE NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Restoring the NGINX configuration..."
+ynh_script_progression --message="Restoring the NGINX web server configuration..."

 ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"

-#=================================================
-# RESTORE THE APP MAIN DIR
-#=================================================
-ynh_script_progression --message="Restoring the app main directory..."
-
-ynh_restore_file --origin_path="$final_path"
-
 #=================================================
 # RECREATE THE DEDICATED USER
 #=================================================
@ -71,12 +64,15 @@ ynh_script_progression --message="Recreating the dedicated system user..."
 ynh_system_user_create --username=$app --home_dir="$final_path"

 #=================================================
-# RESTORE USER RIGHTS
+# RESTORE THE APP MAIN DIR
 #=================================================
-ynh_script_progression --message="Restoring user rights..."
+ynh_script_progression --message="Restoring the app main directory..."

-# Restore permissions on app files
-chown -R $app: $final_path
+ynh_restore_file --origin_path="$final_path"
+
+chmod 750 "$final_path"
+chmod -R o-rwx "$final_path"
+chown -R $app:$app "$final_path"

 #=================================================
 # SPECIFIC RESTORATION
--- a/scripts/upgrade
+++ b/scripts/upgrade
@ -97,6 +97,14 @@ ynh_script_progression --message="Stopping a systemd service..."

 ynh_systemd_action --service_name=$app --action=stop --log_path=systemd --line_match="Stopped wikijs service"

+#=================================================
+# CREATE DEDICATED USER
+#=================================================
+ynh_script_progression --message="Making sure dedicated system user exists..."
+
+# Create a dedicated user (if not existing)
+ynh_system_user_create --username=$app --home_dir="$final_path"
+
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
@ -129,12 +137,16 @@ then
 	fi
 fi

+chmod 750 "$final_path"
+chmod -R o-rwx "$final_path"
+chown -R $app:$app "$final_path"
+
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
 ynh_script_progression --message="Upgrading NGINX web server configuration..."

-# Create a dedicated nginx config
+# Create a dedicated NGINX config
 ynh_add_nginx_config

 #=================================================
@ -146,23 +158,18 @@ ynh_install_nodejs --nodejs_version=$NODEJS_VERSION
 ynh_use_nodejs
 ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies

-#=================================================
-# CREATE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Making sure dedicated system user exists..."
-
-# Create a dedicated user (if not existing)
-ynh_system_user_create --username=$app --home_dir="$final_path"
-
 #=================================================
 # SPECIFIC UPGRADE
 #=================================================
-# MODIFY A CONFIG FILE
+# UPDATE A CONFIG FILE
 #=================================================
-ynh_script_progression --message="Modifying a config file..."
+ynh_script_progression --message="Updating a config file..."

 ynh_add_config --template="../conf/config.sample.yml" --destination="$final_path/config.yml"

+chmod 400 "$final_path/config.yml"
+chown $app:$app "$final_path/config.yml"
+
 #=================================================
 # SETUP SYSTEMD
 #=================================================
@ -173,14 +180,6 @@ ynh_add_systemd_config --others_var="ynh_node ynh_node_load_PATH"

 #=================================================
 # GENERIC FINALIZATION
-#=================================================
-# SECURE FILES AND DIRECTORIES
-#=================================================
-ynh_script_progression --message="Securing files and directories..."
-
-# Set permissions on app files
-chown -R $app: $final_path
-
 #=================================================
 # INTEGRATE SERVICE IN YUNOHOST
 #=================================================