From 85faf7f7f6108106c17dfc7ebb0dcddf4f691d7e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Mon, 3 Apr 2023 13:57:06 +0200 Subject: [PATCH] Testing (#61) * Small fixes * 1.7.0 (#4) * Upgrde to v.1.7.0 * Set requirements to 3.8.1 * Update README.md * Upgrade to 1.7.1 (#6) * Add limitations * Avoid to buid frontend bundle * Remove PostegrSQL warning * Update README.md Add you should reload service for changes in config to be registered. * Add restart systemd tuto * Change version * Finding an available port * Upgrade to version 1.7.2 (#12) * Patch (#17) * Cleaning up * Update manifest.json * Cleaning up * Secure config file * Remove yarn * Update change_url * Update change_url * Revert "Remove yarn" This reverts commit a8cabf0c0addf8f9c4569b27ae04512db5c93df0. * Update change_url * Update systemd.service * Update systemd.service * Cleaning up * Fix * fix badges * Upgrade to version 1.8.0 (#21) * Upgrade to version 1.8.0 * Upgrade to 1.8.0 * Upgrade to 1.8.0 * Upgrade to version 1.8.1 * [autopatch] Update issue and PR templates (#25) Co-authored-by: Yunohost-Bot <> * Add templates * Upgrade to 1.8.2 * Update check_process * Add templates * Auto-update README * Set new requirements (#28) * Fix * Simplify config * Auto-update README Co-authored-by: Yunohost-Bot <> * Update manifest.json * Auto-update README * 1.9.0 (#31) * 1.9.0 * Update manifest.json * Auto-update README * Systemd hardening (#33) * Update systemd.service * Update app.src * Update manifest.json * 1.9.1 (#34) * Upgrade to 1.9.1 * 1.9.2 (#36) * Remove replace_string * Fix (#39) * Update manifest.json * Auto-update README * Update config.json.example * Update config.json.example * 1.9.3 * Auto-update README * 1.9.4 (#42) * 1.9.4 * Auto-update README Co-authored-by: yunohost-bot * Auto-update README * Update manifest.json * Update _common.sh * set relative path for --keep opt * Update manifest.json * Auto-update README * 1.9.5 * Auto-update README * 1.9.6 * Auto-update README * Add more security as default (#47) * Add more security as default * Auto-update README * Update config.json.example * Update change_url Co-authored-by: yunohost-bot * Update manifest.json * Auto-update README * Update install * Fix * Add allow free url to config panel * Add FreeURL authentication * Update config.json.example * Fix * remove yarn cache * Auto-update README * 1.9.7 * Auto-update README * Update change_url * Update systemd.service * Update systemd.service * Update install * FIx * Update manifest.json * Auto-update README * Update manifest.json * Version 2 (#58) * v2 * fix * Auto-update README * Update manifest.toml * fix * Update install * Update upgrade * Update change_url * Update install * fix * Auto-update README * Fix * Auto-update README * Fix * fix * Update manifest.toml * fix * fix * Auto-update README * Update tests.toml --------- Co-authored-by: yunohost-bot --------- Co-authored-by: Eauchat <34686393+eauchat@users.noreply.github.com> Co-authored-by: Alexandre Aubin Co-authored-by: YunoHost Bot Co-authored-by: Yunohost-Bot <> Co-authored-by: yunohost-bot Co-authored-by: yalh76 --- README.md | 9 +-- README_fr.md | 9 +-- check_process | 26 -------- conf/app.src | 5 -- conf/systemd.service | 2 +- config_panel.toml | 10 +-- config_panel.toml.example | 24 -------- doc/ADMIN.md | 4 ++ doc/ADMIN_fr.md | 4 ++ doc/DISCLAIMER.md | 4 -- doc/DISCLAIMER_fr.md | 4 -- manifest.json | 52 ---------------- manifest.toml | 69 +++++++++++++++++++++ scripts/_common.sh | 3 - scripts/backup | 23 +------ scripts/change_url | 102 ++---------------------------- scripts/install | 126 +++++--------------------------------- scripts/remove | 41 ------------- scripts/restore | 55 +---------------- scripts/upgrade | 101 ++++-------------------------- tests.toml | 9 +++ 21 files changed, 131 insertions(+), 551 deletions(-) delete mode 100644 check_process delete mode 100644 conf/app.src delete mode 100644 config_panel.toml.example create mode 100644 doc/ADMIN.md create mode 100644 doc/ADMIN_fr.md delete mode 100644 doc/DISCLAIMER.md delete mode 100644 doc/DISCLAIMER_fr.md delete mode 100644 manifest.json create mode 100644 manifest.toml create mode 100644 tests.toml diff --git a/README.md b/README.md index 6435b6b..692fe0e 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ You can use it to easily collaborate on notes, graphs and even presentations in - Easy to use permission system - Low system requirements -**Shipped version:** 1.9.7~ynh2 +**Shipped version:** 1.9.7~ynh3 **Demo:** https://demo.hedgedoc.org/ @@ -37,13 +37,6 @@ You can use it to easily collaborate on notes, graphs and even presentations in ![Screenshot of HedgeDoc](./doc/screenshots/screenshot.png) -## Disclaimers / important information - -## Configuration - -You can configure HedgeDoc by editing this file `/var/www/hedgedoc/config.json` using the [documentation](https://github.com/hedgedoc/hedgedoc/blob/master/docs/configuration.md) -When you finished editing the configuration, for your changes to take effect, you will have to run: `sudo systemctl restart hedgedoc`. - ## Documentation and resources * Official app website: diff --git a/README_fr.md b/README_fr.md index 60b380d..569a67c 100644 --- a/README_fr.md +++ b/README_fr.md @@ -29,7 +29,7 @@ You can use it to easily collaborate on notes, graphs and even presentations in - Easy to use permission system - Low system requirements -**Version incluse :** 1.9.7~ynh2 +**Version incluse :** 1.9.7~ynh3 **Démo :** https://demo.hedgedoc.org/ @@ -37,13 +37,6 @@ You can use it to easily collaborate on notes, graphs and even presentations in ![Capture d’écran de HedgeDoc](./doc/screenshots/screenshot.png) -## Avertissements / informations importantes - -## Configuration - -Vous pouvez configurer HedgeDoc en modifiant le fichier `/var/www/hedgedoc/config.json` et en vous aidant de la [documentation](https://github.com/hedgedoc/hedgedoc/blob/master/docs/configuration.md) -Lorsque vous avez terminé de modifier la configuration, pour que vos modifications prennent effet, vous devrez exécuter : `sudo systemctl restart hedgedoc`. - ## Documentations et ressources * Site officiel de l’app : diff --git a/check_process b/check_process deleted file mode 100644 index 85e5f61..0000000 --- a/check_process +++ /dev/null @@ -1,26 +0,0 @@ -;; Test complet - ; Manifest - domain="domain.tld" - path="/path" - admin="john" - is_public=1 - ; Checks - pkg_linter=1 - setup_sub_dir=1 - setup_root=1 - setup_nourl=0 - setup_private=1 - setup_public=1 - upgrade=1 - upgrade=1 from_commit=2a6ed9db5f7f0644eab251b2495c190811735832 - backup_restore=1 - multi_instance=1 - change_url=1 -;;; Options -Email= -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& - diff --git a/conf/app.src b/conf/app.src deleted file mode 100644 index 03fcd47..0000000 --- a/conf/app.src +++ /dev/null @@ -1,5 +0,0 @@ -SOURCE_URL=https://github.com/hedgedoc/hedgedoc/releases/download/1.9.7/hedgedoc-1.9.7.tar.gz -SOURCE_SUM=c9bd99c65cf45fa1d7808855b46abbfa13b24400254d8da5e81dae2965494bb3 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true diff --git a/conf/systemd.service b/conf/systemd.service index caea1b3..017e1d6 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -7,7 +7,7 @@ After=network.target postgresql.service Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__ +WorkingDirectory=__INSTALL_DIR__ Environment="__YNH_NODE_LOAD_PATH__" Environment="NODE_ENV=production" ExecStart=__YNH_NPM__ start --production diff --git a/config_panel.toml b/config_panel.toml index b56edb0..df31d1a 100644 --- a/config_panel.toml +++ b/config_panel.toml @@ -12,7 +12,7 @@ name = "HedgeDoc configuration" yes = "true" no = "false" help = "Set to allow anonymous usage (default is true)." - bind = "allow_anonymous:__FINALPATH__/config.json" + bind = "allow_anonymous:__INSTALL_DIR__/config.json" [main.config.allow_anonymous_edits] ask = "Allow anonymous edits" @@ -20,7 +20,7 @@ name = "HedgeDoc configuration" yes = "true" no = "false" help = "Allow users to select freely permission, allowing guests to edit existing notes." - bind = "allow_anonymous_edits:__FINALPATH__/config.json" + bind = "allow_anonymous_edits:__INSTALL_DIR__/config.json" [main.config.allow_email_registration] @@ -29,7 +29,7 @@ name = "HedgeDoc configuration" yes = "true" no = "false" help = "Set to allow registration of new accounts using an email address. If set to false, you can still create accounts using the command line." - bind = "allow_email_registration:__FINALPATH__/config.json" + bind = "allow_email_registration:__INSTALL_DIR__/config.json" [main.config.allow_free_url] ask = "Allow new note creation" @@ -37,7 +37,7 @@ name = "HedgeDoc configuration" yes = "true" no = "false" help = "Set to allow new note creation by accessing a nonexistent note URL. This is the behavior familiar from Etherpad." - bind = "allow_free_url:__FINALPATH__/config.json" + bind = "allow_free_url:__INSTALL_DIR__/config.json" [main.config.require_free_url_authentication] ask = "Require FreeURL authentication" @@ -45,7 +45,7 @@ name = "HedgeDoc configuration" yes = "true" no = "false" help = "Set to require authentication for FreeURL mode style note creation." - bind = "require_free_url_authentication:__FINALPATH__/config.json" + bind = "require_free_url_authentication:__INSTALL_DIR__/config.json" diff --git a/config_panel.toml.example b/config_panel.toml.example deleted file mode 100644 index e784143..0000000 --- a/config_panel.toml.example +++ /dev/null @@ -1,24 +0,0 @@ -version = "1.0" - -[main] -name = "HedgeDoc configuration" - - [main.config] - name = "Configuration Options" - - [main.config.allow_anonymous] - ask = "Allow anonymous usage" - type = "boolean" - yes = "true" - no = "false" - help = "Set to allow anonymous usage (default is true)." - bind = "allow_anonymous:__FINALPATH__/config.json" - - [main.config.allow_email_registration] - ask = "Allow email registration" - type = "boolean" - yes = "true" - no = "false" - help = "Set to allow registration of new accounts using an email address. If set to false, you can still create accounts using the command line." - bind = "allow_email_registration:__FINALPATH__/config.json" - diff --git a/doc/ADMIN.md b/doc/ADMIN.md new file mode 100644 index 0000000..7ae98e7 --- /dev/null +++ b/doc/ADMIN.md @@ -0,0 +1,4 @@ +## Configuration + +You can configure HedgeDoc by editing this file `__INSTALL_DIR__/config.json` using the [documentation](https://github.com/hedgedoc/hedgedoc/blob/master/docs/configuration.md) +When you finished editing the configuration, for your changes to take effect, you will have to run: `sudo systemctl restart hedgedoc`. diff --git a/doc/ADMIN_fr.md b/doc/ADMIN_fr.md new file mode 100644 index 0000000..331dbd2 --- /dev/null +++ b/doc/ADMIN_fr.md @@ -0,0 +1,4 @@ +## Configuration + +Vous pouvez configurer HedgeDoc en modifiant le fichier `__INSTALL_DIR__/config.json` et en vous aidant de la [documentation](https://github.com/hedgedoc/hedgedoc/blob/master/docs/configuration.md) +Lorsque vous avez terminé de modifier la configuration, pour que vos modifications prennent effet, vous devrez exécuter : `sudo systemctl restart hedgedoc`. diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md deleted file mode 100644 index 2314b9b..0000000 --- a/doc/DISCLAIMER.md +++ /dev/null @@ -1,4 +0,0 @@ -## Configuration - -You can configure HedgeDoc by editing this file `/var/www/hedgedoc/config.json` using the [documentation](https://github.com/hedgedoc/hedgedoc/blob/master/docs/configuration.md) -When you finished editing the configuration, for your changes to take effect, you will have to run: `sudo systemctl restart hedgedoc`. diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md deleted file mode 100644 index aefa446..0000000 --- a/doc/DISCLAIMER_fr.md +++ /dev/null @@ -1,4 +0,0 @@ -## Configuration - -Vous pouvez configurer HedgeDoc en modifiant le fichier `/var/www/hedgedoc/config.json` et en vous aidant de la [documentation](https://github.com/hedgedoc/hedgedoc/blob/master/docs/configuration.md) -Lorsque vous avez terminé de modifier la configuration, pour que vos modifications prennent effet, vous devrez exécuter : `sudo systemctl restart hedgedoc`. diff --git a/manifest.json b/manifest.json deleted file mode 100644 index be5e979..0000000 --- a/manifest.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "name": "HedgeDoc", - "id": "hedgedoc", - "packaging_format": 1, - "description": { - "en": "Collaborative editor to work on notes written in Markdown", - "fr": "Éditeur collaboratif pour travailler sur des notes en Markdown" - }, - "version": "1.9.7~ynh2", - "url": "https://hedgedoc.org", - "upstream": { - "license": "AGPL-3.0-only", - "website": "https://hedgedoc.org", - "demo": "https://demo.hedgedoc.org/", - "admindoc": "https://docs.hedgedoc.org/", - "code": "https://github.com/hedgedoc/hedgedoc" - }, - "license": "AGPL-3.0-only", - "maintainer": { - "name": "eric_G" - }, - "requirements": { - "yunohost": ">= 11.1.11" - }, - "multi_instance": true, - "services": [ - "nginx" - ], - "arguments": { - "install" : [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "path", - "type": "path", - "example": "/hedgedoc", - "default": "/hedgedoc" - }, - { - "name": "is_public", - "type": "boolean", - "help": { - "en": "If enabled, HedgeDoc will be accessible by people who do not have an account. This can be changed later via the webadmin.", - "fr": "Si cette case est cochée, HedgeDoc sera accessible aux personnes n’ayant pas de compte. Vous pourrez changer ceci plus tard via la webadmin." - }, - "default": true - } - ] - } -} diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..c8d75f4 --- /dev/null +++ b/manifest.toml @@ -0,0 +1,69 @@ +packaging_format = 2 + +id = "hedgedoc" +name = "HedgeDoc" +description.en = "Collaborative editor to work on notes written in Markdown" +description.fr = "Éditeur collaboratif pour travailler sur des notes en Markdown" + +version = "1.9.7~ynh3" + +maintainers = ["eric_G"] + +[upstream] +license = "AGPL-3.0-only" +website = "https://hedgedoc.org" +demo = "https://demo.hedgedoc.org/" +admindoc = "https://docs.hedgedoc.org/" +code = "https://github.com/hedgedoc/hedgedoc" + +[integration] +yunohost = ">= 11.1.16" +architectures = "all" +multi_instance = true +ldap = true +sso = true +disk = "50M" +ram.build = "2500M" +ram.runtime = "50M" + +[install] + [install.domain] + type = "domain" + + [install.path] + type = "path" + default = "/hedgedoc" + + [install.init_main_permission] + help.en = "If enabled, HedgeDoc will be accessible by people who do not have an account. This can be changed later via the webadmin." + help.fr = "Si cette case est cochée, HedgeDoc sera accessible aux personnes n’ayant pas de compte. Vous pourrez changer ceci plus tard via la webadmin." + type = "group" + default = "visitors" + +[resources] + + [resources.sources] + + [resources.sources.main] + url = "https://github.com/hedgedoc/hedgedoc/releases/download/1.9.7/hedgedoc-1.9.7.tar.gz" + sha256 = "c9bd99c65cf45fa1d7808855b46abbfa13b24400254d8da5e81dae2965494bb3" + autoupdate.strategy = "latest_github_tag" + + [resources.ports] + + [resources.system_user] + + [resources.install_dir] + + [resources.permissions] + main.url = "/" + + [resources.apt] + packages = "postgresql" + + extras.yarn.repo = "deb https://dl.yarnpkg.com/debian/ stable main" + extras.yarn.key = "https://dl.yarnpkg.com/debian/pubkey.gpg" + extras.yarn.packages = "yarn" + + [resources.database] + type = "postgresql" diff --git a/scripts/_common.sh b/scripts/_common.sh index 7f17471..b818f0f 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -4,9 +4,6 @@ # COMMON VARIABLES #================================================= -# dependencies used by the app -pkg_dependencies="postgresql" - nodejs_version=16 #================================================= diff --git a/scripts/backup b/scripts/backup index 8d4d217..5472aff 100644 --- a/scripts/backup +++ b/scripts/backup @@ -9,27 +9,6 @@ source ../settings/scripts/_common.sh 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 - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_print_info --message="Loading installation settings..." - -app=$YNH_APP_INSTANCE_NAME - -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -domain=$(ynh_app_setting_get --app=$app --key=domain) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) - #================================================= # DECLARE DATA AND CONF FILES TO BACKUP #================================================= @@ -39,7 +18,7 @@ ynh_print_info --message="Declaring files to be backed up..." # BACKUP THE APP MAIN DIR #================================================= -ynh_backup --src_path="$final_path" +ynh_backup --src_path="$install_dir" #================================================= # BACKUP THE NGINX CONFIGURATION diff --git a/scripts/change_url b/scripts/change_url index 945e228..85e7e6c 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,69 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# RETRIEVE ARGUMENTS -#================================================= - -old_domain=$YNH_APP_OLD_DOMAIN -old_path=$YNH_APP_OLD_PATH - -new_domain=$YNH_APP_NEW_DOMAIN -new_path=$YNH_APP_NEW_PATH - -app=$YNH_APP_INSTANCE_NAME - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -# Needed for helper "ynh_add_nginx_config" -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=psqlpwd) - -allow_anonymous=$(ynh_app_setting_get --app=$app --key=allow_anonymous) -allow_anonymous_edits=$(ynh_app_setting_get --app=$app --key=allow_anonymous_edits) -allow_email_registration=$(ynh_app_setting_get --app=$app --key=allow_email_registration) -allow_free_url=$(ynh_app_setting_get --app=$app --key=allow_free_url) -require_free_url_authentication=$(ynh_app_setting_get --app=$app --key=require_free_url_authentication) - -#================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up HedgeDoc before changing its URL (may take a while)..." --weight=1 - -# Backup the current version of the app -ynh_backup_before_upgrade -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 - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# CHECK WHICH PARTS SHOULD BE CHANGED -#================================================= - -change_domain=0 -if [ "$old_domain" != "$new_domain" ] -then - change_domain=1 -fi - -change_path=0 -if [ "$old_path" != "$new_path" ] -then - change_path=1 -fi - #================================================= # STANDARD MODIFICATIONS #================================================= @@ -86,29 +23,7 @@ ynh_systemd_action --service_name=$app --action=stop --log_path=systemd #================================================= ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1 -nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf - -# Change the path in the NGINX config file -if [ $change_path -eq 1 ] -then - # Make a backup of the original NGINX config file if modified - ynh_backup_if_checksum_is_different --file="$nginx_conf_path" - # Set global variables for NGINX helper - domain="$old_domain" - path_url="$new_path" - # Create a dedicated NGINX config - ynh_add_nginx_config -fi - -# Change the domain for NGINX -if [ $change_domain -eq 1 ] -then - # Delete file checksum for the old conf file location - ynh_delete_file_checksum --file="$nginx_conf_path" - mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf - # Store file checksum for the new config file location - ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" -fi +ynh_change_url_nginx_config #================================================= # SPECIFIC MODIFICATIONS @@ -116,15 +31,15 @@ fi # CONFIGURE HEDGEDOC #================================================= -ynh_backup_if_checksum_is_different --file="$final_path/config.json" +ynh_backup_if_checksum_is_different --file="$install_dir/config.json" domain=$new_domain url_path=${new_path#/} -ynh_add_config --template="../conf/config.json.example" --destination="$final_path/config.json" +ynh_add_config --template="../conf/config.json.example" --destination="$install_dir/config.json" -chmod 400 "$final_path/config.json" -chown $app:$app "$final_path/config.json" +chmod 400 "$install_dir/config.json" +chown $app:$app "$install_dir/config.json" #================================================= # GENERIC FINALISATION @@ -136,13 +51,6 @@ 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" -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/install b/scripts/install index cc2cda1..795873a 100644 --- a/scripts/install +++ b/scripts/install @@ -9,120 +9,58 @@ source _common.sh 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 - #================================================= # RETRIEVE ARGUMENTS FROM THE MANIFEST #================================================= -domain=$YNH_APP_ARG_DOMAIN -path_url=$YNH_APP_ARG_PATH -is_public=$YNH_APP_ARG_IS_PUBLIC - -app=$YNH_APP_INSTANCE_NAME - allow_anonymous=false allow_anonymous_edits=false allow_email_registration=false allow_free_url=false require_free_url_authentication=false -#================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS -#================================================= -ynh_script_progression --message="Validating installation parameters..." --weight=1 - -final_path=/var/www/$app -test ! -e "$final_path" || ynh_die --message="This path already contains a folder" - -# Register (book) web path -ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url - #================================================= # STORE SETTINGS FROM MANIFEST #================================================= -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=allow_anonymous --value=$allow_anonymous ynh_app_setting_set --app=$app --key=allow_email_registration --value=$allow_email_registration ynh_app_setting_set --app=$app --key=allow_free_url --value=$allow_free_url ynh_app_setting_set --app=$app --key=require_free_url_authentication --value=$require_free_url_authentication ynh_app_setting_set --app=$app --key=allow_anonymous_edits --value=$allow_anonymous_edits -#================================================= -# STANDARD MODIFICATIONS -#================================================= -# FIND AND OPEN A PORT -#================================================= -ynh_script_progression --message="Finding an available port..." --weight=2 - -# Find an available port -port=$(ynh_find_port --port=3000) -ynh_app_setting_set --app=$app --key=port --value=$port - #================================================= # INSTALL DEPENDENCIES #================================================= ynh_script_progression --message="Installing dependencies..." --weight=20 -ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies - # Install Nodejs ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version -# Install Yarn -ynh_install_extra_app_dependencies --repo="deb https://dl.yarnpkg.com/debian/ stable main" --package="yarn" --key="https://dl.yarnpkg.com/debian/pubkey.gpg" - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user..." --weight=2 - -# Create a system user -ynh_system_user_create --username=$app --home_dir=$final_path - -#================================================= -# CREATE A POSTGRESQL DATABASE -#================================================= -ynh_script_progression --message="Creating a PostgreSQL database..." --weight=2 - -db_name=$(ynh_sanitize_dbid --db_name=$app) -db_user=$db_name -ynh_app_setting_set --app=$app --key=db_name --value=$db_name -ynh_psql_test_if_first_run -ynh_psql_setup_db --db_user=$db_user --db_name=$db_name - #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Setting up source files..." --weight=2 -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 +ynh_setup_source --dest_dir=$install_dir -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= -# NGINX CONFIGURATION +# SYSTEM CONFIGURATION #================================================= -ynh_script_progression --message="Configuring NGINX web server..." --weight=2 +ynh_script_progression --message="Adding system configurations related to $app ..." --weight=1 # Create a dedicated NGINX config ynh_add_nginx_config +# Create a dedicated systemd config +ynh_add_systemd_config + +yunohost service add $app --description="Collaborative Markdown editor" --log="/var/log/$app/$app.log" + #================================================= # SPECIFIC SETUP #============================================== @@ -130,38 +68,22 @@ ynh_add_nginx_config #============================================== ynh_script_progression --message="Building HedgeDoc... (this will take some time and resources!)" --weight=20 -pushd "$final_path" +pushd "$install_dir" ynh_use_nodejs - #ynh_exec_warn_less sudo -u $app env $ynh_node_load_PATH yarn cache clean ynh_exec_warn_less sudo -u $app env $ynh_node_load_PATH yarn install --frozen-lockfile ynh_exec_warn_less sudo -u $app env $ynh_node_load_PATH yarn build popd -#================================================= -# SETUP SYSTEMD -#================================================= -ynh_script_progression --message="Configuring a systemd service..." --weight=1 - -# Create a dedicated systemd config -ynh_add_systemd_config - #================================================= # MODIFY A CONFIG FILE #================================================= ynh_script_progression --message="Modifying a config file..." --weight=1 -url_path=${path_url#/} -ynh_add_config --template="../conf/config.json.example" --destination="$final_path/config.json" +url_path=${path#/} +ynh_add_config --template="../conf/config.json.example" --destination="$install_dir/config.json" -chmod 600 "$final_path/config.json" -chown $app:$app "$final_path/config.json" - -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." --weight=2 - -yunohost service add $app --description="Collaborative Markdown editor" --log="/var/log/$app/$app.log" +chmod 600 "$install_dir/config.json" +chown $app:$app "$install_dir/config.json" #================================================= # START SYSTEMD SERVICE @@ -171,24 +93,6 @@ 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" -#================================================= -# SETUP SSOWAT -#================================================= -ynh_script_progression --message="Configuring permissions..." --weight=1 - -# Make app public if necessary or protect it -if [ $is_public -eq 1 ] -then - ynh_permission_update --permission="main" --add="visitors" -fi - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=2 - -ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/remove b/scripts/remove index 2e2045a..dbd13c5 100644 --- a/scripts/remove +++ b/scripts/remove @@ -9,18 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -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 - #================================================= # STANDARD REMOVE #================================================= @@ -42,32 +30,13 @@ ynh_script_progression --message="Stopping and removing the systemd service..." # Remove the dedicated systemd config ynh_remove_systemd_config -#================================================= -# REMOVE THE POSTGRESQL DATABASE -#================================================= -ynh_script_progression --message="Removing the PostgreSQL database..." --weight=2 - -# Remove a database if it exists, along with the associated user -ynh_psql_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_app_dependencies - ynh_remove_nodejs -#================================================= -# REMOVE APP MAIN DIR -#================================================= -ynh_script_progression --message="Removing $app main directory..." --weight=6 - -# Remove the app directory securely -ynh_secure_remove --file="$final_path" - #================================================= # REMOVE NGINX CONFIGURATION #================================================= @@ -76,16 +45,6 @@ ynh_script_progression --message="Removing NGINX web server configuration..." -- # Remove the dedicated NGINX config ynh_remove_nginx_config -#================================================= -# GENERIC FINALIZATION -#================================================= -# REMOVE DEDICATED USER -#================================================= -ynh_script_progression --message="Removing the dedicated system user..." --weight=1 - -# Delete a system user -ynh_system_user_delete --username=$app - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/restore b/scripts/restore index bb4d2a2..eee9898 100644 --- a/scripts/restore +++ b/scripts/restore @@ -9,38 +9,6 @@ source ../settings/scripts/_common.sh 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 - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -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=psqlpwd) - -#================================================= -# CHECK IF THE APP CAN BE RESTORED -#================================================= -ynh_script_progression --message="Validating restoration parameters..." --weight=2 - -test ! -d $final_path \ - || ynh_die --message="There is already a directory: $final_path " - #================================================= # STANDARD RESTORATION STEPS #================================================= @@ -50,24 +18,15 @@ ynh_script_progression --message="Restoring the NGINX configuration..." --weight ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" -#================================================= -# RECREATE THE DEDICATED USER -#================================================= -ynh_script_progression --message="Recreating the dedicated system user..." --weight=1 - -# Create the dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir=$final_path - #================================================= # RESTORE THE APP MAIN DIR #================================================= ynh_script_progression --message="Restoring HedgeDoc main directory..." --weight=10 -ynh_restore_file --origin_path="$final_path" +ynh_restore_file --origin_path="$install_dir" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= # SPECIFIC RESTORATION @@ -76,22 +35,14 @@ chown -R $app:www-data "$final_path" #================================================= ynh_script_progression --message="Reinstalling dependencies..." --weight=6 -# 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 -# Install Yarn -ynh_install_extra_app_dependencies --repo="deb https://dl.yarnpkg.com/debian/ stable main" --package="yarn" --key="https://dl.yarnpkg.com/debian/pubkey.gpg" - #================================================= # RESTORE THE POSTGRESQL DATABASE #================================================= ynh_script_progression --message="Restoring the PostgreSQL database..." --weight=6 -ynh_psql_test_if_first_run -ynh_psql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd ynh_psql_execute_file_as_root --file="./db.sql" --database=$db_name #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 874501f..fc592db 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -9,27 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=2 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -path_url=$(ynh_app_setting_get --app=$app --key=path) -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=psqlpwd) - -allow_anonymous=$(ynh_app_setting_get --app=$app --key=allow_anonymous) -allow_anonymous_edits=$(ynh_app_setting_get --app=$app --key=allow_anonymous_edits) -allow_email_registration=$(ynh_app_setting_get --app=$app --key=allow_email_registration) -allow_free_url=$(ynh_app_setting_get --app=$app --key=allow_free_url) -require_free_url_authentication=$(ynh_app_setting_get --app=$app --key=require_free_url_authentication) - #================================================= # CHECK VERSION #================================================= @@ -41,52 +20,31 @@ upgrade_type=$(ynh_check_app_version_changed) #================================================= ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 -if [ -z "$allow_anonymous" ]; then +if [ -z "${allow_anonymous:-}" ]; then allow_anonymous="false" ynh_app_setting_set --app=$app --key=allow_anonymous --value=$allow_anonymous fi -if [ -z "$allow_anonymous_edits" ]; then +if [ -z "${allow_anonymous_edits:-}" ]; then allow_anonymous_edits="false" ynh_app_setting_set --app=$app --key=allow_anonymous_edits --value=$allow_anonymous_edits fi -if [ -z "$allow_email_registration" ]; then +if [ -z "${allow_email_registration:-}" ]; then allow_email_registration="false" ynh_app_setting_set --app=$app --key=allow_email_registration --value=$allow_email_registration fi -if [ -z "$allow_free_url" ]; then +if [ -z "${allow_free_url:-}" ]; then allow_free_url="false" ynh_app_setting_set --app=$app --key=allow_free_url --value=$allow_free_url fi -if [ -z "$require_free_url_authentication" ]; then +if [ -z "${require_free_url_authentication:-}" ]; then require_free_url_authentication="false" ynh_app_setting_set --app=$app --key=require_free_url_authentication --value=$require_free_url_authentication fi -# Cleaning legacy permissions -if ynh_legacy_permissions_exists; then - ynh_legacy_permissions_delete_all - - ynh_app_setting_delete --app=$app --key=is_public -fi - -#================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up HedgeDoc before upgrading (may take a while)..." --weight=10 - -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - # restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - #================================================= # STANDARD UPGRADE STEPS #================================================= @@ -96,14 +54,6 @@ ynh_script_progression --message="Stopping a systemd service..." --weight=1 ynh_systemd_action --service_name=$app --action=stop --log_path=systemd -#================================================= -# 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 --home_dir=$final_path - #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= @@ -113,12 +63,11 @@ then ynh_script_progression --message="Upgrading source files..." --weight=10 # Download, check integrity, uncompress and patch the source from app.src - ynh_setup_source --dest_dir=$final_path --keep="config.json" + ynh_setup_source --dest_dir=$install_dir --keep="config.json" fi -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= # NGINX CONFIGURATION @@ -128,30 +77,21 @@ ynh_script_progression --message="Upgrading NGINX web server configuration..." - # Create a dedicated nginx config ynh_add_nginx_config -#================================================= -# UPGRADE DEPENDENCIES -#================================================= -ynh_script_progression --message="Upgrading dependencies..." --weight=10 - -ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies - # Install Nodejs ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version -# Install Yarn -ynh_install_extra_app_dependencies --repo="deb https://dl.yarnpkg.com/debian/ stable main" --package="yarn" --key="https://dl.yarnpkg.com/debian/pubkey.gpg" +# Create a dedicated systemd config +ynh_add_systemd_config -#================================================= -# SPECIFIC UPGRADE -#================================================= +#============================================== # INSTALL HEDGEDOC -#================================================= +#============================================== if [ "$upgrade_type" == "UPGRADE_APP" ] then ynh_script_progression --message="Building HedgeDoc... (this will take some time and resources!)" --weight=20 - pushd "$final_path" +pushd "$install_dir" ynh_secure_remove /usr/local/share/.cache/yarn ynh_use_nodejs ynh_exec_warn_less sudo -u $app env $ynh_node_load_PATH yarn install --frozen-lockfile @@ -159,14 +99,6 @@ then popd fi -#================================================= -# SETUP SYSTEMD -#================================================= -ynh_script_progression --message="Configuring a systemd service..." --weight=2 - -# Create a dedicated systemd config -ynh_add_systemd_config - #================================================= # INTEGRATE SERVICE IN YUNOHOST #================================================= @@ -181,13 +113,6 @@ 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" -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..f0b0313 --- /dev/null +++ b/tests.toml @@ -0,0 +1,9 @@ +test_format = 1.0 + +[default] + + # ------------------------------- + # Commits to test upgrade from + # ------------------------------- + + test_upgrade_from.f601a56a.name = "Upgrade from 1.9.7~ynh2"