Merge branch 'testing' into plugins

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,55 @@
+---
+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 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.*
+--- 
+
+### 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 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:*
+   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.*

.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)

README.md

@@ -8,7 +8,7 @@
 > *This package allow you to install Etherpad-Lite quickly and simply on a YunoHost server.  
 If you don't have YunoHost, please see [here](https://yunohost.org/install) to know how to install and enjoy it.*
 
-> :warning: This package installs Etherpad-Lite (without MyPads and plugins). It uses PostgreSQL as a database.
+> :warning: This package installs Etherpad-Lite (without MyPads and plugins). It uses PostgreSQL as database.
 >If you want to install Etherpad with the MyPads plugin, use the [Etherpad MyPads package](https://github.com/YunoHost-Apps/etherpad_mypads_ynh).
 
 ## Overview

check_process

@@ -19,6 +19,7 @@
 		setup_private=1
 		setup_public=1
 		upgrade=1
+		upgrade=1	from_commit=96653aee9379d579a655777ac274355f4afca61c
 		backup_restore=1
 		multi_instance=1
 		change_url=1
@@ -26,6 +27,6 @@
 Email=
 Notification=none
 ;;; Upgrade options
-	; commit=CommitHash
-		name=Name and date of the commit.
+	; commit=96653aee9379d579a655777ac274355f4afca61c
+		name=Merge pull request #6 from YunoHost-Apps/testing
 		manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=pass&port=9001&

conf/nginx.conf

@@ -12,6 +12,7 @@ location __PATH__/ {
 
   # be careful, this line doesn't override any proxy_buffering on set in a conf.d/file.conf
   proxy_buffering off;
+  more_set_headers "X-Frame-Options : ALLOWALL";
   proxy_set_header X-Real-IP $remote_addr;       # http://wiki.nginx.org/HttpProxyModule
   proxy_set_header X-Forwarded-For $remote_addr; # EP logs to show the actual remote IP
   proxy_set_header X-Forwarded-Proto $scheme;    # for EP to set secure cookie flag when https is used

conf/systemd.service

@@ -9,7 +9,7 @@ Group=__APP__
 WorkingDirectory=__FINALPATH__
 Environment="NODE_ENV=production"
 Environment="__YNH_NODE_LOAD_PATH__"
-ExecStart=__FINALPATH__/node_modules/ep_etherpad-lite/node/server.js
+ExecStart=__FINALPATH__/src/bin/run.sh
 Restart=always
 
 [Install]

manifest.json

@@ -6,7 +6,7 @@
         "en": "Online editor providing collaborative editing in real-time.",
         "fr": "Éditeur en ligne fournissant l'édition collaborative en temps réel."
     },
-    "version": "1.8.13~ynh1",
+    "version": "1.8.13~ynh2",
     "url": "https://etherpad.org/",
     "license": "Apache-2.0",
     "maintainer": {
@@ -58,7 +58,7 @@
                     "en": "Choose the application language",
                     "fr": "Choisissez la langue de l'application"
                 },
-                "choices": ["de", "en", "es", "fr", "it", "pt"],
+                "choices": ["de", "en", "es", "fr", "it"],
                 "default": "en"
             },
             {

scripts/_common.sh

@@ -5,7 +5,7 @@
 #=================================================
 
 # dependencies used by the app
-pkg_dependencies="postgresql postgresql-contrib apt-transport-https"
+pkg_dependencies="postgresql postgresql-contrib"
 
 nodejs_version=15
 

scripts/change_url

@@ -70,7 +70,7 @@ fi
 #=================================================
 ynh_script_progression --message="Stopping a systemd service..." --weight=2
 
-ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd"
+ynh_systemd_action --service_name=$app --action=stop --log_path=systemd
 
 #=================================================
 # MODIFY URL IN NGINX CONF

scripts/install

@@ -70,7 +70,7 @@ ynh_app_setting_set --app=$app --key=port --value=$port
 #=================================================
 # INSTALL DEPENDENCIES
 #=================================================
-ynh_script_progression --message="Installing dependencies..." --weight=12
+ynh_script_progression --message="Installing dependencies..." --weight=6
 
 ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies
 
@@ -90,6 +90,14 @@ ynh_script_progression --message="Configuring system user..." --weight=4
 # Create a system user
 ynh_system_user_create --username=$app --home_dir=$final_path
 
+#=================================================
+# CREATE DEDICATED USER
+#=================================================
+ynh_script_progression --message="Configuring system user..." --weight=4
+
+# Create a system user
+ynh_system_user_create --username=$app --home_dir=$final_path
+
 #=================================================
 # CREATE A POSTQRESQL DATABASE
 #=================================================
@@ -127,8 +135,7 @@ chown -R $app: $final_path
 
 pushd $final_path || ynh_die
  	ynh_use_nodejs
- 	ynh_exec_as $app env "$ynh_node_load_PATH" bin/installDeps.sh
- 	# ynh_exec_warn_less ynh_exec_as $app env "$ynh_node_load_PATH" npm install ep_spellcheck ep_countable ep_delete_empty_pads ep_subscript_and_superscript ep_headings2 ep_author_hover ep_markdown ep_comments_page ep_align ep_font_color
+ 	ynh_exec_as $app env $ynh_node_load_PATH src/bin/installDeps.sh
 popd || ynh_die
 
 #=================================================
@@ -202,7 +209,6 @@ then
 	ynh_permission_update --permission="main" --add="visitors"
 fi
 
-# Only the admin can access the admin panel of the app (if the app has an admin panel)
 ynh_permission_create --permission="admin" --url="/admin" --allowed=$admin
 
 #=================================================

scripts/upgrade

@@ -128,14 +128,6 @@ ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies
 
 ynh_install_nodejs --nodejs_version=$nodejs_version
 
-#=================================================
-# CREATE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
-
-# Create a dedicated user (if not existing)
-ynh_system_user_create --username=$app
-
 #=================================================
 # INSTALL ETHERPAD
 #=================================================
@@ -143,40 +135,13 @@ ynh_script_progression --message="Installing Etherpad..." --weight=90
 
 chown -R $app: $final_path
 
-pushd "$final_path" || ynh_die
+pushd $final_path || ynh_die
  	ynh_use_nodejs
- 	ynh_exec_as $app env $ynh_node_load_PATH bin/installDeps.sh
- 	 	# ynh_exec_warn_less ynh_exec_as $app env "$ynh_node_load_PATH" npm install ep_spellcheck ep_countable ep_delete_empty_pads ep_subscript_and_superscript ep_headings2 ep_author_hover ep_markdown ep_comments_page ep_align ep_font_color
+ 	ynh_exec_as $app env $ynh_node_load_PATH src/bin/installDeps.sh
+	ynh_exec_warn_less ynh_exec_as $app env "$ynh_node_load_PATH" npm cache clean --force
+	ynh_exec_warn_less ynh_exec_as $app env "$ynh_node_load_PATH" npm install --upgrade 
 popd || ynh_die 
 
-#=================================================
-# MODIFY A CONFIG FILE
-#=================================================
-# ynh_script_progression --message="Reconfiguring Etherpad..." --weight=6
-
-# ynh_backup_if_checksum_is_different --file="$final_path/settings.json"
-
-# cp ../conf/settings.json $final_path/settings.json
-
-# ynh_replace_string --match_string="__PORT__" --replace_string="$port" --target_file="$final_path/settings.json"
-# ynh_replace_string --match_string="__LANGUAGE__" --replace_string="$language" --target_file="$final_path/settings.json"
-# if [ "$export" = "abiword" ]
-# then
-# 	# Get AbiWord binary path
-# 	abiword_path=`which abiword`
-# 	# Set the path of AbiWord into Etherpad config
-# 	ynh_replace_string --match_string="\"abiword\" : null" --replace_string="\"abiword\" : \"$abiword_path\"" --target_file="$final_path/settings.json"
-# elif [ "$export" = "libreoffice" ]
-# then
-# 	# Get soffice binary path
-# 	soffice_path=`which soffice`
-# 	# Set the path of soffice into Etherpad config
-# 	ynh_replace_string --match_string="\"soffice\" : null" --replace_string="\"soffice\" : \"$soffice_path\"" --target_file="$final_path/settings.json"
-# fi
-# ynh_store_file_checksum --file="$final_path/settings.json"
-
-# ynh_add_config --template="../conf/credentials.json" --destination="$final_path/credentials.json"
-
 #=================================================
 # GENERIC FINALIZATION
 #=================================================