From 14fa8a8c912852f9902bc01f1f6c93cae5fb91e3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Thu, 16 Nov 2023 17:01:29 +0100 Subject: [PATCH] v2 --- conf/app.src | 7 --- conf/local.py.j2 | 4 +- conf/nginx.conf | 10 ++--- conf/systemd.service | 32 +++++++------- manifest.toml | 71 ++++++++++++++++++++++++++++++ scripts/_common.sh | 2 +- scripts/backup | 16 +++---- scripts/change_url | 66 ++++++++++++++-------------- scripts/install | 102 +++++++++++++++++++++---------------------- scripts/remove | 30 ++++++------- scripts/restore | 64 +++++++++++++-------------- scripts/upgrade | 100 +++++++++++++++++++++--------------------- 12 files changed, 285 insertions(+), 219 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 be1a359..0000000 --- a/conf/app.src +++ /dev/null @@ -1,7 +0,0 @@ -SOURCE_URL=https://code.ffdn.org/ffdn/coin/-/archive/afcf0846f939e80f34956d5f24f7bdd6a5058282/coin-afcf0846f939e80f34956d5f24f7bdd6a5058282.tar.gz -SOURCE_SUM=71a2570a7f145ae826042853f7af2dff46350ef70f83698871b14fa7f9884219 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= -SOURCE_EXTRACT=true diff --git a/conf/local.py.j2 b/conf/local.py.j2 index b260fee..d42a4be 100644 --- a/conf/local.py.j2 +++ b/conf/local.py.j2 @@ -8,10 +8,10 @@ DEBUG = TEMPLATE_DEBUG = False ALLOWED_HOSTS = ['{{ domain }}'] URL_PREFIX = '{{ prefix }}' -STATIC_ROOT = '{{ final_path }}/static' +STATIC_ROOT = '{{ install_dir }}/static' NOTIFICATION_EMAILS = ['{{ email }}'] DEFAULT_FROM_EMAIL = 'notifier@{{ domain }}' -SITE_URL = "https://{{ domain }}{{ path_url }}" +SITE_URL = "https://{{ domain }}{{ path }}" SECRET_KEY = '{{ secret }}' ISP = { 'NAME': '{{ isp_name }}', diff --git a/conf/nginx.conf b/conf/nginx.conf index 6f929db..2ee1541 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -5,19 +5,19 @@ location __PATH__/ { location __PATH__/protected/ { internal; - alias __FINALPATH__/__NAME__/smedia/; + alias __INSTALL_DIR__/__NAME__/smedia/; } location __PATH__/media/ { - alias __FINALPATH__/media/; + alias __INSTALL_DIR__/media/; } location __PATH__/static/ { - alias __FINALPATH__/static/; + alias __INSTALL_DIR__/static/; } location __PATH__/assets/ { - alias __FINALPATH__/static/; + alias __INSTALL_DIR__/static/; } location @__NAME__ { @@ -25,5 +25,5 @@ location @__NAME__ { 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; } diff --git a/conf/systemd.service b/conf/systemd.service index 3e1d373..1531ef2 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -1,16 +1,16 @@ -[Unit] -Description=__APP__ gunicorn daemon -After=network.target - -[Service] -PIDFile=/run/gunicorn/__APP__-pid -User=__APP__ -Group=__APP__ -WorkingDirectory=__FINALPATH__/ -ExecStart=__YNH_PYTHON_PATH__/gunicorn -c __FINALPATH__/gunicorn_config.py __APP__.wsgi -ExecReload=/bin/kill -s HUP $MAINPID -ExecStop=/bin/kill -s TERM $MAINPID -PrivateTmp=true - -[Install] -WantedBy=multi-user.target +[Unit] +Description=__APP__ gunicorn daemon +After=network.target + +[Service] +PIDFile=/run/gunicorn/__APP__-pid +User=__APP__ +Group=__APP__ +WorkingDirectory=__INSTALL_DIR__/ +ExecStart=__YNH_PYTHON_PATH__/gunicorn -c __INSTALL_DIR__/gunicorn_config.py __APP__.wsgi +ExecReload=/bin/kill -s HUP $MAINPID +ExecStop=/bin/kill -s TERM $MAINPID +PrivateTmp=true + +[Install] +WantedBy=multi-user.target diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..f2d0f4a --- /dev/null +++ b/manifest.toml @@ -0,0 +1,71 @@ +packaging_format = 2 + +id = "coin" +name = "Coin" +description.en = "Member dashboard for non profit isp" +description.fr = "Coin est un Outil pour un Internet Neutre" + +version = "20220401~ynh1" + +maintainers = ["ljf"] + +[upstream] +license = "AGPL-3.0-or-later" +website = "https://code.ffdn.org/FFDN/coin" +code = "https://code.ffdn.org/ffdn/coin" +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 = ">= 11.0.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" + full_domain = true + + [install.admin] + # this is a generic question - ask strings are automatically handled by Yunohost's core + type = "user" + + [install.email] + ask.en = "Choose email were send notification" + ask.fr = "Choisissez l'email vers lequel envoyer les notifications" + type = "string" + example = "admin@example.tld" + + [install.isp_name] + ask.en = "Enter your ISP name" + ask.fr = "Indiquez le nom de votre FAI" + type = "string" + example = "My ISP" + + [install.isp_site] + ask.en = "Enter the address of your ISP website" + ask.fr = "Saisissez l'adresse du siteweb de votre FAI" + type = "string" + example = "//www.exemple.tld" + +[resources] + [resources.sources.main] + url = "https://code.ffdn.org/ffdn/coin/-/archive/afcf0846f939e80f34956d5f24f7bdd6a5058282/coin-afcf0846f939e80f34956d5f24f7bdd6a5058282.tar.gz" + sha256 = "71a2570a7f145ae826042853f7af2dff46350ef70f83698871b14fa7f9884219" + + + [resources.system_user] + + [resources.install_dir] + + [resources.permissions] + main.url = "/" + + [resources.database] + type = "postgresql" diff --git a/scripts/_common.sh b/scripts/_common.sh index ba3926a..2e05799 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -7,7 +7,7 @@ python_version=2.7.18 # dependencies used by the app -pkg_dependencies="gunicorn libldap2-dev libpq-dev libsasl2-dev libjpeg-dev libxml2-dev libxslt1-dev libffi-dev libpango1.0-0 postgresql postgresql-contrib postgresql-server-dev-13" +#REMOVEME? pkg_dependencies="gunicorn libldap2-dev libpq-dev libsasl2-dev libjpeg-dev libxml2-dev libxslt1-dev libffi-dev libpango1.0-0 postgresql postgresql-contrib postgresql-server-dev-13" #================================================= # PERSONAL HELPERS diff --git a/scripts/backup b/scripts/backup index 19f6fe4..1400b1e 100644 --- a/scripts/backup +++ b/scripts/backup @@ -14,22 +14,22 @@ 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) -db_name=$(ynh_app_setting_get --app=$app --key=db_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? db_name=$(ynh_app_setting_get --app=$app --key=db_name) #================================================= # DECLARE DATA AND CONF FILES TO BACKUP @@ -40,7 +40,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 94b1b70..e3151c7 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -13,58 +13,58 @@ 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) # Add settings here as needed by your application -#db_name=$(ynh_app_setting_get --app=$app --key=db_name) +#REMOVEME? #db_name=$(ynh_app_setting_get --app=$app --key=db_name) #db_user=$db_name -#db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd) +#REMOVEME? #db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd) #================================================= # 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 #================================================= @@ -81,28 +81,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 #================================================= @@ -124,9 +126,9 @@ ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$ap #================================================= # 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 30a17b5..d6591af 100644 --- a/scripts/install +++ b/scripts/install @@ -14,46 +14,46 @@ 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 #================================================= -export domain=$YNH_APP_ARG_DOMAIN -export path_url=/ -export admin=$YNH_APP_ARG_ADMIN -export email=$YNH_APP_ARG_EMAIL -export isp_name=$YNH_APP_ARG_ISP_NAME -export isp_site=$YNH_APP_ARG_ISP_SITE +#REMOVEME? export domain=$YNH_APP_ARG_DOMAIN +export path=/ +#REMOVEME? export admin=$YNH_APP_ARG_ADMIN +#REMOVEME? export email=$YNH_APP_ARG_EMAIL +#REMOVEME? export isp_name=$YNH_APP_ARG_ISP_NAME +#REMOVEME? export isp_site=$YNH_APP_ARG_ISP_SITE is_public=1 export secret=$(ynh_string_random 24) -export app=$YNH_APP_INSTANCE_NAME +#REMOVEME? export 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 -export final_path=/opt/$app -test ! -e "$final_path" || ynh_die --message="This path already contains a folder" +export install_dir=/opt/$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 -ynh_app_setting_set --app=$app --key=admin --value=$admin +#REMOVEME? ynh_app_setting_set --app=$app --key=domain --value=$domain +#REMOVEME? ynh_app_setting_set --app=$app --key=path --value=$path +#REMOVEME? ynh_app_setting_set --app=$app --key=admin --value=$admin ynh_app_setting_set --app=$app --key=email --value=$email ynh_app_setting_set --app=$app --key=isp_name --value=$isp_name ynh_app_setting_set --app=$app --key=isp_site --value=$isp_site @@ -63,43 +63,43 @@ ynh_app_setting_set --app=$app --key=isp_site --value=$isp_site #================================================= # 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 ynh_install_python --python_version=$python_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 +#REMOVEME? ynh_system_user_create --username=$app #================================================= # CREATE A POSTGRESQL DATABASE #================================================= -ynh_script_progression --message="Creating a PostgreSQL database..." --weight=1 +#REMOVEME? ynh_script_progression --message="Creating a PostgreSQL database..." --weight=1 export db_name=$(ynh_sanitize_dbid --db_name=$app) export db_user=$db_name -ynh_app_setting_set --app=$app --key=db_name --value=$db_name -ynh_psql_test_if_first_run -ynh_psql_setup_db --db_user=$db_user --db_name=$db_name -export db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) +#REMOVEME? ynh_app_setting_set --app=$app --key=db_name --value=$db_name +#REMOVEME? ynh_psql_test_if_first_run +#REMOVEME? ynh_psql_setup_db --db_user=$db_user --db_name=$db_name +#REMOVEME? export db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) #================================================= # 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 @@ -114,14 +114,14 @@ ynh_add_nginx_config #================================================= # PYTHON DEPENDENCIES #================================================= -ynh_script_progression --message="Installing more dependencies..." --weight=1 +#REMOVEME? ynh_script_progression --message="Installing more dependencies..." --weight=1 -pushd "$final_path" +pushd "$install_dir" ynh_use_python ynh_exec_warn_less $ynh_pip install --upgrade pip ynh_exec_warn_less $ynh_pip install gunicorn - echo "django-auth-ldap<1.4" >> $final_path/requirements.txt - ynh_exec_warn_less $ynh_pip install -r $final_path/requirements.txt + echo "django-auth-ldap<1.4" >> $install_dir/requirements.txt + ynh_exec_warn_less $ynh_pip install -r $install_dir/requirements.txt popd #================================================= @@ -129,33 +129,33 @@ popd #================================================= ynh_script_progression --message="Configuring application..." --weight=1 -export prefix="${path_url#"/"}/" +export prefix="${path#"/"}/" prefix=${prefix%"/"} -ynh_render_template ../conf/local.py.j2 "$final_path/coin/settings_local.py" -ynh_store_file_checksum --file="$final_path/coin/settings_local.py" +ynh_render_template ../conf/local.py.j2 "$install_dir/coin/settings_local.py" +ynh_store_file_checksum --file="$install_dir/coin/settings_local.py" #================================================= # SERVE STATIC FILES IN PRODUCTION MODE #================================================= -ln -s $final_path/$app/static $final_path/static +ln -s $install_dir/$app/static $install_dir/static #================================================= # SETUP DATABASE #================================================= # Set permissions -chown -R $app:www-data $final_path +chown -R $app:www-data $install_dir -pushd $final_path +pushd $install_dir ynh_exec_warn_less $ynh_python manage.py migrate --noinput ynh_exec_warn_less $ynh_python manage.py collectstatic --noinput popd # Set permissions to directory -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" #================================================= # CONFIGURE LOG DIR @@ -170,9 +170,9 @@ chown -R $app:www-data "/var/log/$app" #================================================= ynh_script_progression --message="Adding a configuration file..." --weight=1 -ynh_add_config --template="../conf/gunicorn_config.py" --destination="$final_path/gunicorn_config.py" +ynh_add_config --template="../conf/gunicorn_config.py" --destination="$install_dir/gunicorn_config.py" -chown $app:www-data "$final_path/gunicorn_config.py" +chown $app:www-data "$install_dir/gunicorn_config.py" #================================================= # SETUP SYSTEMD @@ -202,22 +202,22 @@ ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$ap #================================================= # 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 86b1c6d..5496d88 100644 --- a/scripts/remove +++ b/scripts/remove @@ -13,15 +13,15 @@ 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) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name -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? db_name=$(ynh_app_setting_get --app=$app --key=db_name) +#REMOVEME? db_user=$db_name +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) #================================================= # STANDARD REMOVE @@ -47,18 +47,18 @@ ynh_remove_systemd_config #================================================= # REMOVE THE POSTGRESQL DATABASE #================================================= -ynh_script_progression --message="Removing the PostgreSQL database..." --weight=1 +#REMOVEME? ynh_script_progression --message="Removing the PostgreSQL database..." --weight=1 # Remove a database if it exists, along with the associated user -ynh_psql_remove_db --db_user=$db_user --db_name=$db_name +#REMOVEME? ynh_psql_remove_db --db_user=$db_user --db_name=$db_name #================================================= # 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 @@ -71,11 +71,11 @@ ynh_remove_nginx_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_python -ynh_remove_app_dependencies +#REMOVEME? ynh_remove_app_dependencies #================================================= # SPECIFIC REMOVE @@ -92,10 +92,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 51e23ee..3bbec05 100644 --- a/scripts/restore +++ b/scripts/restore @@ -15,68 +15,68 @@ 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 -export app=$YNH_APP_INSTANCE_NAME +#REMOVEME? export app=$YNH_APP_INSTANCE_NAME -export domain=$(ynh_app_setting_get --app=$app --key=domain) -export path_url=$(ynh_app_setting_get --app=$app --key=path) -export final_path=$(ynh_app_setting_get --app=$app --key=final_path) -export db_name=$(ynh_app_setting_get --app=$app --key=db_name) +#REMOVEME? export domain=$(ynh_app_setting_get --app=$app --key=domain) +#REMOVEME? export path=$(ynh_app_setting_get --app=$app --key=path) +#REMOVEME? export install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) +#REMOVEME? export db_name=$(ynh_app_setting_get --app=$app --key=db_name) export db_user=$db_name -export admin=$(ynh_app_setting_get --app=$app --key=admin) -export email=$(ynh_app_setting_get --app=$app --key=email) -export isp_name=$(ynh_app_setting_get --app=$app --key=isp_name) -export isp_site=$(ynh_app_setting_get --app=$app --key=isp_site) -export secret=$(ynh_app_setting_get --app=$app --key=secret) +#REMOVEME? export admin=$(ynh_app_setting_get --app=$app --key=admin) +#REMOVEME? export email=$(ynh_app_setting_get --app=$app --key=email) +#REMOVEME? export isp_name=$(ynh_app_setting_get --app=$app --key=isp_name) +#REMOVEME? export isp_site=$(ynh_app_setting_get --app=$app --key=isp_site) +#REMOVEME? export secret=$(ynh_app_setting_get --app=$app --key=secret) #================================================= # 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 #================================================= # 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 +#REMOVEME? ynh_system_user_create --username=$app #================================================= # 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 ynh_install_python --python_version=$python_version #================================================= @@ -89,24 +89,24 @@ ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= # RESTORE THE POSTGRESQL DATABASE #================================================= -ynh_script_progression --message="Restoring the PostgreSQL database..." --weight=1 +#REMOVEME? ynh_script_progression --message="Restoring the PostgreSQL database..." --weight=1 -export db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) -ynh_psql_test_if_first_run -ynh_psql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd +#REMOVEME? export db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) +#REMOVEME? ynh_psql_test_if_first_run +#REMOVEME? ynh_psql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd ynh_psql_execute_file_as_root --file="./db.sql" --database=$db_name #================================================= # PYTHON DEPENDENCIES #================================================= -ynh_script_progression --message="Installing more dependencies..." --weight=1 +#REMOVEME? ynh_script_progression --message="Installing more dependencies..." --weight=1 -pushd "$final_path" +pushd "$install_dir" ynh_use_python ynh_exec_warn_less $ynh_pip install --upgrade pip ynh_exec_warn_less $ynh_pip install gunicorn - echo "django-auth-ldap<1.4" >> $final_path/requirements.txt - ynh_exec_warn_less $ynh_pip install -r $final_path/requirements.txt + echo "django-auth-ldap<1.4" >> $install_dir/requirements.txt + ynh_exec_warn_less $ynh_pip install -r $install_dir/requirements.txt popd #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 16045d0..f09a137 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -13,21 +13,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 -export app=$YNH_APP_INSTANCE_NAME +#REMOVEME? export app=$YNH_APP_INSTANCE_NAME -export domain=$(ynh_app_setting_get --app=$app --key=domain) -export path_url=$(ynh_app_setting_get --app=$app --key=path) -export admin=$(ynh_app_setting_get --app=$app --key=admin) -export email=$(ynh_app_setting_get --app=$app --key=email) -export isp_name=$(ynh_app_setting_get --app=$app --key=isp_name) -export isp_site=$(ynh_app_setting_get --app=$app --key=isp_site) -export secret=$(ynh_app_setting_get --app=$app --key=secret) -export final_path=$(ynh_app_setting_get --app=$app --key=final_path) -export db_name=$(ynh_app_setting_get --app=$app --key=db_name) +#REMOVEME? export domain=$(ynh_app_setting_get --app=$app --key=domain) +#REMOVEME? export path=$(ynh_app_setting_get --app=$app --key=path) +#REMOVEME? export admin=$(ynh_app_setting_get --app=$app --key=admin) +#REMOVEME? export email=$(ynh_app_setting_get --app=$app --key=email) +#REMOVEME? export isp_name=$(ynh_app_setting_get --app=$app --key=isp_name) +#REMOVEME? export isp_site=$(ynh_app_setting_get --app=$app --key=isp_site) +#REMOVEME? export secret=$(ynh_app_setting_get --app=$app --key=secret) +#REMOVEME? export install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) +#REMOVEME? export db_name=$(ynh_app_setting_get --app=$app --key=db_name) export db_user=$db_name -export db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) +#REMOVEME? export db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) #================================================= # CHECK VERSION @@ -39,16 +39,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 @@ -65,8 +65,8 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 # 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 @@ -74,24 +74,24 @@ fi # If db_name doesn't exist, create it if [ -z "$db_name" ]; then db_name=$(ynh_sanitize_dbid --db_name=$app) - ynh_app_setting_set --app=$app --key=db_name --value=$db_name +#REMOVEME? ynh_app_setting_set --app=$app --key=db_name --value=$db_name fi -# If final_path doesn't exist, create it -if [ -z "$final_path" ]; then - final_path=/opt/$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=/opt/$app +#REMOVEME? ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir fi -ynh_secure_remove --file="${final_path}/venv" +ynh_secure_remove --file="${install_dir}/venv" #================================================= # 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 +#REMOVEME? ynh_system_user_create --username=$app #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE @@ -102,19 +102,19 @@ 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" #================================================= # 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 ynh_install_python --python_version=$python_version #================================================= @@ -132,23 +132,23 @@ ynh_add_nginx_config #================================================= ynh_script_progression --message="Configuring Django..." --weight=1 -export prefix="${path_url#"/"}/" +export prefix="${path#"/"}/" prefix=${prefix%"/"} -ynh_backup_if_checksum_is_different --file="$final_path/coin/settings_local.py" -ynh_render_template ../conf/local.py.j2 "$final_path/coin/setings_local.py" -ynh_store_file_checksum --file="$final_path/coin/settings_local.py" +ynh_backup_if_checksum_is_different --file="$install_dir/coin/settings_local.py" +ynh_render_template ../conf/local.py.j2 "$install_dir/coin/setings_local.py" +ynh_store_file_checksum --file="$install_dir/coin/settings_local.py" #================================================= # PYTHON DEPENDENCIES #================================================= -ynh_script_progression --message="Installing more dependencies..." --weight=1 +#REMOVEME? ynh_script_progression --message="Installing more dependencies..." --weight=1 -pushd "$final_path" +pushd "$install_dir" ynh_use_python ynh_exec_warn_less $ynh_pip install --upgrade pip ynh_exec_warn_less $ynh_pip install gunicorn - echo "django-auth-ldap<1.4" >> $final_path/requirements.txt - ynh_exec_warn_less $ynh_pip install -r $final_path/requirements.txt + echo "django-auth-ldap<1.4" >> $install_dir/requirements.txt + ynh_exec_warn_less $ynh_pip install -r $install_dir/requirements.txt popd #================================================= @@ -156,7 +156,7 @@ popd #================================================= ynh_script_progression --message="Migrating database..." --weight=1 -pushd "$final_path" +pushd "$install_dir" ynh_exec_warn_less $ynh_python manage.py migrate --noinput popd @@ -165,22 +165,22 @@ popd #================================================= ynh_script_progression --message="Collecting files..." --weight=1 -pushd "$final_path" +pushd "$install_dir" ynh_exec_warn_less $ynh_python manage.py collectstatic --noinput popd -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" #================================================ # UPDATE A CONFIG FILE #================================================= ynh_script_progression --message="Updating a configuration file..." --weight=1 -ynh_add_config --template="../conf/gunicorn_config.py" --destination="$final_path/gunicorn_config.py" +ynh_add_config --template="../conf/gunicorn_config.py" --destination="$install_dir/gunicorn_config.py" -chown $app:www-data "$final_path/gunicorn_config.py" +chown $app:www-data "$install_dir/gunicorn_config.py" #================================================= # SETUP SYSTEMD @@ -209,9 +209,9 @@ ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$ap #================================================= # 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