From faf57ba7a2faea93887403b66f557d749fdb0a42 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Wed, 27 Sep 2023 22:24:30 +0200 Subject: [PATCH] v2 --- conf/app.src | 7 ---- conf/gunicorn.py | 8 ++-- conf/nginx.conf | 4 +- conf/systemd.service | 6 +-- manifest.toml | 96 ++++++++++++++++++++++++++++++++++++++++++++ scripts/_common.sh | 2 +- scripts/backup | 14 +++---- scripts/change_url | 94 ++++++++++++++++++++++--------------------- scripts/install | 90 ++++++++++++++++++++--------------------- scripts/remove | 22 +++++----- scripts/restore | 48 +++++++++++----------- scripts/upgrade | 76 +++++++++++++++++------------------ 12 files changed, 279 insertions(+), 188 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 cbe8f65..0000000 --- a/conf/app.src +++ /dev/null @@ -1,7 +0,0 @@ -SOURCE_URL=https://github.com/YunoHost/pepettes/archive/v1.0.1.tar.gz -SOURCE_SUM=9792ed5589d4a55bd619edc7aa61a1a78f34c5a4e7095b2292ac09b66c8b9a58 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= -SOURCE_EXTRACT=true diff --git a/conf/gunicorn.py b/conf/gunicorn.py index db092a2..5e8d545 100644 --- a/conf/gunicorn.py +++ b/conf/gunicorn.py @@ -1,9 +1,9 @@ -command = '__FINALPATH__/venv/bin/gunicorn' -pythonpath = '__FINALPATH__' +command = '__INSTALL_DIR__/venv/bin/gunicorn' +pythonpath = '__INSTALL_DIR__' workers = 4 user = '__APP__' -bind = 'unix:__FINALPATH__/sock' -pid = '__FINALPATH__/__APP__-pid' +bind = 'unix:__INSTALL_DIR__/sock' +pid = '__INSTALL_DIR__/__APP__-pid' errorlog = '/var/log/__APP__/error.log' accesslog = '/var/log/__APP__/access.log' access_log_format = '%({X-Real-IP}i)s %({X-Forwarded-For}i)s %(h)s %(l)s %(u)s %(t)s "%(r)s" %(s)s %(b)s "%(f)s" "%(a)s"' diff --git a/conf/nginx.conf b/conf/nginx.conf index af7ee6c..3e8c90c 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -7,12 +7,12 @@ location __PATH__/ { proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; - proxy_pass http://unix:__FINALPATH__/sock; + proxy_pass http://unix:__INSTALL_DIR__/sock; # Include SSOWAT user panel. include conf.d/yunohost_panel.conf.inc; } location __PATH__/css { - alias __FINALPATH__/assets/css; + alias __INSTALL_DIR__/assets/css; } diff --git a/conf/systemd.service b/conf/systemd.service index c25b84f..12aeccc 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -3,11 +3,11 @@ Description=__APP__ Daemon After=network.target [Service] -PIDFile=__FINALPATH__/__APP__-pid +PIDFile=__INSTALL_DIR__/__APP__-pid User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__ -ExecStart=__FINALPATH__/venv/bin/gunicorn -c __FINALPATH__/gunicorn.py wsgi:app --pid __FINALPATH__/__APP__-pid +WorkingDirectory=__INSTALL_DIR__ +ExecStart=__INSTALL_DIR__/venv/bin/gunicorn -c __INSTALL_DIR__/gunicorn.py wsgi:app --pid __INSTALL_DIR__/__APP__-pid ExecReload=/bin/kill -s HUP $MAINPID ExecStop=/bin/kill -s TERM $MAINPID PrivateTmp=true diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..a032427 --- /dev/null +++ b/manifest.toml @@ -0,0 +1,96 @@ +packaging_format = 2 + +id = "pepettes" +name = "Pepettes" +description.en = "A simple donation form with stripe" +description.fr = "Un simple formulaire de don avec stripe" + +version = "1.0.1~ynh3" + +maintainers = ["ljf"] + +[upstream] +license = "MIT" +demo = "https://donate.yunohost.org" +admindoc = "https://github.com/YunoHost/pepettes/blob/main/README.md" +code = "https://github.com/YunoHost/pepettes/" +website = "https://github.com/YunoHost/pepettes/" +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.1.3" +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" + full_domain = true + + [install.init_main_permission] + type = "group" + default = "visitors" + + [install.project_name] + ask.en = "What's the name of the project which will received donation ?" + ask.fr = "Quel est le nom du projet qui va recevoir les dons ?" + type = "string" + default = "" + + [install.contact_url] + ask.en = "Indicate a link to contact you to ask for stopping recuring payment" + ask.fr = "Indiquez un lien pour vous contacter pour arréter les paiements récurrents" + type = "string" + default = "" + + [install.logo] + ask.en = "A link to the logo of your project" + ask.fr = "Un lien vers le logo de votre projet" + type = "string" + default = "" + + [install.favicon] + ask.en = "A link to the favicon of your project" + ask.fr = "Un lien vers la favicon de votre projet" + type = "string" + default = "" + + [install.publishable_key] + ask.en = "Indicate here the stripe publishable key" + ask.fr = "Indiquez ici la clé publique stripe" + type = "string" + default = "" + + [install.secret_key] + ask.en = "Indicate here the stripe secret key" + ask.fr = "Indiquez ici la clé secrète stripe" + type = "string" + default = "" + + [install.prices] + ask.en = "Indicates here the prices ID of donation products you created in stripe interfaces" + ask.fr = "Indiquez ici les ID de prix des produits de don stripe que vous avez créé dans l'interface stripe" + help.en = "Go on https://dashboard.stripe.com/products to create those donation products" + help.fr = "Allez sur https://dashboard.stripe.com/products pour créer ces produits de dons" + type = "string" + default = "one_time/EUR/price_1IKuPV,recuring/EUR/price_1IKuPV" + +[resources] + [resources.sources.main] + url = "https://github.com/YunoHost/pepettes/archive/v1.0.1.tar.gz" + sha256 = "9792ed5589d4a55bd619edc7aa61a1a78f34c5a4e7095b2292ac09b66c8b9a58" + + + [resources.system_user] + + [resources.install_dir] + + [resources.permissions] + main.url = "/" diff --git a/scripts/_common.sh b/scripts/_common.sh index bc48e71..009af3d 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -5,7 +5,7 @@ #================================================= # dependencies used by the app -pkg_dependencies="python3-venv python3-dev python3-pip" +#REMOVEME? pkg_dependencies="python3-venv python3-dev python3-pip" #================================================= # PERSONAL HELPERS diff --git a/scripts/backup b/scripts/backup index 3beb939..3aa53f8 100755 --- a/scripts/backup +++ b/scripts/backup @@ -14,21 +14,21 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= -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 #================================================= # 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) +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) +#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain) #================================================= # DECLARE DATA AND CONF FILES TO BACKUP @@ -39,7 +39,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 e49ddfb..c84486a 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -13,65 +13,65 @@ 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) +#REMOVEME? # Needed for helper "ynh_add_nginx_config" +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) -project_name=$(ynh_app_setting_get --app=$app --key=project_name) -contact_url=$(ynh_app_setting_get --app=$app --key=contact_url) -logo=$(ynh_app_setting_get --app=$app --key=logo) -favicon=$(ynh_app_setting_get --app=$app --key=favicon) -publishable_key=$(ynh_app_setting_get --app=$app --key=publishable_key) -secret_key=$(ynh_app_setting_get --app=$app --key=secret_key) -prices=$(ynh_app_setting_get --app=$app --key=prices) -secret=$(ynh_app_setting_get --app=$app --key=secret) -csrf_key=$(ynh_app_setting_get --app=$app --key=csrf_key) -port=$(ynh_app_setting_get --app=$app --key=port) +#REMOVEME? project_name=$(ynh_app_setting_get --app=$app --key=project_name) +#REMOVEME? contact_url=$(ynh_app_setting_get --app=$app --key=contact_url) +#REMOVEME? logo=$(ynh_app_setting_get --app=$app --key=logo) +#REMOVEME? favicon=$(ynh_app_setting_get --app=$app --key=favicon) +#REMOVEME? publishable_key=$(ynh_app_setting_get --app=$app --key=publishable_key) +#REMOVEME? secret_key=$(ynh_app_setting_get --app=$app --key=secret_key) +#REMOVEME? prices=$(ynh_app_setting_get --app=$app --key=prices) +#REMOVEME? secret=$(ynh_app_setting_get --app=$app --key=secret) +#REMOVEME? csrf_key=$(ynh_app_setting_get --app=$app --key=csrf_key) +#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port) domain=$new_domain #================================================= # BACKUP BEFORE UPGRADE 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 #================================================= @@ -88,28 +88,30 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd" --li #================================================= 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 #================================================= @@ -119,21 +121,21 @@ fi #================================================= ynh_script_progression --message="Updating a configuration file..." -ynh_add_config --template="../conf/gunicorn.py" --destination="$final_path/gunicorn.py" -ynh_add_config --template="../conf/settings.py" --destination="$final_path/settings.py" +ynh_add_config --template="../conf/gunicorn.py" --destination="$install_dir/gunicorn.py" +ynh_add_config --template="../conf/settings.py" --destination="$install_dir/settings.py" for price in $(echo $prices | sed "s/,/ /"); do frequency=$(echo $price | cut -d/ -f1) currency=$(echo $price | cut -d/ -f2) price_id=$(echo $price | cut -d/ -f3) - echo "DONATION['$frequency']['$currency'] = '$price_id'" >> "$final_path/settings.py" + echo "DONATION['$frequency']['$currency'] = '$price_id'" >> "$install_dir/settings.py" done -ynh_store_file_checksum --file="$final_path/settings.py" +ynh_store_file_checksum --file="$install_dir/settings.py" # Set permissions to app files -chown -R $app:www-data $final_path -chmod o=--- $final_path +chown -R $app:www-data $install_dir +chmod o=--- $install_dir #================================================= # GENERIC FINALISATION @@ -148,9 +150,9 @@ ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --l #================================================= # 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 337a4a8..ef4b349 100755 --- a/scripts/install +++ b/scripts/install @@ -13,49 +13,49 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= -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="/" -is_public=$YNH_APP_ARG_IS_PUBLIC -project_name=$YNH_APP_ARG_PROJECT_NAME -contact_url=$YNH_APP_ARG_CONTACT_URL -logo=$YNH_APP_ARG_LOGO -favicon=$YNH_APP_ARG_FAVICON -publishable_key=$YNH_APP_ARG_PUBLISHABLE_KEY -secret_key=$YNH_APP_ARG_SECRET_KEY -prices=$YNH_APP_ARG_PRICES +#REMOVEME? domain=$YNH_APP_ARG_DOMAIN +path="/" +#REMOVEME? is_public=$YNH_APP_ARG_IS_PUBLIC +#REMOVEME? project_name=$YNH_APP_ARG_PROJECT_NAME +#REMOVEME? contact_url=$YNH_APP_ARG_CONTACT_URL +#REMOVEME? logo=$YNH_APP_ARG_LOGO +#REMOVEME? favicon=$YNH_APP_ARG_FAVICON +#REMOVEME? publishable_key=$YNH_APP_ARG_PUBLISHABLE_KEY +#REMOVEME? secret_key=$YNH_APP_ARG_SECRET_KEY +#REMOVEME? prices=$YNH_APP_ARG_PRICES secret=$(ynh_string_random --length=50) csrf_key=$(ynh_string_random --length=50) -app=$YNH_APP_INSTANCE_NAME +#REMOVEME? app=$YNH_APP_INSTANCE_NAME #================================================= # CHECK IF THE APP CAN BE INSTALLED WITH THESE 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 ynh_app_setting_set --app=$app --key=project_name --value=$project_name ynh_app_setting_set --app=$app --key=contact_url --value=$contact_url ynh_app_setting_set --app=$app --key=logo --value=$logo @@ -71,39 +71,39 @@ ynh_app_setting_set --app=$app --key=csrf_key --value=$csrf_key #================================================= # 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=8102) -ynh_app_setting_set --app=$app --key=port --value=$port +#REMOVEME? port=$(ynh_find_port --port=8102) +#REMOVEME? ynh_app_setting_set --app=$app --key=port --value=$port #================================================= # INSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Installing dependencies..." --weight=1 +#REMOVEME? ynh_script_progression --message="Installing dependencies..." --weight=1 -ynh_install_app_dependencies $pkg_dependencies +#REMOVEME? ynh_install_app_dependencies $pkg_dependencies #================================================= # 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=1 -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" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= # NGINX CONFIGURATION @@ -118,9 +118,9 @@ ynh_add_nginx_config #================================================= # INSTALL PYTHON DEPENDENCIES #================================================= -ynh_script_progression --message="Installing Python dependencies..." +#REMOVEME? ynh_script_progression --message="Installing Python dependencies..." -pushd $final_path +pushd $install_dir python3 -m venv venv venv/bin/pip install --upgrade pip venv/bin/pip install -r requirements.txt @@ -141,17 +141,17 @@ popd #================================================= ynh_script_progression --message="Adding a configuration file..." -ynh_add_config --template="../conf/gunicorn.py" --destination="$final_path/gunicorn.py" -ynh_add_config --template="../conf/settings.py" --destination="$final_path/settings.py" +ynh_add_config --template="../conf/gunicorn.py" --destination="$install_dir/gunicorn.py" +ynh_add_config --template="../conf/settings.py" --destination="$install_dir/settings.py" for price in $(echo $prices | sed "s/,/ /"); do frequency=$(echo $price | cut -d/ -f1) currency=$(echo $price | cut -d/ -f2) price_id=$(echo $price | cut -d/ -f3) - echo "DONATION['$frequency']['$currency'] = '$price_id'" >> "$final_path/settings.py" + echo "DONATION['$frequency']['$currency'] = '$price_id'" >> "$install_dir/settings.py" done -ynh_store_file_checksum --file="$final_path/settings.py" +ynh_store_file_checksum --file="$install_dir/settings.py" #================================================= # SETUP SYSTEMD @@ -169,8 +169,8 @@ ynh_add_systemd_config ynh_script_progression --message="Securing files and directories..." # Set permissions to app files -chown -R $app:www-data $final_path -chmod o=--- $final_path +chown -R $app:www-data $install_dir +chmod o=--- $install_dir #================================================= # INTEGRATE SERVICE IN YUNOHOST @@ -190,23 +190,23 @@ ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --l #================================================= # SETUP SSOWAT #================================================= -ynh_script_progression --message="Configuring permissions..." --weight=1 +#REMOVEME? ynh_script_progression --message="Configuring permissions..." --weight=1 # Make app public if necessary -if [ $is_public -eq 1 ] +#REMOVEME? if [ $is_public -eq 1 ] then # Everyone can access the app. # The "main" permission is automatically created before the install script. - 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 b492b54..f2716b2 100755 --- 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 @@ -44,18 +44,18 @@ ynh_remove_systemd_config #================================================= # REMOVE DEPENDENCIES #================================================= -ynh_script_progression --message="Removing dependencies..." --weight=1 +#REMOVEME? ynh_script_progression --message="Removing dependencies..." --weight=1 # Remove metapackage and its dependencies -ynh_remove_app_dependencies +#REMOVEME? ynh_remove_app_dependencies #================================================= # 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 @@ -80,10 +80,10 @@ ynh_secure_remove --file="/var/log/$app" #================================================= # 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 cc35ab0..57cea02 100755 --- a/scripts/restore +++ b/scripts/restore @@ -14,32 +14,32 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= -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 #================================================= # 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 -ynh_webpath_available --domain=$domain --path_url=$path_url \ - || ynh_die --message="Path not available: ${domain}${path_url}" -test ! -d $final_path \ - || ynh_die --message="There is already a directory: $final_path " +#REMOVEME? ynh_webpath_available --domain=$domain --path=$path \ + || ynh_die --message="Path not available: ${domain}${path}" +#REMOVEME? test ! -d $install_dir \ + || ynh_die --message="There is already a directory: $install_dir " #================================================= # STANDARD RESTORATION STEPS @@ -53,38 +53,38 @@ 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" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= # SPECIFIC RESTORATION #================================================= # REINSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Reinstalling dependencies..." --weight=1 +#REMOVEME? ynh_script_progression --message="Reinstalling dependencies..." --weight=1 # Define and install dependencies -ynh_install_app_dependencies $pkg_dependencies +#REMOVEME? ynh_install_app_dependencies $pkg_dependencies #================================================= # INSTALL PYTHON DEPENDENCIES #================================================= -ynh_script_progression --message="Installing Python dependencies..." +#REMOVEME? ynh_script_progression --message="Installing Python dependencies..." -pushd $final_path +pushd $install_dir python3 -m venv venv venv/bin/pip install --upgrade pip venv/bin/pip install -r requirements.txt @@ -100,8 +100,8 @@ popd ynh_script_progression --message="Restoring user rights..." # Restore permissions on app files -chown -R $app:www-data $final_path -chmod o=--- $final_path +chown -R $app:www-data $install_dir +chmod o=--- $install_dir #================================================= # RESTORE SYSTEMD diff --git a/scripts/upgrade b/scripts/upgrade index 7b88a17..2af92ff 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -12,24 +12,24 @@ 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) -project_name=$(ynh_app_setting_get --app=$app --key=project_name) -contact_url=$(ynh_app_setting_get --app=$app --key=contact_url) -logo=$(ynh_app_setting_get --app=$app --key=logo) -favicon=$(ynh_app_setting_get --app=$app --key=favicon) -publishable_key=$(ynh_app_setting_get --app=$app --key=publishable_key) -secret_key=$(ynh_app_setting_get --app=$app --key=secret_key) -prices=$(ynh_app_setting_get --app=$app --key=prices) -secret=$(ynh_app_setting_get --app=$app --key=secret) -csrf_key=$(ynh_app_setting_get --app=$app --key=csrf_key) +#REMOVEME? project_name=$(ynh_app_setting_get --app=$app --key=project_name) +#REMOVEME? contact_url=$(ynh_app_setting_get --app=$app --key=contact_url) +#REMOVEME? logo=$(ynh_app_setting_get --app=$app --key=logo) +#REMOVEME? favicon=$(ynh_app_setting_get --app=$app --key=favicon) +#REMOVEME? publishable_key=$(ynh_app_setting_get --app=$app --key=publishable_key) +#REMOVEME? secret_key=$(ynh_app_setting_get --app=$app --key=secret_key) +#REMOVEME? prices=$(ynh_app_setting_get --app=$app --key=prices) +#REMOVEME? secret=$(ynh_app_setting_get --app=$app --key=secret) +#REMOVEME? csrf_key=$(ynh_app_setting_get --app=$app --key=csrf_key) #================================================= # CHECK VERSION @@ -41,16 +41,16 @@ upgrade_type=$(ynh_check_app_version_changed) #================================================= # 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 @@ -64,10 +64,10 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd" --li #================================================= # 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 @@ -78,12 +78,12 @@ then ynh_script_progression --message="Upgrading source files..." --weight=1 # 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" fi -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= # NGINX CONFIGURATION @@ -96,18 +96,18 @@ ynh_add_nginx_config #================================================= # UPGRADE DEPENDENCIES #================================================= -ynh_script_progression --message="Upgrading dependencies..." --weight=1 +#REMOVEME? ynh_script_progression --message="Upgrading dependencies..." --weight=1 -ynh_install_app_dependencies $pkg_dependencies +#REMOVEME? ynh_install_app_dependencies $pkg_dependencies #================================================= # SPECIFIC UPGRADE #================================================= # UPGRADE PYTHON DEPENDENCIES #================================================= -ynh_script_progression --message="Installing Python dependencies..." +#REMOVEME? ynh_script_progression --message="Installing Python dependencies..." -pushd $final_path +pushd $install_dir python3 -m venv venv venv/bin/pip install --upgrade pip venv/bin/pip install -r requirements.txt @@ -128,17 +128,17 @@ popd #================================================= ynh_script_progression --message="Updating a configuration file..." -ynh_add_config --template="../conf/gunicorn.py" --destination="$final_path/gunicorn.py" -ynh_add_config --template="../conf/settings.py" --destination="$final_path/settings.py" +ynh_add_config --template="../conf/gunicorn.py" --destination="$install_dir/gunicorn.py" +ynh_add_config --template="../conf/settings.py" --destination="$install_dir/settings.py" for price in $(echo $prices | sed "s/,/ /"); do frequency=$(echo $price | cut -d/ -f1) currency=$(echo $price | cut -d/ -f2) price_id=$(echo $price | cut -d/ -f3) - echo "DONATION['$frequency']['$currency'] = '$price_id'" >> "$final_path/settings.py" + echo "DONATION['$frequency']['$currency'] = '$price_id'" >> "$install_dir/settings.py" done -ynh_store_file_checksum --file="$final_path/settings.py" +ynh_store_file_checksum --file="$install_dir/settings.py" #================================================= # SETUP SYSTEMD @@ -156,8 +156,8 @@ ynh_add_systemd_config ynh_script_progression --message="Securing files and directories..." # Set permissions on app files -chown -R $app:www-data $final_path -chmod o=--- $final_path +chown -R $app:www-data $install_dir +chmod o=--- $install_dir #================================================= # INTEGRATE SERVICE IN YUNOHOST @@ -176,9 +176,9 @@ ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --l #================================================= # 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