From d3ddc2501471b3edf21361786b98c10a9a25031c Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Tue, 31 Oct 2023 14:33:51 +0000 Subject: [PATCH 01/13] Auto-update README --- README.md | 18 ++++++++++-------- README_fr.md | 32 +++++++++++++++++++------------- 2 files changed, 29 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 3b6455a..6e33e43 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ It shall NOT be edited by hand. # Scrumblr for YunoHost -[![Integration level](https://dash.yunohost.org/integration/scrumblr.svg)](https://dash.yunohost.org/appci/app/scrumblr) ![](https://ci-apps.yunohost.org/ci/badges/scrumblr.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/scrumblr.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/scrumblr.svg)](https://dash.yunohost.org/appci/app/scrumblr) ![Working status](https://ci-apps.yunohost.org/ci/badges/scrumblr.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/scrumblr.maintain.svg) + [![Install Scrumblr with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=scrumblr) *[Lire ce readme en français.](./README_fr.md)* @@ -23,24 +24,25 @@ scrumblr is a web-based simulation of a physical agile kanban board that support ## Screenshots -![](./doc/screenshots/post-it_demo.png) +![Screenshot of Scrumblr](./doc/screenshots/post-it_demo.png) ## Documentation and resources -* Official app website: http://www.scrumblr.ca/ -* Upstream app code repository: https://framagit.org/colibris/framemo -* YunoHost documentation for this app: https://yunohost.org/app_scrumblr -* Report a bug: https://github.com/YunoHost-Apps/scrumblr_ynh/issues +* Official app website: +* Upstream app code repository: +* YunoHost Store: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/scrumblr_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/scrumblr_ynh/tree/testing --debug or sudo yunohost app upgrade scrumblr -u https://github.com/YunoHost-Apps/scrumblr_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 8810627..53e8bef 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,15 +1,20 @@ + + # Scrumblr pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/scrumblr.svg)](https://dash.yunohost.org/appci/app/scrumblr) ![](https://ci-apps.yunohost.org/ci/badges/scrumblr.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/scrumblr.maintain.svg) +[![Niveau d’intégration](https://dash.yunohost.org/integration/scrumblr.svg)](https://dash.yunohost.org/appci/app/scrumblr) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/scrumblr.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/scrumblr.maintain.svg) + [![Installer Scrumblr avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=scrumblr) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer Scrumblr rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* +> *Ce package vous permet d’installer Scrumblr rapidement et simplement sur un serveur YunoHost. +Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.* -## Vue d'ensemble +## Vue d’ensemble scrumblr is a web-based simulation of a physical agile kanban board that supports real-time collaboration. it is built using node.js, websockets (using socket.io), CSS3, and jquery. @@ -17,26 +22,27 @@ scrumblr is a web-based simulation of a physical agile kanban board that support **Démo :** http://scrumblr.ca/ -## Captures d'écran +## Captures d’écran -![](./doc/screenshots/post-it_demo.png) +![Capture d’écran de Scrumblr](./doc/screenshots/post-it_demo.png) ## Documentations et ressources -* Site officiel de l'app : http://www.scrumblr.ca/ -* Dépôt de code officiel de l'app : https://framagit.org/colibris/framemo -* Documentation YunoHost pour cette app : https://yunohost.org/app_scrumblr -* Signaler un bug : https://github.com/YunoHost-Apps/scrumblr_ynh/issues +* Site officiel de l’app : +* Dépôt de code officiel de l’app : +* YunoHost Store: +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/scrumblr_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/scrumblr_ynh/tree/testing --debug ou sudo yunohost app upgrade scrumblr -u https://github.com/YunoHost-Apps/scrumblr_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d’infos sur le packaging d’applications :** \ No newline at end of file From f4cdf422c998bd2b5000945a574edb1bdf84709b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Sun, 17 Dec 2023 13:20:50 +0100 Subject: [PATCH 02/13] v2 --- conf/app.src | 5 --- conf/scrumblr_redis.service | 8 ++--- conf/systemd.service | 2 +- manifest.toml | 57 +++++++++++++++++++++++++++++ scripts/backup | 20 +++++------ scripts/change_url | 64 +++++++++++++++++---------------- scripts/install | 68 +++++++++++++++++------------------ scripts/remove | 20 +++++------ scripts/restore | 34 +++++++++--------- scripts/upgrade | 72 ++++++++++++++++++------------------- 10 files changed, 202 insertions(+), 148 deletions(-) delete mode 100644 conf/app.src create mode 100644 manifest.toml diff --git a/conf/app.src b/conf/app.src deleted file mode 100644 index f2cd28f..0000000 --- a/conf/app.src +++ /dev/null @@ -1,5 +0,0 @@ -SOURCE_URL=https://framagit.org/colibris/framemo/-/archive/d14b3167dfe413ca7db78283b70334100e82076f/framemo-d14b3167dfe413ca7db78283b70334100e82076f.tar.gz -SOURCE_SUM=f42433ee1e513a2881d00573d0ee5d9595bcee868a8ecbaf9b219d3811aa6943 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true diff --git a/conf/scrumblr_redis.service b/conf/scrumblr_redis.service index feaa0ae..fc6e282 100644 --- a/conf/scrumblr_redis.service +++ b/conf/scrumblr_redis.service @@ -6,10 +6,10 @@ After=network.target Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ -ExecStart=/usr/bin/redis-server __FINALPATH__/redis.conf +WorkingDirectory=__INSTALL_DIR__/ +ExecStart=/usr/bin/redis-server __INSTALL_DIR__/redis.conf ExecStop=/bin/kill -s TERM $MAINPID -PIDFile=__FINALPATH__/redis-server-__REDIS_PORT__.pid +PIDFile=__INSTALL_DIR__/redis-server-__REDIS_PORT__.pid TimeoutStopSec=0 Restart=always @@ -21,7 +21,7 @@ ProtectHome=yes #ReadOnlyDirectories=/ ReadWriteDirectories=-/var/lib/__APP__ ReadWriteDirectories=-/var/log/__APP__ -ReadWriteDirectories=-__FINALPATH__ +ReadWriteDirectories=-__INSTALL_DIR__ NoNewPrivileges=true CapabilityBoundingSet=CAP_SETGID CAP_SETUID CAP_SYS_RESOURCE diff --git a/conf/systemd.service b/conf/systemd.service index bff937c..ff4a8b3 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -6,7 +6,7 @@ Requires=redis-__APP__.service Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__ +WorkingDirectory=__INSTALL_DIR__ Environment="PATH=_PATH__" Environment="NODE_ENV=production" ExecStart=__YNH_NODE__ server.js --port=__PORT__ --baseurl=__PATH__ --redis localhost:__REDIS_PORT__ diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..50f2182 --- /dev/null +++ b/manifest.toml @@ -0,0 +1,57 @@ +packaging_format = 2 + +id = "scrumblr" +name = "Scrumblr" +description.en = "Software for post-it notes" +description.fr = "Application pour créer des post-it" + +version = "0.2.1~ynh2" + +maintainers = ["frju365", "oiseauroch"] + +[upstream] +license = "AGPL-3.0-only" +website = "http://www.scrumblr.ca/" +demo = "http://scrumblr.ca/" +code = "https://framagit.org/colibris/framemo" +cpe = "???" # FIXME: optional but recommended if relevant, this is meant to contain the Common Platform Enumeration, which is sort of a standard id for applications defined by the NIST. In particular, Yunohost may use this is in the future to easily track CVE (=security reports) related to apps. The CPE may be obtained by searching here: https://nvd.nist.gov/products/cpe/search. For example, for Nextcloud, the CPE is 'cpe:2.3:a:nextcloud:nextcloud' (no need to include the version number) +fund = "???" # FIXME: optional but recommended (or remove if irrelevant / not applicable). This is meant to be an URL where people can financially support this app, especially when its development is based on volunteers and/or financed by its community. YunoHost may later advertise it in the webadmin. + +[integration] +yunohost = ">> 4.3.0" +architectures = "all" # FIXME: can be replaced by a list of supported archs using the dpkg --print-architecture nomenclature (amd64/i386/armhf/arm64), for example: ["amd64", "i386"] +multi_instance = true +ldap = "?" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "sso" key : the "ldap" key corresponds to wether or not a user *can* login on the app using its YunoHost credentials. +sso = "?" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "ldap" key : the "sso" key corresponds to wether or not a user is *automatically logged-in* on the app when logged-in on the YunoHost portal. +disk = "50M" # FIXME: replace with an **estimate** minimum disk requirement. e.g. 20M, 400M, 1G, ... +ram.build = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ... +ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ... + +[install] + [install.domain] + # this is a generic question - ask strings are automatically handled by Yunohost's core + type = "domain" + + [install.path] + # this is a generic question - ask strings are automatically handled by Yunohost's core + type = "path" + default = "/scrumblr" + + [install.init_main_permission] + help.en = "If enabled, Scrumblr 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, Scrumblr 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.main] + url = "https://framagit.org/colibris/framemo/-/archive/d14b3167dfe413ca7db78283b70334100e82076f/framemo-d14b3167dfe413ca7db78283b70334100e82076f.tar.gz" + sha256 = "f42433ee1e513a2881d00573d0ee5d9595bcee868a8ecbaf9b219d3811aa6943" + + + [resources.system_user] + + [resources.install_dir] + + [resources.permissions] + main.url = "/" diff --git a/scripts/backup b/scripts/backup index 5ce4bc9..c037f3b 100644 --- a/scripts/backup +++ b/scripts/backup @@ -14,24 +14,24 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= -ynh_clean_setup () { +#REMOVEME? ynh_clean_setup () { ### Remove this function if there's nothing to clean before calling the remove script. true } # Exit if an error occurs during the execution of the script -ynh_abort_if_errors +#REMOVEME? ynh_abort_if_errors #================================================= # LOAD SETTINGS #================================================= -ynh_print_info --message="Loading installation settings..." +#REMOVEME? ynh_print_info --message="Loading installation settings..." -app=$YNH_APP_INSTANCE_NAME +#REMOVEME? 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) -redis_port=$(ynh_app_setting_get --app=$app --key=redis_port) -codename=$(ynh_app_setting_get $app codename) +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) +#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain) +#REMOVEME? redis_port=$(ynh_app_setting_get --app=$app --key=redis_port) +#REMOVEME? codename=$(ynh_app_setting_get $app codename) #================================================= # DECLARE DATA AND CONF FILES TO BACKUP @@ -43,13 +43,13 @@ ynh_print_info --message="Declaring files to be backed up..." # EXPORT DATABASE #================================================= -redis-cli --rdb "$final_path/redis-$app.rdb" -p $redis_port +redis-cli --rdb "$install_dir/redis-$app.rdb" -p $redis_port #================================================= # 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 feaf25f..12cd9b9 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -13,54 +13,54 @@ source /usr/share/yunohost/helpers # RETRIEVE ARGUMENTS #================================================= -old_domain=$YNH_APP_OLD_DOMAIN -old_path=$YNH_APP_OLD_PATH +#REMOVEME? old_domain=$YNH_APP_OLD_DOMAIN +#REMOVEME? old_path=$YNH_APP_OLD_PATH -new_domain=$YNH_APP_NEW_DOMAIN -new_path=$YNH_APP_NEW_PATH +#REMOVEME? new_domain=$YNH_APP_NEW_DOMAIN +#REMOVEME? new_path=$YNH_APP_NEW_PATH -app=$YNH_APP_INSTANCE_NAME +#REMOVEME? app=$YNH_APP_INSTANCE_NAME #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 +#REMOVEME? 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) +#REMOVEME? # Needed for helper "ynh_add_nginx_config" +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) +#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port) #================================================= # BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP #================================================= -ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=1 +#REMOVEME? ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=1 # Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { +#REMOVEME? ynh_backup_before_upgrade +#REMOVEME? 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" +#REMOVEME? ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" # Restore it if the upgrade fails - ynh_restore_upgradebackup +#REMOVEME? ynh_restore_upgradebackup } # Exit if an error occurs during the execution of the script -ynh_abort_if_errors +#REMOVEME? ynh_abort_if_errors #================================================= # CHECK WHICH PARTS SHOULD BE CHANGED #================================================= -change_domain=0 -if [ "$old_domain" != "$new_domain" ] +#REMOVEME? change_domain=0 +#REMOVEME? if [ "$old_domain" != "$new_domain" ] then - change_domain=1 + #REMOVEME? change_domain=1 fi -change_path=0 -if [ "$old_path" != "$new_path" ] +#REMOVEME? change_path=0 +#REMOVEME? if [ "$old_path" != "$new_path" ] then - change_path=1 + #REMOVEME? change_path=1 fi #================================================= @@ -77,28 +77,30 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app #================================================= ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1 -nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf +ynh_change_url_nginx_config + +#REMOVEME? 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" +#REMOVEME? ynh_backup_if_checksum_is_different --file="$nginx_conf_path" # Set global variables for NGINX helper - domain="$old_domain" - path_url="$new_path" +#REMOVEME? domain="$old_domain" +#REMOVEME? path="$new_path" # Create a dedicated NGINX config - ynh_add_nginx_config +#REMOVEME? 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 +#REMOVEME? ynh_delete_file_checksum --file="$nginx_conf_path" +#REMOVEME? 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" +#REMOVEME? ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" fi @@ -125,9 +127,9 @@ ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --lin #================================================= # RELOAD NGINX #================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 +#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=1 -ynh_systemd_action --service_name=nginx --action=reload +#REMOVEME? #REMOVEME? ynh_systemd_action --service_name=nginx --action=reload #================================================= # END OF SCRIPT diff --git a/scripts/install b/scripts/install index 2ccb1ed..5234aea 100644 --- a/scripts/install +++ b/scripts/install @@ -13,56 +13,56 @@ source /usr/share/yunohost/helpers # MANAGE FAILURE OF THE SCRIPT #================================================= -ynh_clean_setup () { +#REMOVEME? ynh_clean_setup () { true } # Exit if an error occurs during the execution of the script -ynh_abort_if_errors +#REMOVEME? 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 +#REMOVEME? domain=$YNH_APP_ARG_DOMAIN +#REMOVEME? path=$YNH_APP_ARG_PATH +#REMOVEME? is_public=$YNH_APP_ARG_IS_PUBLIC -app=$YNH_APP_INSTANCE_NAME +#REMOVEME? app=$YNH_APP_INSTANCE_NAME #================================================= # CHECK IF THE APP CAN BE INSTALLED WITH THIS ARGS #================================================= -ynh_script_progression --message="Validating installation parameters..." --weight=1 +#REMOVEME? 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" +#REMOVEME? install_dir=/var/www/$app +#REMOVEME? test ! -e "$install_dir" || ynh_die --message="This path already contains a folder" # Register (book) web path -ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url +#REMOVEME? ynh_webpath_register --app=$app --domain=$domain --path=$path #================================================= # STORE SETTINGS FROM MANIFEST #================================================= -ynh_script_progression --message="Storing installation settings..." --weight=1 +#REMOVEME? ynh_script_progression --message="Storing installation settings..." --weight=1 -ynh_app_setting_set --app=$app --key=domain --value=$domain -ynh_app_setting_set --app=$app --key=path --value=$path_url +#REMOVEME? ynh_app_setting_set --app=$app --key=domain --value=$domain +#REMOVEME? ynh_app_setting_set --app=$app --key=path --value=$path #================================================= # STANDARD MODIFICATIONS #================================================= # FIND AND OPEN A PORT #================================================= -ynh_script_progression --message="Finding an available port..." --weight=1 +#REMOVEME? ynh_script_progression --message="Finding an available port..." --weight=1 # Find an available port -port=$(ynh_find_port --port=8080) -ynh_app_setting_set --app=$app --key=port --value=$port +#REMOVEME? port=$(ynh_find_port --port=8080) +#REMOVEME? ynh_app_setting_set --app=$app --key=port --value=$port #================================================= # INSTALL NODEJS #================================================= -ynh_script_progression --message="Installing dependencies..." --weight=5 +#REMOVEME? ynh_script_progression --message="Installing dependencies..." --weight=5 ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version @@ -71,39 +71,39 @@ ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version #================================================= # CREATE DEDICATED USER #================================================= -ynh_script_progression --message="Configuring system user..." --weight=1 +#REMOVEME? ynh_script_progression --message="Configuring system user..." --weight=1 # Create a system user -ynh_system_user_create --username=$app --home_dir="$final_path" +#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Setting up source files..." --weight=5 -ynh_app_setting_set --app=$app --key=final_path --value=$final_path +#REMOVEME? ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir # 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" #================================================== # CONFIGURE REDIS SERVICE #================================================== -ynh_install_app_dependencies redis-server redis-tools +#REMOVEME? ynh_install_app_dependencies redis-server redis-tools # Find an available port for redis -redis_port=$(ynh_find_port --port=8081) -ynh_app_setting_set --app=$app --key=redis_port --value=$redis_port +#REMOVEME? redis_port=$(ynh_find_port --port=8081) +#REMOVEME? ynh_app_setting_set --app=$app --key=redis_port --value=$redis_port -ynh_add_config --template="redis.conf" --destination="$final_path/redis.conf" +ynh_add_config --template="redis.conf" --destination="$install_dir/redis.conf" redis_service="redis-$app" ynh_add_systemd_config --service $redis_service --template scrumblr_redis.service -chmod 770 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:$app "$final_path" +chmod 770 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:$app "$install_dir" #================================================= # NGINX CONFIGURATION #================================================= @@ -135,7 +135,7 @@ ynh_add_systemd_config # INSTALL SCRUMBLR #================================================= -pushd $final_path +pushd $install_dir ynh_use_nodejs ynh_exec_warn_less $ynh_npm install popd @@ -158,20 +158,20 @@ ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --lin #================================================= # Set Public or private #================================================= -ynh_script_progression --message="Configuring permissions..." --weight=1 +#REMOVEME? ynh_script_progression --message="Configuring permissions..." --weight=1 # Make app public if necessary or protect it -if [ $is_public -eq 1 ] +#REMOVEME? if [ $is_public -eq 1 ] then - ynh_permission_update --permission "main" --add "visitors" +#REMOVEME? ynh_permission_update --permission "main" --add "visitors" fi #================================================= # RELOAD NGINX #================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 +#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=1 -ynh_systemd_action --service_name=nginx --action=reload +#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload #================================================= # END OF SCRIPT diff --git a/scripts/remove b/scripts/remove index 62b39e1..b8db829 100644 --- a/scripts/remove +++ b/scripts/remove @@ -12,13 +12,13 @@ source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 +#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=1 -app=$YNH_APP_INSTANCE_NAME +#REMOVEME? 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) +#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain) +#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port) +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) #================================================= # STANDARD REMOVE @@ -63,7 +63,7 @@ ynh_secure_remove --file="/var/log/$app" #================================================= # REMOVE DEPENDENCIES #================================================= -ynh_script_progression --message="Removing dependencies..." --weight=2 +#REMOVEME? ynh_script_progression --message="Removing dependencies..." --weight=2 # Remove metapackage and its dependencies ynh_remove_nodejs @@ -75,10 +75,10 @@ ynh_remove_systemd_config --service="redis-$app" #================================================= # REMOVE APP MAIN DIR #================================================= -ynh_script_progression --message="Removing app main directory..." --weight=1 +#REMOVEME? ynh_script_progression --message="Removing app main directory..." --weight=1 # Remove the app directory securely -ynh_secure_remove --file="$final_path" +#REMOVEME? ynh_secure_remove --file="$install_dir" #================================================= # REMOVE NGINX CONFIGURATION @@ -93,10 +93,10 @@ ynh_remove_nginx_config #================================================= # REMOVE DEDICATED USER #================================================= -ynh_script_progression --message="Removing the dedicated system user..." --weight=1 +#REMOVEME? ynh_script_progression --message="Removing the dedicated system user..." --weight=1 # Delete a system user -ynh_system_user_delete --username=$app +#REMOVEME? ynh_system_user_delete --username=$app #================================================= # END OF SCRIPT diff --git a/scripts/restore b/scripts/restore index 62f167d..04f7e6a 100644 --- a/scripts/restore +++ b/scripts/restore @@ -14,30 +14,30 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= -ynh_clean_setup () { +#REMOVEME? ynh_clean_setup () { #### Remove this function if there's nothing to clean before calling the remove script. true } # Exit if an error occurs during the execution of the script -ynh_abort_if_errors +#REMOVEME? ynh_abort_if_errors #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 +#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=1 -app=$YNH_APP_INSTANCE_NAME +#REMOVEME? 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) +#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain) +#REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path) +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) #================================================= # CHECK IF THE APP CAN BE RESTORED #================================================= -ynh_script_progression --message="Validating restoration parameters..." --weight=1 +#REMOVEME? ynh_script_progression --message="Validating restoration parameters..." --weight=1 -test ! -d $final_path || ynh_die --message="There is already a directory: $final_path " +#REMOVEME? test ! -d $install_dir || ynh_die --message="There is already a directory: $install_dir " #================================================= # STANDARD RESTORATION STEPS @@ -51,24 +51,24 @@ 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 +#REMOVEME? 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" +#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir" #================================================= # RESTORE THE APP MAIN DIR #================================================= ynh_script_progression --message="Restoring the app main directory..." --weight=1 -ynh_restore_file --origin_path="$final_path" +ynh_restore_file --origin_path="$install_dir" #================================================= # SPECIFIC RESTORATION #================================================= # REINSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Reinstalling dependencies..." --weight=5 +#REMOVEME? ynh_script_progression --message="Reinstalling dependencies..." --weight=5 ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version @@ -85,14 +85,14 @@ systemctl enable $app.service --quiet #================================================= ynh_script_progression --message="Restoring the redis configuration..." --weight=1 -ynh_install_app_dependencies redis-server redis-tools +#REMOVEME? ynh_install_app_dependencies redis-server redis-tools ynh_restore_file --origin_path="/etc/systemd/system/redis-$app.service" systemctl enable "redis-$app.service" --quiet -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:$app "$final_path" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:$app "$install_dir" #================================================= # RESTORE THE LOGROTATE CONFIGURATION diff --git a/scripts/upgrade b/scripts/upgrade index 8a0c8aa..01b175c 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -12,21 +12,21 @@ source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 +#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=1 -app=$YNH_APP_INSTANCE_NAME +#REMOVEME? 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) +#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain) +#REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path) +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) +#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port) if ynh_compare_current_package_version --comparison gt --version 0.2.0~ynh1 then - redis_port=$(ynh_app_setting_get --app=$app --key=redis_port) +#REMOVEME? redis_port=$(ynh_app_setting_get --app=$app --key=redis_port) else - redis_port=$(ynh_find_port --port=8081) - ynh_app_setting_set --app=$app --key=redis_port --value=$redis_port +#REMOVEME? redis_port=$(ynh_find_port --port=8081) +#REMOVEME? ynh_app_setting_set --app=$app --key=redis_port --value=$redis_port fi #================================================= @@ -35,21 +35,21 @@ fi upgrade_type=$(ynh_check_app_version_changed) -ynh_install_app_dependencies redis-server redis-tools +#REMOVEME? ynh_install_app_dependencies redis-server redis-tools #================================================= # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP #================================================= -ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=1 +#REMOVEME? ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=1 # Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { +#REMOVEME? ynh_backup_before_upgrade +#REMOVEME? ynh_clean_setup () { # Restore it if the upgrade fails - ynh_restore_upgradebackup +#REMOVEME? ynh_restore_upgradebackup } # Exit if an error occurs during the execution of the script -ynh_abort_if_errors +#REMOVEME? ynh_abort_if_errors #================================================= # STANDARD UPGRADE STEPS @@ -63,7 +63,7 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app if $(ynh_compare_current_package_version --comparison gt --version "0.2.0~ynh1") then # save redis db - pushd $final_path + pushd $install_dir redis-cli --rdb "/tmp/redis-$app.rdb" -p $redis_port popd @@ -74,15 +74,15 @@ fi #================================================= ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 -# If final_path doesn't exist, create it -if [ -z "$final_path" ]; then - final_path=/var/www/$app - ynh_app_setting_set --app=$app --key=final_path --value=$final_path +# If install_dir doesn't exist, create it +if [ -z "$install_dir" ]; then +#REMOVEME? install_dir=/var/www/$app +#REMOVEME? ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir fi # Cleaning legacy permissions -if ynh_legacy_permissions_exists; then - ynh_legacy_permissions_delete_all +#REMOVEME? if ynh_legacy_permissions_exists; then +#REMOVEME? ynh_legacy_permissions_delete_all ynh_app_setting_delete --app=$app --key=is_public fi @@ -90,10 +90,10 @@ fi #================================================= # CREATE DEDICATED USER #================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1 +#REMOVEME? 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" +#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE @@ -103,20 +103,20 @@ if [ "$upgrade_type" == "UPGRADE_APP" ] then ynh_script_progression --message="Upgrading source files..." --weight=1 - ynh_secure_remove --file="$final_path" +#REMOVEME? ynh_secure_remove --file="$install_dir" # 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" # restore db backup if $(ynh_compare_current_package_version --comparison gt --version "0.2.0~ynh1") then - mv /tmp/redis-$app.rdb $final_path/redis-$app.rdb + mv /tmp/redis-$app.rdb $install_dir/redis-$app.rdb fi fi if [ "$upgrade_type" == "UPGRADE_APP" ] then - pushd $final_path + pushd $install_dir ynh_use_nodejs ynh_exec_warn_less $ynh_npm install popd @@ -133,7 +133,7 @@ echo "$(ynh_package_version --package=srumblr)" if $(ynh_compare_current_package_version --comparison lt --version "0.2.0~ynh2") then - pushd $final_path + pushd $install_dir redis-cli --rdb "redis-$app.rdb" popd fi @@ -143,14 +143,14 @@ fi #================================================= -ynh_add_config --template="redis.conf" --destination="$final_path/redis.conf" +ynh_add_config --template="redis.conf" --destination="$install_dir/redis.conf" redis_service="redis-$app" ynh_add_systemd_config --service $redis_service --template "scrumblr_redis.service" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:$app "$final_path" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:$app "$install_dir" #================================================= @@ -164,7 +164,7 @@ ynh_add_nginx_config #================================================= # UPGRADE DEPENDENCIES #================================================= -ynh_script_progression --message="Upgrading dependencies..." --weight=5 +#REMOVEME? ynh_script_progression --message="Upgrading dependencies..." --weight=5 ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version @@ -205,9 +205,9 @@ ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --lin #================================================= # RELOAD NGINX #================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 +#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=1 -ynh_systemd_action --service_name=nginx --action=reload +#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload #================================================= # END OF SCRIPT From 11000da74b24fd3aa11286b72dab24743fdb8859 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Sun, 17 Dec 2023 13:29:20 +0100 Subject: [PATCH 03/13] v2 --- conf/nginx.conf | 4 +- conf/systemd.service | 2 +- manifest.json | 55 ---------------------- manifest.toml | 28 +++++++----- scripts/backup | 26 ----------- scripts/change_url | 86 ----------------------------------- scripts/install | 106 ++----------------------------------------- scripts/remove | 63 ------------------------- scripts/restore | 82 +++------------------------------ scripts/upgrade | 97 +-------------------------------------- 10 files changed, 30 insertions(+), 519 deletions(-) delete mode 100644 manifest.json diff --git a/conf/nginx.conf b/conf/nginx.conf index 083b591..9b31951 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,4 +1,6 @@ location __PATH__/ { + + proxy_pass http://127.0.0.1:__PORT____PATH__/; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $remote_addr; proxy_set_header X-Forwarded-Proto $scheme; @@ -8,6 +10,4 @@ location __PATH__/ { proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection $connection_upgrade; - - proxy_pass http://localhost:__PORT____PATH__/; } diff --git a/conf/systemd.service b/conf/systemd.service index ff4a8b3..8917d0f 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -9,7 +9,7 @@ Group=__APP__ WorkingDirectory=__INSTALL_DIR__ Environment="PATH=_PATH__" Environment="NODE_ENV=production" -ExecStart=__YNH_NODE__ server.js --port=__PORT__ --baseurl=__PATH__ --redis localhost:__REDIS_PORT__ +ExecStart=__YNH_NODE__ server.js --port=__PORT__ --baseurl=__PATH__ --redis localhost:__PORT_REDIS__ Restart=always # Sandboxing options to harden security diff --git a/manifest.json b/manifest.json deleted file mode 100644 index 0a94081..0000000 --- a/manifest.json +++ /dev/null @@ -1,55 +0,0 @@ -{ - "name": "Scrumblr", - "id": "scrumblr", - "packaging_format": 1, - "description": { - "en": "Software for post-it notes", - "fr": "Application pour créer des post-it" - }, - "version": "0.2.1~ynh2", - "url": "http://www.scrumblr.ca/", - "upstream": { - "license": "AGPL-3.0-only", - "website": "http://www.scrumblr.ca/", - "demo": "http://scrumblr.ca/", - "code": "https://framagit.org/colibris/framemo" - }, - "license": "AGPL-3.0-only", - "maintainer": [{ - "name": "frju365", - "email": "win10@tutanota.com" - }, - { "name": "oiseauroch", - "email": "tobias.ollive@oiseauroch.fr" - }], - "requirements": { - "yunohost": ">> 4.3.0" - }, - "multi_instance": true, - "services": [ - "nginx" - ], - "arguments": { - "install" : [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "path", - "type": "path", - "example": "/scrumblr", - "default": "/scrumblr" - }, - { - "name": "is_public", - "type": "boolean", - "help": { - "en": "If enabled, Scrumblr 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, Scrumblr 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 index 50f2182..c5c18b4 100644 --- a/manifest.toml +++ b/manifest.toml @@ -14,26 +14,25 @@ license = "AGPL-3.0-only" website = "http://www.scrumblr.ca/" demo = "http://scrumblr.ca/" code = "https://framagit.org/colibris/framemo" -cpe = "???" # FIXME: optional but recommended if relevant, this is meant to contain the Common Platform Enumeration, which is sort of a standard id for applications defined by the NIST. In particular, Yunohost may use this is in the future to easily track CVE (=security reports) related to apps. The CPE may be obtained by searching here: https://nvd.nist.gov/products/cpe/search. For example, for Nextcloud, the CPE is 'cpe:2.3:a:nextcloud:nextcloud' (no need to include the version number) -fund = "???" # FIXME: optional but recommended (or remove if irrelevant / not applicable). This is meant to be an URL where people can financially support this app, especially when its development is based on volunteers and/or financed by its community. YunoHost may later advertise it in the webadmin. [integration] -yunohost = ">> 4.3.0" -architectures = "all" # FIXME: can be replaced by a list of supported archs using the dpkg --print-architecture nomenclature (amd64/i386/armhf/arm64), for example: ["amd64", "i386"] +yunohost = ">> 11.2" +architectures = "all" multi_instance = true -ldap = "?" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "sso" key : the "ldap" key corresponds to wether or not a user *can* login on the app using its YunoHost credentials. -sso = "?" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "ldap" key : the "sso" key corresponds to wether or not a user is *automatically logged-in* on the app when logged-in on the YunoHost portal. -disk = "50M" # FIXME: replace with an **estimate** minimum disk requirement. e.g. 20M, 400M, 1G, ... -ram.build = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ... -ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ... + +ldap = false + +sso = false + +disk = "50M" +ram.build = "50M" +ram.runtime = "50M" [install] [install.domain] - # this is a generic question - ask strings are automatically handled by Yunohost's core type = "domain" [install.path] - # this is a generic question - ask strings are automatically handled by Yunohost's core type = "path" default = "/scrumblr" @@ -48,10 +47,15 @@ ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requiremen url = "https://framagit.org/colibris/framemo/-/archive/d14b3167dfe413ca7db78283b70334100e82076f/framemo-d14b3167dfe413ca7db78283b70334100e82076f.tar.gz" sha256 = "f42433ee1e513a2881d00573d0ee5d9595bcee868a8ecbaf9b219d3811aa6943" - [resources.system_user] [resources.install_dir] + [resources.ports] + redis.main = 8081 + [resources.permissions] main.url = "/" + + [resources.apt] + packages = "redis-server, redis-tools" diff --git a/scripts/backup b/scripts/backup index c037f3b..22e9b93 100644 --- a/scripts/backup +++ b/scripts/backup @@ -10,35 +10,11 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -#REMOVEME? ynh_clean_setup () { - ### Remove this function if there's nothing to clean before calling the remove script. - true -} -# Exit if an error occurs during the execution of the script -#REMOVEME? ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -#REMOVEME? ynh_print_info --message="Loading installation settings..." - -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - -#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) -#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain) -#REMOVEME? redis_port=$(ynh_app_setting_get --app=$app --key=redis_port) -#REMOVEME? codename=$(ynh_app_setting_get $app codename) - #================================================= # DECLARE DATA AND CONF FILES TO BACKUP #================================================= ynh_print_info --message="Declaring files to be backed up..." - #================================================= # EXPORT DATABASE #================================================= @@ -57,8 +33,6 @@ ynh_backup --src_path="$install_dir" ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" -#================================================= -# SPECIFIC BACKUP #================================================= # BACKUP LOGROTATE #================================================= diff --git a/scripts/change_url b/scripts/change_url index 12cd9b9..c6f5a1f 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,60 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# RETRIEVE ARGUMENTS -#================================================= - -#REMOVEME? old_domain=$YNH_APP_OLD_DOMAIN -#REMOVEME? old_path=$YNH_APP_OLD_PATH - -#REMOVEME? new_domain=$YNH_APP_NEW_DOMAIN -#REMOVEME? new_path=$YNH_APP_NEW_PATH - -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - -#================================================= -# LOAD SETTINGS -#================================================= -#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=1 - -#REMOVEME? # Needed for helper "ynh_add_nginx_config" -#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) -#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port) - -#================================================= -# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP -#================================================= -#REMOVEME? ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=1 - -# Backup the current version of the app -#REMOVEME? ynh_backup_before_upgrade -#REMOVEME? ynh_clean_setup () { - # Remove the new domain config file, the remove script won't do it as it doesn't know yet its location. -#REMOVEME? ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" - - # Restore it if the upgrade fails -#REMOVEME? ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -#REMOVEME? ynh_abort_if_errors - -#================================================= -# CHECK WHICH PARTS SHOULD BE CHANGED -#================================================= - -#REMOVEME? change_domain=0 -#REMOVEME? if [ "$old_domain" != "$new_domain" ] -then - #REMOVEME? change_domain=1 -fi - -#REMOVEME? change_path=0 -#REMOVEME? if [ "$old_path" != "$new_path" ] -then - #REMOVEME? change_path=1 -fi - #================================================= # STANDARD MODIFICATIONS #================================================= @@ -79,31 +25,6 @@ ynh_script_progression --message="Updating NGINX web server configuration..." -- ynh_change_url_nginx_config -#REMOVEME? 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 -#REMOVEME? ynh_backup_if_checksum_is_different --file="$nginx_conf_path" - # Set global variables for NGINX helper -#REMOVEME? domain="$old_domain" -#REMOVEME? path="$new_path" - # Create a dedicated NGINX config -#REMOVEME? 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 -#REMOVEME? ynh_delete_file_checksum --file="$nginx_conf_path" -#REMOVEME? mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf - # Store file checksum for the new config file location -#REMOVEME? ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" -fi - - #================================================= # CHANGE SYSTEMD SERVICE #================================================= @@ -124,13 +45,6 @@ ynh_script_progression --message="Starting a systemd service..." --weight=5 ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="Server running at" -#================================================= -# RELOAD NGINX -#================================================= -#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -#REMOVEME? #REMOVEME? ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/install b/scripts/install index 5234aea..53d90e8 100644 --- a/scripts/install +++ b/scripts/install @@ -9,80 +9,18 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE FAILURE OF THE SCRIPT -#================================================= - -#REMOVEME? ynh_clean_setup () { - true -} -# Exit if an error occurs during the execution of the script -#REMOVEME? ynh_abort_if_errors - -#================================================= -# RETRIEVE ARGUMENTS FROM THE MANIFEST -#================================================= - -#REMOVEME? domain=$YNH_APP_ARG_DOMAIN -#REMOVEME? path=$YNH_APP_ARG_PATH -#REMOVEME? is_public=$YNH_APP_ARG_IS_PUBLIC - -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - -#================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THIS ARGS -#================================================= -#REMOVEME? ynh_script_progression --message="Validating installation parameters..." --weight=1 - -#REMOVEME? install_dir=/var/www/$app -#REMOVEME? test ! -e "$install_dir" || ynh_die --message="This path already contains a folder" - -# Register (book) web path -#REMOVEME? ynh_webpath_register --app=$app --domain=$domain --path=$path - -#================================================= -# STORE SETTINGS FROM MANIFEST -#================================================= -#REMOVEME? ynh_script_progression --message="Storing installation settings..." --weight=1 - -#REMOVEME? ynh_app_setting_set --app=$app --key=domain --value=$domain -#REMOVEME? ynh_app_setting_set --app=$app --key=path --value=$path - -#================================================= -# STANDARD MODIFICATIONS -#================================================= -# FIND AND OPEN A PORT -#================================================= -#REMOVEME? ynh_script_progression --message="Finding an available port..." --weight=1 - -# Find an available port -#REMOVEME? port=$(ynh_find_port --port=8080) -#REMOVEME? ynh_app_setting_set --app=$app --key=port --value=$port - #================================================= # INSTALL NODEJS #================================================= -#REMOVEME? ynh_script_progression --message="Installing dependencies..." --weight=5 +ynh_script_progression --message="Installing dependencies..." --weight=5 ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version - - -#================================================= -# CREATE DEDICATED USER -#================================================= -#REMOVEME? ynh_script_progression --message="Configuring system user..." --weight=1 - -# Create a system user -#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir" - #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Setting up source files..." --weight=5 -#REMOVEME? ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir -# Download, check integrity, uncompress and patch the source from app.src ynh_setup_source --dest_dir="$install_dir" #================================================== @@ -104,33 +42,22 @@ ynh_add_systemd_config --service $redis_service --template scrumblr_redis.servic chmod 770 "$install_dir" chmod -R o-rwx "$install_dir" chown -R $app:$app "$install_dir" + #================================================= # NGINX CONFIGURATION #================================================= ynh_script_progression --message="Configuring NGINX web server..." --weight=1 -# Create a dedicated NGINX config ynh_add_nginx_config -#================================================= -# SPECIFIC SETUP -#================================================= -# HANDLE LOG FILES AND LOGROTATE -#================================================= -ynh_script_progression --message="Configuring log rotation..." --weight=1 - -# Use logrotate to manage application logfile(s) ynh_use_logrotate chown -R $app:$app "/var/log/$app/" -#================================================= -# SETUP SYSTEMD -#================================================= -ynh_script_progression --message="Configuring a systemd service..." --weight=1 - ynh_add_systemd_config +yunohost service add $app --description="Software for notes" --log="/var/log/$app/$app.log" + #================================================= # INSTALL SCRUMBLR #================================================= @@ -140,13 +67,6 @@ pushd $install_dir ynh_exec_warn_less $ynh_npm install popd -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 - -yunohost service add $app --description="Software for notes" --log="/var/log/$app/$app.log" - #================================================= # START SYSTEMD SERVICE #================================================= @@ -155,24 +75,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="Server running at " -#================================================= -# Set Public or private -#================================================= -#REMOVEME? ynh_script_progression --message="Configuring permissions..." --weight=1 - -# Make app public if necessary or protect it -#REMOVEME? if [ $is_public -eq 1 ] -then -#REMOVEME? ynh_permission_update --permission "main" --add "visitors" -fi - -#================================================= -# RELOAD NGINX -#================================================= -#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/remove b/scripts/remove index b8db829..8688c04 100644 --- a/scripts/remove +++ b/scripts/remove @@ -9,95 +9,32 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=1 - -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - -#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain) -#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port) -#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) - #================================================= # STANDARD REMOVE #================================================= # REMOVE SERVICE INTEGRATION IN YUNOHOST #================================================= -# 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..." --weight=1 yunohost service remove $app fi -#================================================= -# STOP AND REMOVE SERVICE -#================================================= -ynh_script_progression --message="Stopping and removing the systemd service..." --weight=2 - -# Remove the dedicated systemd config ynh_remove_systemd_config ynh_remove_systemd_config --service="redis-$app" - - -#================================================= -# REMOVE LOGROTATE CONFIGURATION -#================================================= -ynh_script_progression --message="Removing logrotate configuration..." --weight=1 - -# Remove the app-specific logrotate config ynh_remove_logrotate -#================================================= -# REMOVE LOG DIR -#================================================= -ynh_script_progression --message="Removing log dir..." --weight=1 - ynh_secure_remove --file="/var/log/$app" -#================================================= -# REMOVE DEPENDENCIES -#================================================= -#REMOVEME? ynh_script_progression --message="Removing dependencies..." --weight=2 - -# Remove metapackage and its dependencies ynh_remove_nodejs -ynh_script_progression --message="Removing redis service" --weight=2 - ynh_remove_systemd_config --service="redis-$app" -#================================================= -# REMOVE APP MAIN DIR -#================================================= -#REMOVEME? ynh_script_progression --message="Removing app main directory..." --weight=1 - -# Remove the app directory securely -#REMOVEME? ynh_secure_remove --file="$install_dir" - -#================================================= -# REMOVE NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1 - -# Remove the dedicated NGINX config ynh_remove_nginx_config -#================================================= -# GENERIC FINALIZATION -#================================================= -# REMOVE DEDICATED USER -#================================================= -#REMOVEME? ynh_script_progression --message="Removing the dedicated system user..." --weight=1 - -# Delete a system user -#REMOVEME? ynh_system_user_delete --username=$app - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/restore b/scripts/restore index 04f7e6a..06b0955 100644 --- a/scripts/restore +++ b/scripts/restore @@ -6,56 +6,9 @@ # IMPORT GENERIC HELPERS #================================================= -# 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 -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -#REMOVEME? ynh_clean_setup () { - #### Remove this function if there's nothing to clean before calling the remove script. - true -} -# Exit if an error occurs during the execution of the script -#REMOVEME? ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=1 - -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - -#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain) -#REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path) -#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) - -#================================================= -# CHECK IF THE APP CAN BE RESTORED -#================================================= -#REMOVEME? ynh_script_progression --message="Validating restoration parameters..." --weight=1 - -#REMOVEME? test ! -d $install_dir || ynh_die --message="There is already a directory: $install_dir " - -#================================================= -# STANDARD RESTORATION STEPS -#================================================= -# RESTORE THE NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Restoring the NGINX configuration..." --weight=1 - -ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" - -#================================================= -# RECREATE THE DEDICATED USER -#================================================= -#REMOVEME? ynh_script_progression --message="Recreating the dedicated system user..." --weight=1 - -# Create the dedicated user (if not existing) -#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir" - #================================================= # RESTORE THE APP MAIN DIR #================================================= @@ -68,7 +21,7 @@ ynh_restore_file --origin_path="$install_dir" #================================================= # REINSTALL DEPENDENCIES #================================================= -#REMOVEME? ynh_script_progression --message="Reinstalling dependencies..." --weight=5 +ynh_script_progression --message="Reinstalling dependencies..." --weight=5 ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version @@ -80,38 +33,22 @@ ynh_script_progression --message="Restoring the systemd configuration..." --weig ynh_restore_file --origin_path="/etc/systemd/system/$app.service" systemctl enable $app.service --quiet -#================================================= -# RESTORE redis service -#================================================= -ynh_script_progression --message="Restoring the redis configuration..." --weight=1 - -#REMOVEME? ynh_install_app_dependencies redis-server redis-tools +ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" ynh_restore_file --origin_path="/etc/systemd/system/redis-$app.service" systemctl enable "redis-$app.service" --quiet -chmod 750 "$install_dir" -chmod -R o-rwx "$install_dir" -chown -R $app:$app "$install_dir" - -#================================================= -# RESTORE THE LOGROTATE CONFIGURATION -#================================================= -ynh_script_progression --message="Restoring the logrotate configuration..." --weight=1 - - -# recreate log directory in case of restoring backup in a new installation mkdir --parents /var/log/$app chown -R $app:$app "/var/log/$app/" ynh_restore_file --origin_path="/etc/logrotate.d/$app" -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 yunohost service add $app --description="Software for notes" --log="/var/log/$app/$app.log" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:$app "$install_dir" + #================================================= # START SYSTEMD SERVICE #================================================= @@ -119,13 +56,6 @@ ynh_script_progression --message="Starting a systemd service..." --weight=1 ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="Server running at" -#================================================= -# GENERIC FINALIZATION -#================================================= -# RELOAD NGINX AND PHP-FPM -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - ynh_systemd_action --service_name=nginx --action=reload #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 01b175c..259f7d7 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -9,48 +9,12 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=1 - -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - -#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain) -#REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path) -#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) -#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port) - -if ynh_compare_current_package_version --comparison gt --version 0.2.0~ynh1 -then -#REMOVEME? redis_port=$(ynh_app_setting_get --app=$app --key=redis_port) -else -#REMOVEME? redis_port=$(ynh_find_port --port=8081) -#REMOVEME? ynh_app_setting_set --app=$app --key=redis_port --value=$redis_port -fi - #================================================= # CHECK VERSION #================================================= upgrade_type=$(ynh_check_app_version_changed) -#REMOVEME? ynh_install_app_dependencies redis-server redis-tools - -#================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP -#================================================= -#REMOVEME? ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=1 - -# Backup the current version of the app -#REMOVEME? ynh_backup_before_upgrade -#REMOVEME? ynh_clean_setup () { - # Restore it if the upgrade fails -#REMOVEME? ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -#REMOVEME? ynh_abort_if_errors - #================================================= # STANDARD UPGRADE STEPS #================================================= @@ -62,38 +26,12 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app if $(ynh_compare_current_package_version --comparison gt --version "0.2.0~ynh1") then - # save redis db pushd $install_dir redis-cli --rdb "/tmp/redis-$app.rdb" -p $redis_port popd ynh_systemd_action --service_name=redis-$app --action="stop" --log_path="/var/log/$app/redis-$app.log" fi -#================================================= -# ENSURE DOWNWARD COMPATIBILITY -#================================================= -ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 - -# If install_dir doesn't exist, create it -if [ -z "$install_dir" ]; then -#REMOVEME? install_dir=/var/www/$app -#REMOVEME? ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir -fi - -# Cleaning legacy permissions -#REMOVEME? if ynh_legacy_permissions_exists; then -#REMOVEME? ynh_legacy_permissions_delete_all - - ynh_app_setting_delete --app=$app --key=is_public -fi - -#================================================= -# CREATE DEDICATED USER -#================================================= -#REMOVEME? ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1 - -# Create a dedicated user (if not existing) -#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE @@ -103,7 +41,7 @@ if [ "$upgrade_type" == "UPGRADE_APP" ] then ynh_script_progression --message="Upgrading source files..." --weight=1 -#REMOVEME? ynh_secure_remove --file="$install_dir" + ynh_secure_remove --file="$install_dir" # Download, check integrity, uncompress and patch the source from app.src ynh_setup_source --dest_dir="$install_dir" @@ -129,8 +67,6 @@ ynh_script_progression --message="migrating database... $(ynh_package_version -- echo "$(ynh_package_version --package=srumblr)" - - if $(ynh_compare_current_package_version --comparison lt --version "0.2.0~ynh2") then pushd $install_dir @@ -142,7 +78,6 @@ fi # REDIS CONFIGURATION #================================================= - ynh_add_config --template="redis.conf" --destination="$install_dir/redis.conf" redis_service="redis-$app" @@ -152,7 +87,6 @@ chmod 750 "$install_dir" chmod -R o-rwx "$install_dir" chown -R $app:$app "$install_dir" - #================================================= # NGINX CONFIGURATION #================================================= @@ -161,38 +95,16 @@ ynh_script_progression --message="Upgrading NGINX web server configuration..." - # Create a dedicated NGINX config ynh_add_nginx_config -#================================================= -# UPGRADE DEPENDENCIES -#================================================= -#REMOVEME? ynh_script_progression --message="Upgrading dependencies..." --weight=5 - ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version -#================================================= -# SETUP SYSTEMD -#================================================= -ynh_script_progression --message="Upgrading systemd configuration..." --weight=1 - ynh_add_systemd_config -#================================================= -# GENERIC FINALIZATION -#================================================= -# SETUP LOGROTATE -#================================================= -ynh_script_progression --message="Upgrading logrotate configuration..." --weight=1 - # Use logrotate to manage app-specific logfile(s) ynh_use_logrotate --non-append #fix log directory owner chown -R $app:$app /var/log/$app -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 - yunohost service add $app --description="Software for notes" --log="/var/log/$app/$app.log" #================================================= @@ -202,13 +114,6 @@ ynh_script_progression --message="Starting a systemd service..." --weight=1 ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="Server running at" -#================================================= -# RELOAD NGINX -#================================================= -#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= From 8d64196c6e5072e46a1fe7244430e2acaec612b5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Sun, 17 Dec 2023 13:29:42 +0100 Subject: [PATCH 04/13] Create tests.toml --- tests.toml | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 tests.toml diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..d64ef3c --- /dev/null +++ b/tests.toml @@ -0,0 +1,7 @@ +test_format = 1.0 + +[default] + + # ------------ + # Tests to run + # ------------ From d2555ca349ed4857d4425d00d0d302633a7cfaea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Sun, 17 Dec 2023 13:29:55 +0100 Subject: [PATCH 05/13] Delete check_process --- check_process | 25 ------------------------- 1 file changed, 25 deletions(-) delete mode 100644 check_process diff --git a/check_process b/check_process deleted file mode 100644 index ac25d73..0000000 --- a/check_process +++ /dev/null @@ -1,25 +0,0 @@ -;; Test complet - ; Manifest - domain="domain.tld" - path="/path" - 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=7097f3fe8fcf818f342e1971a58bc45cb8fe835c - backup_restore=1 - multi_instance=1 - change_url=1 -;;; Options -Email= -Notification=none -;;; Upgrade options - ; commit=7097f3fe8fcf818f342e1971a58bc45cb8fe835c - name=Merge pull request #15 - manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=pass&port=666& - From b61ee59af8f0626448b5a781e1e8f7df342b6dec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Sun, 17 Dec 2023 14:04:35 +0100 Subject: [PATCH 06/13] cleaning --- manifest.toml | 2 +- scripts/install | 6 ------ 2 files changed, 1 insertion(+), 7 deletions(-) diff --git a/manifest.toml b/manifest.toml index c5c18b4..aa898d1 100644 --- a/manifest.toml +++ b/manifest.toml @@ -16,7 +16,7 @@ demo = "http://scrumblr.ca/" code = "https://framagit.org/colibris/framemo" [integration] -yunohost = ">> 11.2" +yunohost = ">= 11.2" architectures = "all" multi_instance = true diff --git a/scripts/install b/scripts/install index 53d90e8..1116e9e 100644 --- a/scripts/install +++ b/scripts/install @@ -27,12 +27,6 @@ ynh_setup_source --dest_dir="$install_dir" # CONFIGURE REDIS SERVICE #================================================== -#REMOVEME? ynh_install_app_dependencies redis-server redis-tools - -# Find an available port for redis -#REMOVEME? redis_port=$(ynh_find_port --port=8081) -#REMOVEME? ynh_app_setting_set --app=$app --key=redis_port --value=$redis_port - ynh_add_config --template="redis.conf" --destination="$install_dir/redis.conf" redis_service="redis-$app" From 4c6650a116c10cf317d1b45ba262cfbf758fbfb1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Sun, 17 Dec 2023 14:05:59 +0100 Subject: [PATCH 07/13] Update redis.conf --- conf/redis.conf | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/conf/redis.conf b/conf/redis.conf index 7d50bbc..37c470d 100644 --- a/conf/redis.conf +++ b/conf/redis.conf @@ -122,7 +122,7 @@ supervised no # # Creating a pid file is best effort: if Redis is not able to create it # nothing bad happens, the server will start and run normally. -pidfile __FINAL_PATH__/redis-server-__REDIS_PORT__.pid +pidfile __INSTALL_DIR__/redis-server-__PORT_REDIS__.pid # Specify the server verbosity level. # This can be one of: @@ -135,7 +135,7 @@ loglevel notice # Specify the log file name. Also the empty string can be used to force # Redis to log on the standard output. Note that if you use standard # output for logging but daemonize, logs will be sent to /dev/null -logfile /var/log/__APP__/redis-__REDIS_PORT__.log +logfile /var/log/__APP__/redis-__PORT_REDIS__.log # Set the number of databases. The default database is DB 0, you can select # a different one on a per-connection basis using SELECT where @@ -210,7 +210,7 @@ dbfilename redis-__APP__.rdb # The Append Only File will also be created inside this directory. # # Note that you must specify a directory here, not a file name. -dir __FINAL_PATH__ +dir __INSTALL_DIR__ ############################# LAZY FREEING #################################### From 227cc417809c83bdd367bc0264596e6013f7411c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Sun, 17 Dec 2023 14:28:46 +0100 Subject: [PATCH 08/13] fix --- conf/nginx.conf | 2 +- manifest.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/conf/nginx.conf b/conf/nginx.conf index 9b31951..4cec3cc 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -4,7 +4,7 @@ location __PATH__/ { proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $remote_addr; proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header X-Forwarded-Host $http_host; + proxy_set_header X-Forwarded-Host $host; proxy_set_header Host $host; proxy_http_version 1.1; diff --git a/manifest.toml b/manifest.toml index aa898d1..092e595 100644 --- a/manifest.toml +++ b/manifest.toml @@ -52,7 +52,7 @@ ram.runtime = "50M" [resources.install_dir] [resources.ports] - redis.main = 8081 + redis.default = 8081 [resources.permissions] main.url = "/" From b1d9ccc66c709dfbb4af9ccf4fb173c7c4efd356 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Sun, 17 Dec 2023 14:29:17 +0100 Subject: [PATCH 09/13] Update redis.conf --- conf/redis.conf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/conf/redis.conf b/conf/redis.conf index 37c470d..bb49a13 100644 --- a/conf/redis.conf +++ b/conf/redis.conf @@ -64,7 +64,7 @@ protected-mode yes # Accept connections on the specified port, default is 6379 (IANA #815344). # If port 0 is specified Redis will not listen on a TCP socket. -port __REDIS_PORT__ +port __PORT_REDIS__ # TCP listen() backlog. # From c9beba954a11bbb6b3bec9ec779057318cdf9744 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Sun, 17 Dec 2023 14:32:24 +0100 Subject: [PATCH 10/13] Update scrumblr_redis.service --- conf/scrumblr_redis.service | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/conf/scrumblr_redis.service b/conf/scrumblr_redis.service index fc6e282..db0d774 100644 --- a/conf/scrumblr_redis.service +++ b/conf/scrumblr_redis.service @@ -9,7 +9,7 @@ Group=__APP__ WorkingDirectory=__INSTALL_DIR__/ ExecStart=/usr/bin/redis-server __INSTALL_DIR__/redis.conf ExecStop=/bin/kill -s TERM $MAINPID -PIDFile=__INSTALL_DIR__/redis-server-__REDIS_PORT__.pid +PIDFile=__INSTALL_DIR__/redis-server-__PORT_REDIS__.pid TimeoutStopSec=0 Restart=always From a87cd8cce58a390bc336dfb16f0602aff916c128 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Sun, 17 Dec 2023 16:11:21 +0100 Subject: [PATCH 11/13] fix --- scripts/backup | 2 +- scripts/install | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/scripts/backup b/scripts/backup index 22e9b93..f6297b0 100644 --- a/scripts/backup +++ b/scripts/backup @@ -19,7 +19,7 @@ ynh_print_info --message="Declaring files to be backed up..." # EXPORT DATABASE #================================================= -redis-cli --rdb "$install_dir/redis-$app.rdb" -p $redis_port +redis-cli --rdb "$install_dir/redis-$app.rdb" -p $port_redis #================================================= # BACKUP THE APP MAIN DIR diff --git a/scripts/install b/scripts/install index 1116e9e..ff43871 100644 --- a/scripts/install +++ b/scripts/install @@ -32,7 +32,6 @@ ynh_add_config --template="redis.conf" --destination="$install_dir/redis.conf" redis_service="redis-$app" ynh_add_systemd_config --service $redis_service --template scrumblr_redis.service - chmod 770 "$install_dir" chmod -R o-rwx "$install_dir" chown -R $app:$app "$install_dir" From 32e7b4ff1bb30a87dd1cb0c7e342913c587fead6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Wed, 27 Dec 2023 10:55:21 +0100 Subject: [PATCH 12/13] fix --- scripts/install | 2 +- scripts/remove | 1 + scripts/upgrade | 13 +++++++++---- 3 files changed, 11 insertions(+), 5 deletions(-) diff --git a/scripts/install b/scripts/install index ff43871..c87e72b 100644 --- a/scripts/install +++ b/scripts/install @@ -66,7 +66,7 @@ popd 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="Server running at " +ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="Server running at " #================================================= # END OF SCRIPT diff --git a/scripts/remove b/scripts/remove index 8688c04..7f3b063 100644 --- a/scripts/remove +++ b/scripts/remove @@ -14,6 +14,7 @@ source /usr/share/yunohost/helpers #================================================= # REMOVE SERVICE INTEGRATION IN YUNOHOST #================================================= +ynh_script_progression --message="Removing system configurations related to $app..." --weight=1 if ynh_exec_warn_less yunohost service status $app >/dev/null then diff --git a/scripts/upgrade b/scripts/upgrade index 259f7d7..6410135 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -27,12 +27,19 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app if $(ynh_compare_current_package_version --comparison gt --version "0.2.0~ynh1") then pushd $install_dir - redis-cli --rdb "/tmp/redis-$app.rdb" -p $redis_port + redis-cli --rdb "/tmp/redis-$app.rdb" -p $port_redis popd ynh_systemd_action --service_name=redis-$app --action="stop" --log_path="/var/log/$app/redis-$app.log" fi +#================================================= +# INSTALL NODEJS +#================================================= +ynh_script_progression --message="Installing dependencies..." --weight=5 + +ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version + #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= @@ -95,8 +102,6 @@ ynh_script_progression --message="Upgrading NGINX web server configuration..." - # Create a dedicated NGINX config ynh_add_nginx_config -ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version - ynh_add_systemd_config # Use logrotate to manage app-specific logfile(s) @@ -112,7 +117,7 @@ yunohost service add $app --description="Software for notes" --log="/var/log/$ap #================================================= ynh_script_progression --message="Starting a systemd service..." --weight=1 -ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="Server running at" +ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="Server running at" #================================================= # END OF SCRIPT From 19d7b2b530b1f20dc17ffa29577bd62732e2bff3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Wed, 27 Dec 2023 11:00:51 +0100 Subject: [PATCH 13/13] cleaning --- conf/nginx.conf | 1 + conf/scrumblr_redis.service | 2 -- conf/systemd.service | 3 +-- 3 files changed, 2 insertions(+), 4 deletions(-) diff --git a/conf/nginx.conf b/conf/nginx.conf index 4cec3cc..f9716eb 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,3 +1,4 @@ +#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; location __PATH__/ { proxy_pass http://127.0.0.1:__PORT____PATH__/; diff --git a/conf/scrumblr_redis.service b/conf/scrumblr_redis.service index db0d774..39c49b7 100644 --- a/conf/scrumblr_redis.service +++ b/conf/scrumblr_redis.service @@ -32,7 +32,5 @@ RestrictRealtime=true RestrictNamespaces=true RestrictAddressFamilies=AF_INET AF_INET6 AF_UNIX - - [Install] WantedBy=multi-user.target diff --git a/conf/systemd.service b/conf/systemd.service index 8917d0f..e5c9137 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -1,5 +1,5 @@ [Unit] -Description=Scrumblr: software to take note. +Description=Scrumblr: collaborative whiteboard Requires=redis-__APP__.service [Service] @@ -44,4 +44,3 @@ CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG [Install] WantedBy=multi-user.target -