diff --git a/README.md b/README.md index 27eecb8..7048f54 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It shall NOT be edited by hand. # Coin for YunoHost -[![Integration level](https://dash.yunohost.org/integration/coin.svg)](https://dash.yunohost.org/appci/app/coin) ![](https://ci-apps.yunohost.org/ci/badges/coin.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/coin.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/coin.svg)](https://dash.yunohost.org/appci/app/coin) ![Working status](https://ci-apps.yunohost.org/ci/badges/coin.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/coin.maintain.svg) [![Install Coin with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=coin) *[Lire ce readme en français.](./README_fr.md)* @@ -20,28 +20,27 @@ COIN is an Information System designed for associative ISPs in the FFDN. **Shipped version:** 20220401~ynh1 - - ## Screenshots -![](./doc/screenshots/user-subscriptions.png) +![Screenshot of Coin](./doc/screenshots/user-subscriptions.png) ## Documentation and resources -* Official app website: https://code.ffdn.org/FFDN/coin -* Upstream app code repository: https://code.ffdn.org/ffdn/coin -* YunoHost documentation for this app: https://yunohost.org/app_coin -* Report a bug: https://github.com/YunoHost-Apps/coin_ynh/issues +* Official app website: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/coin_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/coin_ynh/tree/testing --debug or sudo yunohost app upgrade coin -u https://github.com/YunoHost-Apps/coin_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 2c89de5..80b9be1 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,10 +1,14 @@ + + # Coin pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/coin.svg)](https://dash.yunohost.org/appci/app/coin) ![](https://ci-apps.yunohost.org/ci/badges/coin.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/coin.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/coin.svg)](https://dash.yunohost.org/appci/app/coin) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/coin.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/coin.maintain.svg) [![Installer Coin avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=coin) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* > *Ce package vous permet d'installer Coin 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.* @@ -16,28 +20,27 @@ COIN is an Information System designed for associative ISPs in the FFDN. **Version incluse :** 20220401~ynh1 - - ## Captures d'écran -![](./doc/screenshots/user-subscriptions.png) +![Capture d'écran de Coin](./doc/screenshots/user-subscriptions.png) ## Documentations et ressources -* Site officiel de l'app : https://code.ffdn.org/FFDN/coin -* Dépôt de code officiel de l'app : https://code.ffdn.org/ffdn/coin -* Documentation YunoHost pour cette app : https://yunohost.org/app_coin -* Signaler un bug : https://github.com/YunoHost-Apps/coin_ynh/issues +* Site officiel de l'app : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/coin_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/coin_ynh/tree/testing --debug ou sudo yunohost app upgrade coin -u https://github.com/YunoHost-Apps/coin_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 :** diff --git a/check_process b/check_process index 79b9d7e..894a568 100644 --- a/check_process +++ b/check_process @@ -6,7 +6,7 @@ email="john@example.com" isp_name="ARN" isp_site="https://arn-fai.net" - ; Checks + ; Checks pkg_linter=1 setup_sub_dir=0 setup_root=1 @@ -15,7 +15,7 @@ setup_public=0 upgrade=1 # 20200630~ynh1 - upgrade=1 from_commit=41916dc245ca37d999782cc2bc46a3a6ea9fa1c8 + #upgrade=1 from_commit=41916dc245ca37d999782cc2bc46a3a6ea9fa1c8 backup_restore=1 multi_instance=0 port_already_use=0 diff --git a/conf/gunicorn.service b/conf/gunicorn.service index 65206c2..87ba5fa 100644 --- a/conf/gunicorn.service +++ b/conf/gunicorn.service @@ -7,7 +7,7 @@ PIDFile=/run/gunicorn/YNH_APP_INSTANCE_NAME-pid User=YNH_APP_INSTANCE_NAME Group=www-data WorkingDirectory=/opt/YNH_APP_INSTANCE_NAME -ExecStart=/opt/YNH_APP_INSTANCE_NAME/venv/bin/gunicorn -c /opt/YNH_APP_INSTANCE_NAME/gunicorn_config.py YNH_APP_INSTANCE_NAME.wsgi +ExecStart=__YNH_PYTHON_PATH__/gunicorn -c /opt/YNH_APP_INSTANCE_NAME/gunicorn_config.py YNH_APP_INSTANCE_NAME.wsgi ExecReload=/bin/kill -s HUP $MAINPID ExecStop=/bin/kill -s TERM $MAINPID PrivateTmp=true diff --git a/conf/gunicorn_config.py b/conf/gunicorn_config.py index 6945d8c..d1c2a5d 100644 --- a/conf/gunicorn_config.py +++ b/conf/gunicorn_config.py @@ -1,4 +1,4 @@ -command = '/opt/__APP__/venv/bin/gunicorn' +command = '__YNH_PYTHON_PATH__/gunicorn' pythonpath = '/opt/__APP__' workers = 4 user = '__APP__' diff --git a/conf/nginx.conf b/conf/nginx.conf index 3947dc2..6f929db 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,23 +1,23 @@ #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; location __PATH__/ { - try_files $uri @__NAME__; + try_files $uri @__NAME__; } location __PATH__/protected/ { internal; - alias /opt/__NAME__/__NAME__/smedia/; + alias __FINALPATH__/__NAME__/smedia/; } location __PATH__/media/ { - alias /opt/__NAME__/media/; + alias __FINALPATH__/media/; } location __PATH__/static/ { - alias /opt/__NAME__/static/; + alias __FINALPATH__/static/; } location __PATH__/assets/ { - alias /opt/__NAME__/static/; + alias __FINALPATH__/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:/opt/__NAME__/sock; + proxy_pass http://unix:__FINALPATH__/sock; } diff --git a/conf/systemd.service b/conf/systemd.service index b2e15da..3e1d373 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -7,7 +7,7 @@ PIDFile=/run/gunicorn/__APP__-pid User=__APP__ Group=__APP__ WorkingDirectory=__FINALPATH__/ -ExecStart=__FINALPATH__/venv/bin/gunicorn -c __FINALPATH__/gunicorn_config.py __APP__.wsgi +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 diff --git a/manifest.json b/manifest.json index ddfda31..a5154dc 100644 --- a/manifest.json +++ b/manifest.json @@ -20,14 +20,14 @@ "url": "https://www.arn-fai.net" }, "requirements": { - "yunohost": ">= 4.3.0" + "yunohost": ">= 11.0.0" }, "multi_instance": true, "services": [ "nginx" ], "arguments": { - "install" : [ + "install": [ { "name": "domain", "type": "domain" diff --git a/scripts/_common.sh b/scripts/_common.sh index d235102..ba3926a 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -4,8 +4,10 @@ # COMMON VARIABLES #================================================= +python_version=2.7.18 + # dependencies used by the app -pkg_dependencies="python-virtualenv gunicorn python-dev python-pip libldap2-dev libpq-dev libsasl2-dev libjpeg-dev libxml2-dev libxslt1-dev libffi-dev python-cairo libpango1.0-0 postgresql postgresql-contrib postgresql-server-dev-11" +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 e04cdd4..19f6fe4 100644 --- a/scripts/backup +++ b/scripts/backup @@ -6,7 +6,7 @@ # IMPORT GENERIC HELPERS #================================================= -#Keep this path for calling _common.sh inside the execution's context of backup and restore scripts +# 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 @@ -57,7 +57,7 @@ ynh_backup --src_path="/etc/systemd/system/$app.service" #================================================= # BACKUP THE POSTGRESQL DATABASE #================================================= -ynh_print_info --message="Backing up the PSQL database..." +ynh_print_info --message="Backing up the PostgreSQL database..." ynh_psql_dump_db --database="$db_name" > db.sql diff --git a/scripts/change_url b/scripts/change_url index bb9d67a..94b1b70 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -24,7 +24,7 @@ app=$YNH_APP_INSTANCE_NAME #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." +ynh_script_progression --message="Loading installation settings..." --weight=1 # Needed for helper "ynh_add_nginx_config" final_path=$(ynh_app_setting_get --app=$app --key=final_path) @@ -37,12 +37,11 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path) #================================================= # BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP #================================================= -ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." +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 () { - ynh_clean_check_starting # 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" @@ -73,14 +72,14 @@ fi #================================================= # STOP SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Stopping a systemd service..." +ynh_script_progression --message="Stopping a systemd service..." --weight=1 ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log" #================================================= # MODIFY URL IN NGINX CONF #================================================= -ynh_script_progression --message="Updating NGINX web server configuration..." +ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1 nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf @@ -117,7 +116,7 @@ fi #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting a systemd service..." +ynh_script_progression --message="Starting a systemd service..." --weight=1 # Start a systemd service ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" @@ -125,7 +124,7 @@ ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$ap #================================================= # RELOAD NGINX #================================================= -ynh_script_progression --message="Reloading NGINX web server..." +ynh_script_progression --message="Reloading NGINX web server..." --weight=1 ynh_systemd_action --service_name=nginx --action=reload @@ -133,4 +132,4 @@ ynh_systemd_action --service_name=nginx --action=reload # END OF SCRIPT #================================================= -ynh_script_progression --message="Change of URL completed for $app" +ynh_script_progression --message="Change of URL completed for $app" --last diff --git a/scripts/install b/scripts/install index ad71ecb..30a17b5 100644 --- a/scripts/install +++ b/scripts/install @@ -7,6 +7,7 @@ #================================================= source _common.sh +source ynh_install_python source /usr/share/yunohost/helpers #================================================= @@ -14,7 +15,7 @@ source /usr/share/yunohost/helpers #================================================= ynh_clean_setup () { - ynh_clean_check_starting + true } # Exit if an error occurs during the execution of the script ynh_abort_if_errors @@ -37,7 +38,7 @@ export app=$YNH_APP_INSTANCE_NAME #================================================= # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS #================================================= -ynh_script_progression --message="Validating installation parameters..." +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" @@ -48,7 +49,7 @@ ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url #================================================= # STORE SETTINGS FROM MANIFEST #================================================= -ynh_script_progression --message="Storing installation settings..." +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 @@ -62,14 +63,15 @@ ynh_app_setting_set --app=$app --key=isp_site --value=$isp_site #================================================= # INSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Installing dependencies..." +ynh_script_progression --message="Installing dependencies..." --weight=1 ynh_install_app_dependencies $pkg_dependencies +ynh_install_python --python_version=$python_version #================================================= # CREATE DEDICATED USER #================================================= -ynh_script_progression --message="Configuring system user..." +ynh_script_progression --message="Configuring system user..." --weight=1 # Create a system user ynh_system_user_create --username=$app @@ -77,20 +79,19 @@ ynh_system_user_create --username=$app #================================================= # CREATE A POSTGRESQL DATABASE #================================================= -ynh_script_progression --message="Creating a PostgreSQL database..." - -ynh_psql_test_if_first_run +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) #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= -ynh_script_progression --message="Setting up source files..." +ynh_script_progression --message="Setting up source files..." --weight=1 ynh_app_setting_set --app=$app --key=final_path --value=$final_path # Download, check integrity, uncompress and patch the source from app.src @@ -103,7 +104,7 @@ chown -R $app:www-data "$final_path" #================================================= # NGINX CONFIGURATION #================================================= -ynh_script_progression --message="Configuring NGINX web server..." +ynh_script_progression --message="Configuring NGINX web server..." --weight=1 # Create a dedicated NGINX config ynh_add_nginx_config @@ -113,24 +114,20 @@ ynh_add_nginx_config #================================================= # PYTHON DEPENDENCIES #================================================= -ynh_script_progression --message="Installing more dependencies..." +ynh_script_progression --message="Installing more dependencies..." --weight=1 -virtualenv "$final_path/venv" -( - set +o nounset - source "${final_path}/venv/bin/activate" - set -o nounset - - $final_path/venv/bin/pip install --upgrade pip - $final_path/venv/bin/pip install gunicorn - echo "django-auth-ldap<1.4" >> $final_path/requirements.txt - $final_path/venv/bin/pip install -r $final_path/requirements.txt -) +pushd "$final_path" + 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 +popd #================================================= # CONFIGURATION DJANGO #================================================= -ynh_script_progression --message="Configuring application..." +ynh_script_progression --message="Configuring application..." --weight=1 export prefix="${path_url#"/"}/" prefix=${prefix%"/"} @@ -151,8 +148,8 @@ ln -s $final_path/$app/static $final_path/static chown -R $app:www-data $final_path pushd $final_path - $final_path/venv/bin/python manage.py migrate --noinput - $final_path/venv/bin/python manage.py collectstatic --noinput + 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 @@ -160,18 +157,18 @@ chmod 750 "$final_path" chmod -R o-rwx "$final_path" chown -R $app:www-data "$final_path" -#================================================ +#================================================= # CONFIGURE LOG DIR -#================================================ +#================================================= mkdir -p /var/log/$app chown -R $app /var/log/$app chown -R $app:www-data "/var/log/$app" -#================================================ +#================================================= # ADD A CONFIGURATION #================================================= -ynh_script_progression --message="Adding a configuration file..." +ynh_script_progression --message="Adding a configuration file..." --weight=1 ynh_add_config --template="../conf/gunicorn_config.py" --destination="$final_path/gunicorn_config.py" @@ -180,7 +177,7 @@ chown $app:www-data "$final_path/gunicorn_config.py" #================================================= # SETUP SYSTEMD #================================================= -ynh_script_progression --message="Configuring a systemd service..." +ynh_script_progression --message="Configuring a systemd service..." --weight=1 # Create a dedicated systemd config ynh_add_systemd_config @@ -190,14 +187,14 @@ ynh_add_systemd_config #================================================= # INTEGRATE SERVICE IN YUNOHOST #================================================= -ynh_script_progression --message="Integrating service in YunoHost..." +ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 yunohost service add $app --description "$app daemon" --log="/var/log/$app/$app.log" #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting a systemd service..." +ynh_script_progression --message="Starting a systemd service..." --weight=1 # Start a systemd service ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" @@ -205,7 +202,7 @@ ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$ap #================================================= # SETUP SSOWAT #================================================= -ynh_script_progression --message="Configuring permissions..." +ynh_script_progression --message="Configuring permissions..." --weight=1 # Make app public if necessary if [ $is_public -eq 1 ] @@ -218,7 +215,7 @@ fi #================================================= # RELOAD NGINX #================================================= -ynh_script_progression --message="Reloading NGINX web server..." +ynh_script_progression --message="Reloading NGINX web server..." --weight=1 ynh_systemd_action --service_name=nginx --action=reload @@ -226,4 +223,4 @@ ynh_systemd_action --service_name=nginx --action=reload # END OF SCRIPT #================================================= -ynh_script_progression --message="Installation of $app completed" +ynh_script_progression --message="Installation of $app completed" --last diff --git a/scripts/remove b/scripts/remove index 857674c..86b1c6d 100644 --- a/scripts/remove +++ b/scripts/remove @@ -7,12 +7,13 @@ #================================================= source _common.sh +source ynh_install_python source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." +ynh_script_progression --message="Loading installation settings..." --weight=1 app=$YNH_APP_INSTANCE_NAME @@ -31,14 +32,14 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path) # 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..." + 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..." +ynh_script_progression --message="Stopping and removing the systemd service..." --weight=1 # Remove the dedicated systemd config ynh_remove_systemd_config @@ -46,7 +47,7 @@ ynh_remove_systemd_config #================================================= # REMOVE THE POSTGRESQL DATABASE #================================================= -ynh_script_progression --message="Removing the PostgreSQL database..." +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 @@ -54,7 +55,7 @@ ynh_psql_remove_db --db_user=$db_user --db_name=$db_name #================================================= # REMOVE APP MAIN DIR #================================================= -ynh_script_progression --message="Removing app main directory..." +ynh_script_progression --message="Removing app main directory..." --weight=1 # Remove the app directory securely ynh_secure_remove --file="$final_path" @@ -62,7 +63,7 @@ ynh_secure_remove --file="$final_path" #================================================= # REMOVE NGINX CONFIGURATION #================================================= -ynh_script_progression --message="Removing NGINX web server configuration..." +ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1 # Remove the dedicated NGINX config ynh_remove_nginx_config @@ -70,9 +71,10 @@ ynh_remove_nginx_config #================================================= # REMOVE DEPENDENCIES #================================================= -ynh_script_progression --message="Removing dependencies..." +ynh_script_progression --message="Removing dependencies..." --weight=1 # Remove metapackage and its dependencies +ynh_remove_python ynh_remove_app_dependencies #================================================= @@ -80,7 +82,7 @@ ynh_remove_app_dependencies #================================================= # REMOVE VARIOUS FILES #================================================= -ynh_script_progression --message="Removing various files..." +ynh_script_progression --message="Removing various files..." --weight=1 # Remove the log files ynh_secure_remove --file="/var/log/$app" @@ -90,7 +92,7 @@ ynh_secure_remove --file="/var/log/$app" #================================================= # REMOVE DEDICATED USER #================================================= -ynh_script_progression --message="Removing the dedicated system user..." +ynh_script_progression --message="Removing the dedicated system user..." --weight=1 # Delete a system user ynh_system_user_delete --username=$app @@ -99,4 +101,4 @@ ynh_system_user_delete --username=$app # END OF SCRIPT #================================================= -ynh_script_progression --message="Removal of $app completed" +ynh_script_progression --message="Removal of $app completed" --last diff --git a/scripts/restore b/scripts/restore index 7c603a8..51e23ee 100644 --- a/scripts/restore +++ b/scripts/restore @@ -6,8 +6,9 @@ # IMPORT GENERIC HELPERS #================================================= -#Keep this path for calling _common.sh inside the execution's context of backup and restore scripts +# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts source ../settings/scripts/_common.sh +source ../settings/scripts/ynh_install_python source /usr/share/yunohost/helpers #================================================= @@ -15,7 +16,7 @@ source /usr/share/yunohost/helpers #================================================= ynh_clean_setup () { - ynh_clean_check_starting + true } # Exit if an error occurs during the execution of the script ynh_abort_if_errors @@ -23,7 +24,7 @@ ynh_abort_if_errors #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading settings..." +ynh_script_progression --message="Loading installation settings..." --weight=1 export app=$YNH_APP_INSTANCE_NAME @@ -41,24 +42,17 @@ export secret=$(ynh_app_setting_get --app=$app --key=secret) #================================================= # CHECK IF THE APP CAN BE RESTORED #================================================= -ynh_script_progression --message="Validating restoration parameters..." +ynh_script_progression --message="Validating restoration parameters..." --weight=1 test ! -d $final_path \ || ynh_die --message="There is already a directory: $final_path " #================================================= # STANDARD RESTORATION STEPS -#================================================= -# RESTORE THE NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Restoring the NGINX web server configuration..." - -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..." +ynh_script_progression --message="Recreating the dedicated system user..." --weight=1 # Create the dedicated user (if not existing) ynh_system_user_create --username=$app @@ -66,7 +60,7 @@ ynh_system_user_create --username=$app #================================================= # RESTORE THE APP MAIN DIR #================================================= -ynh_script_progression --message="Restoring the app main directory..." +ynh_script_progression --message="Restoring the app main directory..." --weight=1 ynh_restore_file --origin_path="$final_path" @@ -79,33 +73,53 @@ chown -R $app:www-data "$final_path" #================================================= # REINSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Reinstalling dependencies..." +ynh_script_progression --message="Reinstalling dependencies..." --weight=1 # Define and install dependencies ynh_install_app_dependencies $pkg_dependencies +ynh_install_python --python_version=$python_version + +#================================================= +# RESTORE THE NGINX CONFIGURATION +#================================================= +ynh_script_progression --message="Restoring the NGINX web server configuration..." --weight=1 + +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..." - -ynh_psql_test_if_first_run +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 -ynh_psql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql +ynh_psql_execute_file_as_root --file="./db.sql" --database=$db_name + +#================================================= +# PYTHON DEPENDENCIES +#================================================= +ynh_script_progression --message="Installing more dependencies..." --weight=1 + +pushd "$final_path" + 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 +popd #================================================= # RESTORE SYSTEMD #================================================= -ynh_script_progression --message="Restoring the systemd configuration..." +ynh_script_progression --message="Restoring the systemd configuration..." --weight=1 ynh_restore_file --origin_path="/etc/systemd/system/$app.service" systemctl enable $app.service --quiet -#================================================ +#================================================= # CONFIGURE LOG DIR -#================================================ +#================================================= mkdir -p /var/log/$app chown -R $app /var/log/$app @@ -114,14 +128,14 @@ chgrp -R www-data /var/log/$app #================================================= # INTEGRATE SERVICE IN YUNOHOST #================================================= -ynh_script_progression --message="Integrating service in YunoHost..." +ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 yunohost service add $app --description "$app daemon" --log="/var/log/$app/$app.log" #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting a systemd service..." +ynh_script_progression --message="Starting a systemd service..." --weight=1 ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" @@ -130,7 +144,7 @@ ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$ap #================================================= # RELOAD NGINX #================================================= -ynh_script_progression --message="Reloading NGINX web server..." +ynh_script_progression --message="Reloading NGINX web server..." --weight=1 ynh_systemd_action --service_name=nginx --action=reload @@ -138,4 +152,4 @@ ynh_systemd_action --service_name=nginx --action=reload # END OF SCRIPT #================================================= -ynh_script_progression --message="Restoration completed for $app" +ynh_script_progression --message="Restoration completed for $app" --last diff --git a/scripts/upgrade b/scripts/upgrade index 5ed85a1..16045d0 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -7,12 +7,13 @@ #================================================= source _common.sh +source ynh_install_python source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." +ynh_script_progression --message="Loading installation settings..." --weight=1 export app=$YNH_APP_INSTANCE_NAME @@ -31,19 +32,18 @@ export db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) #================================================= # CHECK VERSION #================================================= -ynh_script_progression --message="Checking version..." +ynh_script_progression --message="Checking version..." --weight=1 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)..." +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 () { - ynh_clean_check_starting # Restore it if the upgrade fails ynh_restore_upgradebackup } @@ -55,14 +55,14 @@ ynh_abort_if_errors #================================================= # STOP SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Stopping a systemd service..." +ynh_script_progression --message="Stopping a systemd service..." --weight=1 ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log" #================================================= # ENSURE DOWNWARD COMPATIBILITY #================================================= -ynh_script_progression --message="Ensuring downward compatibility..." +ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 # Cleaning legacy permissions if ynh_legacy_permissions_exists; then @@ -83,10 +83,12 @@ if [ -z "$final_path" ]; then ynh_app_setting_set --app=$app --key=final_path --value=$final_path fi +ynh_secure_remove --file="${final_path}/venv" + #================================================= # CREATE DEDICATED USER #================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." +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 @@ -97,7 +99,7 @@ ynh_system_user_create --username=$app if [ "$upgrade_type" == "UPGRADE_APP" ] then - ynh_script_progression --message="Upgrading source files..." + 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" @@ -107,27 +109,28 @@ chmod 750 "$final_path" chmod -R o-rwx "$final_path" chown -R $app:www-data "$final_path" +#================================================= +# UPGRADE DEPENDENCIES +#================================================= +ynh_script_progression --message="Upgrading dependencies..." --weight=1 + +ynh_install_app_dependencies $pkg_dependencies +ynh_install_python --python_version=$python_version + #================================================= # NGINX CONFIGURATION #================================================= -ynh_script_progression --message="Upgrading NGINX web server configuration..." +ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1 # Create a dedicated NGINX config ynh_add_nginx_config -#================================================= -# UPGRADE DEPENDENCIES -#================================================= -ynh_script_progression --message="Upgrading dependencies..." - -ynh_install_app_dependencies $pkg_dependencies - #================================================= # SPECIFIC UPGRADE #================================================= # CONFIGURE DJANGO #================================================= -ynh_script_progression --message="Configuring Django..." +ynh_script_progression --message="Configuring Django..." --weight=1 export prefix="${path_url#"/"}/" prefix=${prefix%"/"} @@ -135,36 +138,36 @@ 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" -virtualenv "$final_path/venv" -( - set +o nounset - source "${final_path}/venv/bin/activate" - set -o nounset - - #================================================= - # PYTHON DEPENDENCIES - #================================================= - ynh_script_progression --message="Installing more dependencies..." +#================================================= +# PYTHON DEPENDENCIES +#================================================= +ynh_script_progression --message="Installing more dependencies..." --weight=1 - echo "django-auth-ldap<1.4" >> $final_path/requirements.txt - $final_path/venv/bin/pip install -r $final_path/requirements.txt - - #================================================= - # MIGRATE DB - #================================================= - ynh_script_progression --message="Migrating database..." +pushd "$final_path" + 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 +popd - pushd $final_path - $final_path/venv/bin/python manage.py migrate --noinput - - #================================================= - # COLLECT FILES - #================================================= - ynh_script_progression --message="Collecting files..." +#================================================= +# MIGRATE DB +#================================================= +ynh_script_progression --message="Migrating database..." --weight=1 - $final_path/venv/bin/python manage.py collectstatic --noinput - popd -) +pushd "$final_path" + ynh_exec_warn_less $ynh_python manage.py migrate --noinput +popd + +#================================================= +# COLLECT FILES +#================================================= +ynh_script_progression --message="Collecting files..." --weight=1 + +pushd "$final_path" + ynh_exec_warn_less $ynh_python manage.py collectstatic --noinput +popd chmod 750 "$final_path" chmod -R o-rwx "$final_path" @@ -173,7 +176,7 @@ chown -R $app:www-data "$final_path" #================================================ # UPDATE A CONFIG FILE #================================================= -ynh_script_progression --message="Updating a configuration 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" @@ -182,7 +185,7 @@ chown $app:www-data "$final_path/gunicorn_config.py" #================================================= # SETUP SYSTEMD #================================================= -ynh_script_progression --message="Upgrading systemd configuration..." +ynh_script_progression --message="Upgrading systemd configuration..." --weight=1 # Create a dedicated systemd config ynh_add_systemd_config @@ -192,21 +195,21 @@ ynh_add_systemd_config #================================================= # INTEGRATE SERVICE IN YUNOHOST #================================================= -ynh_script_progression --message="Integrating service in YunoHost..." +ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 yunohost service add $app --description "$app daemon" --log="/var/log/$app/$app.log" #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting a systemd service..." +ynh_script_progression --message="Starting a systemd service..." --weight=1 ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" #================================================= # RELOAD NGINX #================================================= -ynh_script_progression --message="Reloading NGINX web server..." +ynh_script_progression --message="Reloading NGINX web server..." --weight=1 ynh_systemd_action --service_name=nginx --action=reload @@ -214,4 +217,4 @@ ynh_systemd_action --service_name=nginx --action=reload # END OF SCRIPT #================================================= -ynh_script_progression --message="Upgrade of $app completed" +ynh_script_progression --message="Upgrade of $app completed" --last diff --git a/scripts/ynh_install_python b/scripts/ynh_install_python new file mode 100644 index 0000000..5747fd5 --- /dev/null +++ b/scripts/ynh_install_python @@ -0,0 +1,267 @@ +#!/bin/bash + +ynh_python_try_bash_extension() { + if [ -x src/configure ]; then + src/configure && make -C src || { + ynh_print_info --message="Optional bash extension failed to build, but things will still work normally." + } + fi +} + +pyenv_install_dir="/opt/pyenv" +python_version_path="$pyenv_install_dir/versions" +# PYENV_ROOT is the directory of pyenv, it needs to be loaded as a environment variable. +export PYENV_ROOT="$pyenv_install_dir" +export pyenv_root="$pyenv_install_dir" + +# Required dependencies +pyenv_dependencies="make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev git" + +# Load the version of Python for an app, and set variables. +# +# ynh_use_python has to be used in any app scripts before using Python for the first time. +# This helper will provide alias and variables to use in your scripts. +# +# To use pip or Python, use the alias `ynh_pip` and `ynh_python` +# Those alias will use the correct version installed for the app +# For example: use `ynh_pip install` instead of `pip install` +# +# With `sudo` or `ynh_exec_as`, use instead the fallback variables `$ynh_pip` and `$ynh_python` +# And propagate $PATH to sudo with $ynh_python_load_path +# Exemple: `ynh_exec_as $app $ynh_python_load_path $ynh_pip install` +# +# $PATH contains the path of the requested version of Python. +# However, $PATH is duplicated into $ynh_python_path to outlast any manipulation of $PATH +# You can use the variable `$ynh_python_load_path` to quickly load your Python version +# in $PATH for an usage into a separate script. +# Exemple: $ynh_python_load_path $final_path/script_that_use_pip.sh` +# +# +# Finally, to start a Python service with the correct version, 2 solutions +# Either the app is dependent of python or pip, but does not called it directly. +# In such situation, you need to load PATH +# `Environment="__YNH_PYTHON_LOAD_PATH__"` +# `ExecStart=__FINALPATH__/my_app` +# You will replace __YNH_PYTHON_LOAD_PATH__ with $ynh_python_load_path +# +# Or Python start the app directly, then you don't need to load the PATH variable +# `ExecStart=__YNH_PYTHON__ my_app run` +# You will replace __YNH_PYTHON__ with $ynh_python +# +# one other variable is also available +# - $ynh_python_path: The absolute path to Python binaries for the chosen version. +# +# usage: ynh_use_python +# +# Requires YunoHost version 3.2.2 or higher. +ynh_use_python () { + python_version=$(ynh_app_setting_get --app=$app --key=python_version) + + # Get the absolute path of this version of Python + ynh_python_path="$python_version_path/$YNH_APP_INSTANCE_NAME/bin" + + # Allow alias to be used into bash script + shopt -s expand_aliases + + # Create an alias for the specific version of Python and a variable as fallback + ynh_python="$ynh_python_path/python" + alias ynh_python="$ynh_python" + # And pip + ynh_pip="$ynh_python_path/pip" + alias ynh_pip="$ynh_pip" + + # Load the path of this version of Python in $PATH + if [[ :$PATH: != *":$ynh_python_path"* ]]; then + PATH="$ynh_python_path:$PATH" + fi + # Create an alias to easily load the PATH + ynh_python_load_path="PATH=$PATH" + + # Sets the local application-specific Python version + pushd $final_path + $pyenv_install_dir/bin/pyenv local $python_version + popd +} + +# Install a specific version of Python +# +# ynh_install_python will install the version of Python provided as argument by using pyenv. +# +# This helper creates a /etc/profile.d/pyenv.sh that configures PATH environment for pyenv +# for every LOGIN user, hence your user must have a defined shell (as opposed to /usr/sbin/nologin) +# +# Don't forget to execute python-dependent command in a login environment +# (e.g. sudo --login option) +# When not possible (e.g. in systemd service definition), please use direct path +# to pyenv shims (e.g. $PYENV_ROOT/shims/bundle) +# +# usage: ynh_install_python --python_version=python_version +# | arg: -v, --python_version= - Version of Python to install. +# +# Requires YunoHost version 3.2.2 or higher. +ynh_install_python () { + # Declare an array to define the options of this helper. + local legacy_args=v + local -A args_array=( [v]=python_version= ) + local python_version + # Manage arguments with getopts + ynh_handle_getopts_args "$@" + + # Install required dependencies + ynh_add_app_dependencies --package="$pyenv_dependencies" + + # Load pyenv path in PATH + local CLEAR_PATH="$pyenv_install_dir/bin:$PATH" + + # Remove /usr/local/bin in PATH in case of Python prior installation + PATH=$(echo $CLEAR_PATH | sed 's@/usr/local/bin:@@') + + # Move an existing Python binary, to avoid to block pyenv + #test -x /usr/bin/python && mv /usr/bin/python /usr/bin/python_pyenv + + # Install or update pyenv + pyenv="$(command -v pyenv $pyenv_install_dir/bin/pyenv | head -1)" + if [ -n "$pyenv" ]; then + ynh_print_info --message="pyenv already seems installed in \`$pyenv'." + pushd "${pyenv%/*/*}" + if git remote -v 2>/dev/null | grep "https://github.com/pyenv/pyenv.git"; then + ynh_print_info --message="Trying to update with git..." + git pull -q --tags origin master + cd .. + ynh_python_try_bash_extension + fi + popd + else + ynh_print_info --message="Installing pyenv with git..." + mkdir -p $pyenv_install_dir + pushd $pyenv_install_dir + git init -q + git remote add -f -t master origin https://github.com/pyenv/pyenv.git > /dev/null 2>&1 + git checkout -q -b master origin/master + ynh_python_try_bash_extension + pyenv=$pyenv_install_dir/bin/pyenv + popd + fi + + pyenv_virtualenv="$(command -v "$pyenv_install_dir"/plugins/*/bin/pyenv-virtualenv pyenv-virtualenv | head -1)" + if [ -n "$pyenv_virtualenv" ]; then + ynh_print_info --message="\`pyenv virtualenv' command already available in \`$pyenv_virtualenv'." + pushd "${pyenv_virtualenv%/*/*}" + if git remote -v 2>/dev/null | grep "https://github.com/pyenv/pyenv-virtualenv.git"; then + ynh_print_info --message="Trying to update pyenv-virtualenv with git..." + git pull -q origin master + fi + popd + else + ynh_print_info --message="Installing pyenv-virtualenv with git..." + mkdir -p "${pyenv_install_dir}/plugins" + git clone -q https://github.com/pyenv/pyenv-virtualenv.git "${pyenv_install_dir}/plugins/pyenv-virtualenv" + fi + + # Enable caching + mkdir -p "${pyenv_install_dir}/cache" + + # Create shims directory if needed + mkdir -p "${pyenv_install_dir}/shims" + chmod -R a+w "${pyenv_install_dir}/shims" + + # Restore /usr/local/bin in PATH + PATH=$CLEAR_PATH + + # And replace the old Python binary + # test -x /usr/bin/python_pyenv && mv /usr/bin/python_pyenv /usr/bin/python + + # Install the requested version of Python + ynh_print_info --message="Installation of Python-$python_version" + pyenv install --skip-existing $python_version > /dev/null 2>&1 + + # Store python_version into the config of this app + ynh_app_setting_set --app=$YNH_APP_INSTANCE_NAME --key=python_version --value=$python_version + + # Remove app virtualenv + if `pyenv virtualenvs | grep --quiet "$YNH_APP_INSTANCE_NAME " 1>/dev/null 2>&1` + then + pyenv virtualenv-delete --force $YNH_APP_INSTANCE_NAME + fi + + # Create app virtualenv + pyenv virtualenv --force $python_version $YNH_APP_INSTANCE_NAME + + # Cleanup Python versions + ynh_cleanup_python + + # Set environment for Python users + echo "#pyenv +export PYENV_ROOT=$pyenv_install_dir +export PATH=\"$pyenv_install_dir/bin:$PATH\" +eval \"\$(pyenv init -)\" +#pyenv" > /etc/profile.d/pyenv.sh + + # Load the environment + eval "$(pyenv init -)" +} + +# Remove the version of Python used by the app. +# +# This helper will also cleanup Python versions +# +# usage: ynh_remove_python +ynh_remove_python () { + local python_version=$(ynh_app_setting_get --app=$YNH_APP_INSTANCE_NAME --key=python_version) + + # Load pyenv path in PATH + local CLEAR_PATH="$pyenv_install_dir/bin:$PATH" + + # Remove /usr/local/bin in PATH in case of Python prior installation + PATH=$(echo $CLEAR_PATH | sed 's@/usr/local/bin:@@') + + pyenv virtualenv-delete --force $YNH_APP_INSTANCE_NAME + + # Remove the line for this app + ynh_app_setting_delete --app=$YNH_APP_INSTANCE_NAME --key=python_version + + # Cleanup Python versions + ynh_cleanup_python +} + +# Remove no more needed versions of Python used by the app. +# +# This helper will check what Python version are no more required, +# and uninstall them +# If no app uses Python, pyenv will be also removed. +# +# usage: ynh_cleanup_python +ynh_cleanup_python () { + + # List required Python versions + local installed_apps=$(yunohost app list | grep -oP 'id: \K.*$') + local required_python_versions="" + for installed_app in $installed_apps + do + local installed_app_python_version=$(ynh_app_setting_get --app=$installed_app --key="python_version") + if [[ $installed_app_python_version ]] + then + required_python_versions="${installed_app_python_version}\n${required_python_versions}" + fi + done + + # Remove no more needed Python versions + local installed_python_versions=$(pyenv versions --bare --skip-aliases | grep -Ev '/') + for installed_python_version in $installed_python_versions + do + if ! `echo ${required_python_versions} | grep "${installed_python_version}" 1>/dev/null 2>&1` + then + ynh_print_info --message="Removing of Python-$installed_python_version" + $pyenv_install_dir/bin/pyenv uninstall --force $installed_python_version + fi + done + + # If none Python version is required + if [[ ! $required_python_versions ]] + then + # Remove pyenv environment configuration + ynh_print_info --message="Removing of pyenv-$pyenv_version" + ynh_secure_remove --file="$pyenv_install_dir" + ynh_secure_remove --file="/etc/profile.d/pyenv.sh" + fi +}