From 42be289be98bb5180d7447a9f33ab040764a7527 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Thu, 18 Jan 2024 13:19:08 +0100 Subject: [PATCH] Manifestv2 --- _common.sh | 17 ---- check_process | 33 ------ conf/gunicorn.conf.py | 2 +- conf/manage.py | 2 +- conf/nginx.conf | 2 +- conf/settings.py | 20 ++-- conf/systemd.service | 4 +- conf/urls.py | 10 +- manifest.json | 55 ---------- manifest.toml | 70 +++++++++++++ scripts/_common.sh | 83 ++++++++------- scripts/backup | 16 +-- scripts/change_url | 102 ++++++++++--------- scripts/install | 230 ++++++++---------------------------------- scripts/remove | 28 ++--- scripts/restore | 58 +++++------ scripts/upgrade | 90 ++++++++--------- tests.toml | 7 ++ 18 files changed, 328 insertions(+), 501 deletions(-) delete mode 100644 _common.sh delete mode 100644 check_process delete mode 100644 manifest.json create mode 100644 manifest.toml create mode 100644 tests.toml diff --git a/_common.sh b/_common.sh deleted file mode 100644 index 69c72c9..0000000 --- a/_common.sh +++ /dev/null @@ -1,17 +0,0 @@ -#!/bin/bash - -#================================================= -# COMMON VARIABLES -#================================================= - -#================================================= -# PERSONAL HELPERS -#================================================= - -#================================================= -# EXPERIMENTAL HELPERS -#================================================= - -#================================================= -# FUTURE OFFICIAL HELPERS -#================================================= \ No newline at end of file diff --git a/check_process b/check_process deleted file mode 100644 index 0b0e093..0000000 --- a/check_process +++ /dev/null @@ -1,33 +0,0 @@ -# See here for more information -# https://github.com/YunoHost/package_check#syntax-check_process-file - -# Move this file from check_process.default to check_process when you have filled it. - -;; Test complet - ; Manifest - domain="domain.tld" - path="/path" - admin="john" - is_public=1 - password="pass" - port="666" - ; Checks - pkg_linter=1 - setup_sub_dir=1 - setup_root=1 - setup_nourl=0 - setup_private=1 - setup_public=1 - upgrade=1 - backup_restore=1 - multi_instance=1 - port_already_use=0 - change_url=1 -;;; Options -Email= -Notification=none -;;; Upgrade options - ; commit=CommitHash - name=Name and date of the commit. - manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=pass&port=666& - diff --git a/conf/gunicorn.conf.py b/conf/gunicorn.conf.py index f49a397..162b84c 100644 --- a/conf/gunicorn.conf.py +++ b/conf/gunicorn.conf.py @@ -17,4 +17,4 @@ accesslog = '__LOG_FILE__' errorlog = '__LOG_FILE__' # https://docs.gunicorn.org/en/latest/settings.html#pidfile -pidfile = '__FINALPATH__/gunicorn.pid' +pidfile = '__INSTALL_DIR__/gunicorn.pid' diff --git a/conf/manage.py b/conf/manage.py index ec26808..bc97149 100644 --- a/conf/manage.py +++ b/conf/manage.py @@ -1,4 +1,4 @@ -#!__FINALPATH__/venv/bin/python +#!__INSTALL_DIR__/venv/bin/python import os import sys diff --git a/conf/nginx.conf b/conf/nginx.conf index 867d5ef..6798c99 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -2,7 +2,7 @@ location __PATH__/static/ { # Service static files by nginx # e.g.: /var/www/$app/static - alias __PUBLIC_PATH__/static/; + alias __INSTALL_DIR__/static/; expires 30d; } diff --git a/conf/settings.py b/conf/settings.py index 5029a29..5f87a1c 100644 --- a/conf/settings.py +++ b/conf/settings.py @@ -2,7 +2,7 @@ ################################################################################ # Please do not modify this file, it will be reset at the next update. -# You can edit the file __FINALPATH__/local_settings.py and add/modify the settings you need. +# You can edit the file __INSTALL_DIR__/local_settings.py and add/modify the settings you need. # The parameters you add in local_settings.py will overwrite these, # but you can use the options and documentation in this file to find out what can be done. @@ -24,17 +24,17 @@ from scovie.settings.prod import * # noqa:F401,F403 isort:skip from django_yunohost_integration.base_settings import LOGGING # noqa:F401 isort:skip -FINALPATH = __Path('__FINALPATH__') # /opt/yunohost/$app -assert FINALPATH.is_dir(), f'Directory not exists: {FINALPATH}' +INSTALL_DIR = __Path('__INSTALL_DIR__') # /opt/yunohost/$app +assert INSTALL_DIR.is_dir(), f'Directory not exists: {INSTALL_DIR}' -PUBLIC_PATH = __Path('__PUBLIC_PATH__') # /var/www/$app +PUBLIC_PATH = __Path('__INSTALL_DIR__') # /var/www/$app assert PUBLIC_PATH.is_dir(), f'Directory not exists: {PUBLIC_PATH}' LOG_FILE = __Path('__LOG_FILE__') # /var/log/$app/scovie_ynh.log assert LOG_FILE.is_file(), f'File not exists: {LOG_FILE}' -PATH_URL = '__PATH_URL__' # $YNH_APP_ARG_PATH -PATH_URL = PATH_URL.strip('/') +PATH = '__PATH__' # $YNH_APP_ARG_PATH +PATH = PATH.strip('/') YNH_CURRENT_HOST = '__YNH_CURRENT_HOST__' # YunoHost main domain from: /etc/yunohost/current_host @@ -54,7 +54,7 @@ DEFAULT_FROM_EMAIL = '__DEFAULT_FROM_EMAIL__' # Function that will be called to finalize a user profile: YNH_SETUP_USER = 'setup_user.setup_project_user' -SECRET_KEY = __get_or_create_secret(FINALPATH / 'secret.txt') # /opt/yunohost/$app/secret.txt +SECRET_KEY = __get_or_create_secret(INSTALL_DIR / 'secret.txt') # /opt/yunohost/$app/secret.txt INSTALLED_APPS += [ 'axes', # https://github.com/jazzband/django-axes @@ -144,9 +144,9 @@ CACHES = { # _____________________________________________________________________________ # Static files (CSS, JavaScript, Images) -if PATH_URL: - STATIC_URL = f'/{PATH_URL}/static/' - MEDIA_URL = f'/{PATH_URL}/media/' +if PATH: + STATIC_URL = f'/{PATH}/static/' + MEDIA_URL = f'/{PATH}/media/' else: # Installed to domain root, without a path prefix? STATIC_URL = '/static/' diff --git a/conf/systemd.service b/conf/systemd.service index 02c2c7f..ea48f10 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -5,8 +5,8 @@ After=redis.service postgresql.service [Service] User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ -ExecStart=__FINALPATH__/venv/bin/gunicorn --config __FINALPATH__/gunicorn.conf.py wsgi +WorkingDirectory=__INSTALL_DIR__/ +ExecStart=__INSTALL_DIR__/venv/bin/gunicorn --config __INSTALL_DIR__/gunicorn.conf.py wsgi StandardOutput=syslog StandardError=syslog SyslogIdentifier=__APP__-server diff --git a/conf/urls.py b/conf/urls.py index 135999e..30a078f 100644 --- a/conf/urls.py +++ b/conf/urls.py @@ -8,12 +8,12 @@ from django.urls import include, path from django.views.generic import RedirectView -if settings.PATH_URL: - # settings.PATH_URL is the $YNH_APP_ARG_PATH - # Prefix all urls with "PATH_URL": +if settings.PATH: + # settings.PATH is the $YNH_APP_ARG_PATH + # Prefix all urls with "PATH": urlpatterns = [ - path('', RedirectView.as_view(url=f'{settings.PATH_URL}/')), - path(f'{settings.PATH_URL}/', include('scovie.urls')), + path('', RedirectView.as_view(url=f'{settings.PATH}/')), + path(f'{settings.PATH}/', include('scovie.urls')), ] else: # Installed to domain root, without a path prefix diff --git a/manifest.json b/manifest.json deleted file mode 100644 index 975d93d..0000000 --- a/manifest.json +++ /dev/null @@ -1,55 +0,0 @@ -{ - "name": "Scovie", - "id": "scovie", - "packaging_format": 1, - "description": { - "en": "Digital signage system for high schools", - "fr": "Affichage dynamique open-source pour les lycées" - }, - "version": "0.0.6~ynh2", - "url": "https://github.com/eldertek/scovie", - "upstream": { - "license": "GPL-3.0", - "code": "https://github.com/eldertek/scovie" - }, - "license": "GPL-3.0", - "maintainer": { - "name": "André Théo LAURET", - "email": "andrelauret@eclipse-technology.eu" - }, - "previous_maintainers": [], - "requirements": { - "yunohost": ">=11" - }, - "multi_instance": true, - "services": [ - "nginx", "postgresql", "redis" - ], - "arguments": { - "install" : [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "path", - "type": "path", - "example": "/scovie", - "default": "/scovie" - }, - { - "name": "admin", - "type": "user" - }, - { - "name": "is_public", - "type": "boolean", - "help": { - "en": "Any YunoHost user and anonymous people from the web will be able to access the application", - "fr": "Tout utilisateur YunoHost et les personnes anonymes pourront accéder à l'application" - }, - "default": true - } - ] - } -} diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..94f705f --- /dev/null +++ b/manifest.toml @@ -0,0 +1,70 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json + +packaging_format = 2 + +id = "scovie" +name = "Scovie" +description.en = "Digital signage system for high schools" +description.fr = "Affichage dynamique open-source pour les lycées" + +version = "0.0.6~ynh2" + +maintainers = ["André Théo LAURET"] + +[upstream] +license = "GPL-3.0" +code = "https://github.com/eldertek/scovie" +demo = "https://scovie.eclipse-technology.eu" + +[integration] +yunohost = ">=11.2" +architectures = "all" +multi_instance = true +ldap = true +sso = true +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] + type = "domain" + + [install.path] + type = "path" + default = "/scovie" + + [install.admin] + type = "user" + + [install.init_main_permission] + help.en = "Any YunoHost user and anonymous people from the web will be able to access the application" + help.fr = "Tout utilisateur YunoHost et les personnes anonymes pourront accéder à l'application" + type = "group" + default = "visitors" + +[resources] + [resources.system_user] + + [resources.install_dir] + + [resources.permissions] + main.url = "/" + + [resources.ports] + main.default = 8000 + + [resources.apt] + packages = [ + "build-essential", + "python3-dev", + "python3-pip", + "python3-venv", + "git", + "libpq-dev", + "postgresql", + "postgresql-contrib", + ] + + [resources.database] + type = "postgresql" diff --git a/scripts/_common.sh b/scripts/_common.sh index b14c5d7..bdbc258 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -1,23 +1,12 @@ #!/bin/bash #================================================= -# RETRIEVE ARGUMENTS FROM THE MANIFEST +# COMMON VARIABLES #================================================= -domain=$YNH_APP_ARG_DOMAIN -path_url=$YNH_APP_ARG_PATH - -admin=$YNH_APP_ARG_ADMIN -is_public=$YNH_APP_ARG_IS_PUBLIC -app=$YNH_APP_INSTANCE_NAME - -# Transfer the main SSO domain to the App: ynh_current_host=$(cat /etc/yunohost/current_host) -__YNH_CURRENT_HOST__=${ynh_current_host} -#================================================= # ARGUMENTS FROM CONFIG PANEL -#================================================= # 'debug_enabled' -> '__DEBUG_ENABLED__' -> settings.DEBUG debug_enabled="0" @@ -31,24 +20,33 @@ admin_email="${admin}@${domain}" # 'default_from_email' -> '__DEFAULT_FROM_EMAIL__' -> settings.DEFAULT_FROM_EMAIL default_from_email="${app}@${domain}" -#================================================= -# SET CONSTANTS -#================================================= public_path=/var/www/$app -final_path=/opt/yunohost/$app +#REMOVEME? install_dir=/opt/yunohost/$app log_path=/var/log/$app log_file="${log_path}/${app}.log" -#================================================= -# COMMON VARIABLES -#================================================= - -# dependencies used by the app -pkg_dependencies="build-essential python3-dev python3-pip python3-venv git libpq-dev postgresql postgresql-contrib" #================================================= -# Redis HELPERS +# PERSONAL HELPERS +#================================================= + +_install_scovie_venv() { + ynh_exec_as "$app" python3 -m venv --upgrade "$install_dir/venv" + + ynh_add_config --template="requirements.txt" --destination="$install_dir/requirements.txt" + + ynh_exec_as "$app" "$install_dir/venv/bin/python3" -m ensurepip + ynh_exec_as "$app" "$install_dir/venv/bin/pip3" install --upgrade wheel pip setuptools + ynh_exec_as "$app" "$install_dir/venv/bin/pip3" install --no-deps -r "$install_dir/requirements.txt" +} + +#================================================= +# EXPERIMENTAL HELPERS +#================================================= + +#================================================= +# FUTURE OFFICIAL HELPERS #================================================= # get the first available redis database @@ -56,27 +54,27 @@ pkg_dependencies="build-essential python3-dev python3-pip python3-venv git libpq # usage: ynh_redis_get_free_db # | returns: the database number to use ynh_redis_get_free_db() { - local result max db - result=$(redis-cli INFO keyspace) + local result max db + result=$(redis-cli INFO keyspace) - # get the num - max=$(cat /etc/redis/redis.conf | grep ^databases | grep -Eow "[0-9]+") + # get the num + max=$(cat /etc/redis/redis.conf | grep ^databases | grep -Eow "[0-9]+") - db=0 - # default Debian setting is 15 databases - for i in $(seq 0 "$max") - do - if ! echo "$result" | grep -q "db$i" - then - db=$i - break 1 - fi - db=-1 - done + db=0 + # default Debian setting is 15 databases + for i in $(seq 0 "$max") + do + if ! echo "$result" | grep -q "db$i" + then + db=$i + break 1 + fi + db=-1 + done - test "$db" -eq -1 && ynh_die "No available Redis databases..." + test "$db" -eq -1 && ynh_die "No available Redis databases..." - echo "$db" + echo "$db" } # Create a master password and set up global settings @@ -85,7 +83,6 @@ ynh_redis_get_free_db() { # usage: ynh_redis_remove_db database # | arg: database - the database to erase ynh_redis_remove_db() { - local db=$1 - redis-cli -n "$db" flushall + local db=$1 + redis-cli -n "$db" flushall } - diff --git a/scripts/backup b/scripts/backup index a440220..fafc2b4 100644 --- a/scripts/backup +++ b/scripts/backup @@ -9,20 +9,20 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -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 -public_path=$(ynh_app_setting_get --app="$app" --key=public_path) -final_path=$(ynh_app_setting_get --app="$app" --key=final_path) -db_name=$(ynh_app_setting_get --app="$app" --key=db_name) +#REMOVEME? public_path=$(ynh_app_setting_get --app="$app" --key=public_path) +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app="$app" --key=install_dir) +#REMOVEME? db_name=$(ynh_app_setting_get --app="$app" --key=db_name) -domain=$(ynh_app_setting_get --app="$app" --key=domain) +#REMOVEME? domain=$(ynh_app_setting_get --app="$app" --key=domain) #================================================= # DECLARE DATA AND CONF FILES TO BACKUP @@ -33,7 +33,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" ynh_backup --src_path="$public_path" #================================================= diff --git a/scripts/change_url b/scripts/change_url index c4fa51a..c403fe9 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -6,8 +6,8 @@ # IMPORT GENERIC HELPERS #================================================= -YNH_APP_ARG_DOMAIN=$YNH_APP_NEW_DOMAIN -YNH_APP_ARG_PATH=$YNH_APP_NEW_PATH +#REMOVEME? YNH_APP_ARG_DOMAIN=$YNH_APP_NEW_DOMAIN +#REMOVEME? YNH_APP_ARG_PATH=$YNH_APP_NEW_PATH source _common.sh source /usr/share/yunohost/helpers @@ -16,69 +16,69 @@ 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 #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." +#REMOVEME? ynh_script_progression --message="Loading installation settings..." -admin=$(ynh_app_setting_get --app="$app" --key=admin) -public_path=$(ynh_app_setting_get --app="$app" --key=public_path) -final_path=$(ynh_app_setting_get --app="$app" --key=final_path) -log_path=$(ynh_app_setting_get --app="$app" --key=log_path) +#REMOVEME? admin=$(ynh_app_setting_get --app="$app" --key=admin) +#REMOVEME? public_path=$(ynh_app_setting_get --app="$app" --key=public_path) +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app="$app" --key=install_dir) +#REMOVEME? log_path=$(ynh_app_setting_get --app="$app" --key=log_path) -port=$(ynh_app_setting_get --app="$app" --key=port) +#REMOVEME? port=$(ynh_app_setting_get --app="$app" --key=port) -db_pwd=$(ynh_app_setting_get --app="$app" --key=psqlpwd) -db_name=$(ynh_sanitize_dbid --db_name="$app") -db_user=$db_name +#REMOVEME? db_pwd=$(ynh_app_setting_get --app="$app" --key=psqlpwd) +#REMOVEME? db_name=$(ynh_sanitize_dbid --db_name="$app") +#REMOVEME? db_user=$db_name -redis_db=$(ynh_app_setting_get --app="$app" --key=redis_db) +#REMOVEME? redis_db=$(ynh_app_setting_get --app="$app" --key=redis_db) #------------------------------------------------- # config_panel.toml settings: -debug_enabled=$(ynh_app_setting_get --app="$app" --key=debug_enabled) -log_level=$(ynh_app_setting_get --app="$app" --key=log_level) -admin_email=$(ynh_app_setting_get --app="$app" --key=admin_email) -default_from_email=$(ynh_app_setting_get --app="$app" --key=default_from_email) +#REMOVEME? debug_enabled=$(ynh_app_setting_get --app="$app" --key=debug_enabled) +#REMOVEME? log_level=$(ynh_app_setting_get --app="$app" --key=log_level) +#REMOVEME? admin_email=$(ynh_app_setting_get --app="$app" --key=admin_email) +#REMOVEME? default_from_email=$(ynh_app_setting_get --app="$app" --key=default_from_email) #================================================= # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP #================================================= -ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=40 +#REMOVEME? ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=40 # 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 #================================================= @@ -97,28 +97,30 @@ ynh_systemd_action --service_name="$app" --action="stop" #================================================= ynh_script_progression --message="Updating NGINX web server configuration..." -nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf +ynh_change_url_nginx_config -# Change the path in the nginx config file +#REMOVEME? nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf + +#REMOVEME? # Change the path in the nginx config file if [ $change_path -eq 1 ] then - # Make a backup of the original nginx config file if modified - ynh_backup_if_checksum_is_different --file="$nginx_conf_path" - # Set global variables for nginx helper - domain="$old_domain" - path_url="$new_path" - # Create a dedicated nginx config - ynh_add_nginx_config "public_path" "port" +#REMOVEME? # Make a backup of the original nginx config file if modified +#REMOVEME? ynh_backup_if_checksum_is_different --file="$nginx_conf_path" +#REMOVEME? # Set global variables for nginx helper +#REMOVEME? domain="$old_domain" +#REMOVEME? path="$new_path" +#REMOVEME? # Create a dedicated nginx config +#REMOVEME? ynh_add_nginx_config "public_path" "port" fi -# Change the domain for nginx +#REMOVEME? # 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 #================================================= @@ -127,11 +129,11 @@ fi # MODIFY SETTINGS #================================================= ynh_script_progression --message="Modify $app config file..." - +#REMOVEME? domain=$YNH_APP_NEW_DOMAIN -path_url=$YNH_APP_NEW_PATH +path=$YNH_APP_NEW_PATH -ynh_add_config --template="settings.py" --destination="$final_path/settings.py" +ynh_add_config --template="settings.py" --destination="$install_dir/settings.py" #================================================= # GENERIC FINALISATION @@ -145,9 +147,9 @@ ynh_systemd_action --service_name="$app" --action="start" #================================================= # RELOAD NGINX #================================================= -ynh_script_progression --message="Reloading NGINX web server..." +#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." -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 5bc75f7..500b7cc 100644 --- a/scripts/install +++ b/scripts/install @@ -8,54 +8,9 @@ source _common.sh source /usr/share/yunohost/helpers #================================================= -# MANAGE SCRIPT FAILURE +# INITIALIZE AND STORE SETTINGS #================================================= -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS -#================================================= -ynh_script_progression --message="Validating installation parameters..." - -# Path for e.g. "static" files, served by nginx: -test ! -e "$public_path" || ynh_die --message="This path already contains a folder" - -# Path for own config files, e.g.: Django's settings.py: -test ! -e "$final_path" || ynh_die --message="This path already contains a folder" - -# Register (book) web path -ynh_webpath_register --app="$app" --domain="$domain" --path_url="$path_url" - -mkdir -p "$public_path/media" "$public_path/static" -mkdir -p "$final_path" - -mkdir -p "$log_path" -touch "${log_file}" - -#================================================= -# STORE SETTINGS FROM MANIFEST -#================================================= -ynh_script_progression --message="Storing installation settings..." - -ynh_app_setting_set --app="$app" --key=admin --value="$admin" -ynh_app_setting_set --app="$app" --key=public_path --value="$public_path" -ynh_app_setting_set --app="$app" --key=final_path --value="$final_path" -ynh_app_setting_set --app="$app" --key=log_path --value="$log_file" - -ynh_app_setting_set --app="$app" --key=domain --value="$domain" -ynh_app_setting_set --app="$app" --key=path --value="$path_url" - -# Find a free port -port=$(ynh_find_port --port=8000) -# Set port as application setting -# https://yunohost.org/en/contribute/packaging_apps/helpers -# https://github.com/YunoHost/yunohost/blob/dev/helpers/setting -ynh_app_setting_set --app="$app" --key=port --value="$port" - -db_pwd=$(ynh_app_setting_get --app="$app" --key=psqlpwd) - redis_db=$(ynh_redis_get_free_db) ynh_app_setting_set --app="$app" --key=redis_db --value="$redis_db" @@ -68,179 +23,80 @@ ynh_app_setting_set --app="$app" --key=admin_email --value="$admin_email" ynh_app_setting_set --app="$app" --key=default_from_email --value="$default_from_email" #================================================= -# STANDARD MODIFICATIONS +# INSTALLATION #================================================= -# INSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Installing $app dependencies..." --weight=20 +ynh_script_progression --message="Installing project via pip..." --weight=45 -ynh_exec_warn_less ynh_install_app_dependencies "$pkg_dependencies" +mkdir -p "$install_dir/media" "$install_dir/static" +_install_scovie_venv + +chmod o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" + +mkdir -p "$log_path" +touch "$log_file" +chmod o-rwx "$log_path" +chown -R "$app:$app" "$log_path" #================================================= -# CREATE A PostgreSQL DATABASE -#================================================= -ynh_script_progression --message="Creating a PostgreSQL database..." - -db_name=$(ynh_sanitize_dbid --db_name="$app") -db_user=$db_name -ynh_app_setting_set --app="$app" --key=db_name --value="$db_name" - -ynh_psql_test_if_first_run - -# Initialize database and store postgres password for upgrade -ynh_psql_setup_db --db_user="$db_user" --db_name="$db_name" - -#================================================= -# NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Configuring NGINX web server..." - -# Create a dedicated nginx config -# https://yunohost.org/en/contribute/packaging_apps/helpers -# https://github.com/YunoHost/yunohost/blob/dev/helpers/nginx -ynh_add_nginx_config "public_path" "port" - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user $app..." - -# A home directory for venv and settings etc. -ynh_system_user_create --username="$app" --home_dir="$final_path" --use_shell - -#================================================= -# PYTHON VIRTUALENV -#================================================= -ynh_script_progression --message="Create Python virtualenv..." --weight=5 - -# Always recreate everything fresh with current python version -ynh_secure_remove "${final_path}/venv" - -# Skip pip because of: https://github.com/YunoHost/issues/issues/1960 -python3 -m venv --without-pip "${final_path}/venv" - -cp ../conf/requirements.txt "$final_path/requirements.txt" -chown -R "$app:" "$final_path" - -#================================================= -# PIP INSTALLATION -#================================================= -ynh_script_progression --message="Install project via pip..." --weight=45 - -#run source in a 'sub shell' -( - set +o nounset - source "${final_path}/venv/bin/activate" - set -o nounset - ynh_exec_as $app $final_path/venv/bin/python3 -m ensurepip - ynh_exec_as $app $final_path/venv/bin/pip3 install --upgrade wheel pip setuptools - ynh_exec_as $app $final_path/venv/bin/pip3 install --no-deps -r "$final_path/requirements.txt" -) - -#================================================= -# copy config files +# COPY CONFIG FILES # ================================================ ynh_script_progression --message="Create $app configuration files..." -ynh_add_config --template="gunicorn.conf.py" --destination="$final_path/gunicorn.conf.py" +ynh_add_config --template="gunicorn.conf.py" --destination="$install_dir/gunicorn.conf.py" -ynh_add_config --template="manage.py" --destination="$final_path/manage.py" -chmod +x "$final_path/manage.py" +ynh_add_config --template="manage.py" --destination="$install_dir/manage.py" +chmod +x "$install_dir/manage.py" -ynh_add_config --template="settings.py" --destination="$final_path/settings.py" -ynh_add_config --template="setup_user.py" --destination="$final_path/setup_user.py" -ynh_add_config --template="urls.py" --destination="$final_path/urls.py" -ynh_add_config --template="wsgi.py" --destination="$final_path/wsgi.py" +ynh_add_config --template="settings.py" --destination="$install_dir/settings.py" +ynh_add_config --template="setup_user.py" --destination="$install_dir/setup_user.py" +ynh_add_config --template="urls.py" --destination="$install_dir/urls.py" +ynh_add_config --template="wsgi.py" --destination="$install_dir/wsgi.py" -touch "$final_path/local_settings.py" +touch "$install_dir/local_settings.py" #================================================= # MIGRATE / COLLECTSTATIC / CREATEADMIN #================================================= ynh_script_progression --message="migrate/collectstatic/createadmin..." --weight=10 -cd "$final_path" || exit +pushd "$install_dir" + # Just for debugging: + ynh_exec_as "$app" ./manage.py diffsettings -# Just for debugging: -./manage.py diffsettings + ynh_exec_as "$app" ./manage.py migrate --no-input + ynh_exec_as "$app" ./manage.py collectstatic --no-input -./manage.py migrate --no-input -./manage.py collectstatic --no-input - -# Create/update Django superuser (set unusable password, because auth done via SSOwat): -./manage.py create_superuser --username="$admin" --email="$(ynh_user_get_info "$admin" mail)" - -# Check the configuration -# This may fail in some cases with errors, etc., but the app works and the user can fix issues later. -./manage.py check --deploy || true + # Create/update Django superuser (set unusable password, because auth done via SSOwat): + ynh_exec_as "$app" ./manage.py create_superuser --username="$admin" --email="$(ynh_user_get_info "$admin" mail)" + # Check the configuration + # This may fail in some cases with errors, etc., but the app works and the user can fix issues later. + ynh_exec_as "$app" ./manage.py check --deploy || true +popd #================================================= -# SETUP LOGROTATE +# SYSTEM CONFIGURATION #================================================= -ynh_script_progression --message="Configuring log rotation..." +ynh_script_progression --message="Adding system configurations related to $app..." --weight=1 + +# Create a dedicated nginx config +ynh_add_nginx_config + +# Create a dedicated NGINX config using the conf/nginx.conf template +ynh_add_systemd_config --service="$app" --template="systemd.service" +yunohost service add "$app" --description="Digital signage system for high schools" --log="$log_file" # Use logrotate to manage app-specific logfile(s) ynh_use_logrotate "$log_file" -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." - -yunohost service add $app --description="Digital signage system for high schools" --log="${log_file}" - -#================================================= -# GENERIC FINALIZATION -#================================================= -# SECURE FILES AND DIRECTORIES -#================================================= - -# Set permissions to app files -chown -R "$app:" "$log_path" -chown -R "$app:www-data" "$public_path" -chown -R "$app:" "$final_path" - -chmod o-rwx "$log_path" -chmod o-rwx "$public_path" -chmod o-rwx "$final_path" - -#================================================= -# SETUP SYSTEMD -#================================================= -ynh_script_progression --message="Configuring systemd service '$app'..." --weight=5 - -# https://yunohost.org/en/contribute/packaging_apps/helpers -# https://github.com/YunoHost/yunohost/blob/dev/helpers/systemd -ynh_add_systemd_config --service="$app" --template="systemd.service" - -#================================================= -# SETUP SSOWAT -#================================================= -ynh_script_progression --message="Configuring SSOwat..." - -# Make app public if necessary or protect it -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" -fi - #================================================= # Start the app server via systemd #================================================= -ynh_script_progression --message="Starting systemd service '$app'..." --weight=5 +ynh_script_progression --message="Starting systemd service $app..." --weight=5 ynh_systemd_action --service_name="$app" --action="start" -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." - -ynh_systemd_action --service_name="nginx" --action="reload" - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/remove b/scripts/remove index e9c4bbc..524c96a 100644 --- a/scripts/remove +++ b/scripts/remove @@ -12,13 +12,13 @@ source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." +#REMOVEME? ynh_script_progression --message="Loading installation settings..." -domain=$(ynh_app_setting_get --app="$app" --key=domain) -db_name=$(ynh_app_setting_get --app="$app" --key=db_name) -db_user=$db_name -public_path=$(ynh_app_setting_get --app="$app" --key=public_path) -final_path=$(ynh_app_setting_get --app="$app" --key=final_path) +#REMOVEME? domain=$(ynh_app_setting_get --app="$app" --key=domain) +#REMOVEME? db_name=$(ynh_app_setting_get --app="$app" --key=db_name) +#REMOVEME? db_user=$db_name +#REMOVEME? public_path=$(ynh_app_setting_get --app="$app" --key=public_path) +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app="$app" --key=install_dir) #================================================= # STANDARD REMOVE @@ -43,10 +43,10 @@ ynh_remove_systemd_config --service="$app" #================================================= # REMOVE THE PostgreSQL DATABASE #================================================= -ynh_script_progression --message="Removing the PostgreSQL database..." +#REMOVEME? ynh_script_progression --message="Removing the PostgreSQL database..." # 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 REDIS DB @@ -57,19 +57,19 @@ ynh_redis_remove_db #================================================= # REMOVE DEPENDENCIES #================================================= -ynh_script_progression --message="Removing dependencies..." --weight=10 +#REMOVEME? ynh_script_progression --message="Removing dependencies..." --weight=10 # Remove metapackage and its dependencies -ynh_exec_warn_less ynh_remove_app_dependencies +#REMOVEME? ynh_exec_warn_less ynh_remove_app_dependencies #================================================= # REMOVE APP MAIN DIR #================================================= -ynh_script_progression --message="Removing app main directory..." +#REMOVEME? ynh_script_progression --message="Removing app main directory..." # Remove the app directory securely ynh_secure_remove --file="$public_path" -ynh_secure_remove --file="$final_path" +#REMOVEME? ynh_secure_remove --file="$install_dir" #================================================= # REMOVE NGINX CONFIGURATION @@ -92,10 +92,10 @@ ynh_remove_logrotate #================================================= # REMOVE DEDICATED USER #================================================= -ynh_script_progression --message="Removing the dedicated system user..." +#REMOVEME? ynh_script_progression --message="Removing the dedicated system user..." # 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 eaf5475..90d8327 100644 --- a/scripts/restore +++ b/scripts/restore @@ -13,29 +13,29 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= -ynh_abort_if_errors +#REMOVEME? ynh_abort_if_errors #================================================= # LOAD SETTINGS #================================================= ynh_script_progression --message="Loading settings..." -final_path=$(ynh_app_setting_get --app="$app" --key=final_path) -public_path=$(ynh_app_setting_get --app="$app" --key=public_path) -db_name=$(ynh_app_setting_get --app="$app" --key=db_name) -db_user=$db_name -db_pwd=$(ynh_app_setting_get --app="$app" --key=psqlpwd) +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app="$app" --key=install_dir) +#REMOVEME? public_path=$(ynh_app_setting_get --app="$app" --key=public_path) +#REMOVEME? db_name=$(ynh_app_setting_get --app="$app" --key=db_name) +#REMOVEME? db_user=$db_name +#REMOVEME? db_pwd=$(ynh_app_setting_get --app="$app" --key=psqlpwd) -domain=$(ynh_app_setting_get --app="$app" --key=domain) -path_url=$(ynh_app_setting_get --app="$app" --key=path) +#REMOVEME? domain=$(ynh_app_setting_get --app="$app" --key=domain) +#REMOVEME? path=$(ynh_app_setting_get --app="$app" --key=path) #================================================= # CHECK IF THE APP CAN BE RESTORED #================================================= -ynh_script_progression --message="Validating restoration parameters..." +#REMOVEME? ynh_script_progression --message="Validating restoration parameters..." -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 @@ -50,16 +50,16 @@ ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= ynh_script_progression --message="Restoring $app main directory..." -ynh_restore_file --origin_path="$final_path" +ynh_restore_file --origin_path="$install_dir" ynh_restore_file --origin_path="$public_path" #================================================= # RECREATE THE DEDICATED USER #================================================= -ynh_script_progression --message="Recreating the dedicated system user..." +#REMOVEME? ynh_script_progression --message="Recreating the dedicated system user..." # Create the dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" --use_shell +#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir" --use_shell #================================================= # RESTORE USER RIGHTS @@ -67,16 +67,16 @@ ynh_system_user_create --username=$app --home_dir="$final_path" --use_shell # Restore permissions on app files chown -R "$app:www-data" "$public_path" -chown -R "$app:" "$final_path" +chown -R "$app:" "$install_dir" #================================================= # SPECIFIC RESTORATION #================================================= # REINSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Reinstalling dependencies..." --weight=20 +#REMOVEME? ynh_script_progression --message="Reinstalling dependencies..." --weight=20 -ynh_exec_warn_less ynh_install_app_dependencies "$pkg_dependencies" +#REMOVEME? ynh_exec_warn_less ynh_install_app_dependencies "$pkg_dependencies" #================================================= # PYTHON VIRTUALENV @@ -85,11 +85,11 @@ ynh_exec_warn_less ynh_install_app_dependencies "$pkg_dependencies" ynh_script_progression --message="Recreate Python virtualenv..." --weight=5 # Always recreate everything fresh with current python version -ynh_secure_remove "${final_path}/venv" +ynh_secure_remove "${install_dir}/venv" # Skip pip because of: https://github.com/YunoHost/issues/issues/1960 -python3 -m venv --without-pip "${final_path}/venv" -chown -R "$app:" "$final_path" +python3 -m venv --without-pip "${install_dir}/venv" +chown -R "$app:" "$install_dir" #================================================= # PIP INSTALLATION @@ -98,20 +98,20 @@ ynh_script_progression --message="Install project via pip..." --weight=45 #run source in a 'sub shell' ( set +o nounset - source "${final_path}/venv/bin/activate" + source "${install_dir}/venv/bin/activate" set -o nounset - ynh_exec_as $app $final_path/venv/bin/python3 -m ensurepip - ynh_exec_as $app $final_path/venv/bin/pip3 install --upgrade wheel pip setuptools - ynh_exec_as $app $final_path/venv/bin/pip3 install --no-deps -r "$final_path/requirements.txt" + ynh_exec_as $app $install_dir/venv/bin/python3 -m ensurepip + ynh_exec_as $app $install_dir/venv/bin/pip3 install --upgrade wheel pip setuptools + ynh_exec_as $app $install_dir/venv/bin/pip3 install --no-deps -r "$install_dir/requirements.txt" ) #================================================= # RESTORE THE PostgreSQL DATABASE #================================================= -ynh_script_progression --message="Restoring the PostgreSQL database..." --weight=5 +#REMOVEME? ynh_script_progression --message="Restoring the PostgreSQL database..." --weight=5 -ynh_psql_test_if_first_run -ynh_psql_setup_db --db_user="$db_user" --db_name="$db_name" --db_pwd="$db_pwd" +#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_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql #================================================= @@ -147,11 +147,11 @@ ynh_restore_file --origin_path="/etc/logrotate.d/$app" # Set permissions to app files chown -R "$app:" "$log_path" chown -R "$app:www-data" "$public_path" -chown -R "$app:" "$final_path" +chown -R "$app:" "$install_dir" chmod o-rwx "$log_path" chmod o-rwx "$public_path" -chmod o-rwx "$final_path" +chmod o-rwx "$install_dir" #================================================= # GENERIC FINALIZATION diff --git a/scripts/upgrade b/scripts/upgrade index 56871cc..bc41729 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -10,46 +10,46 @@ source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." +#REMOVEME? ynh_script_progression --message="Loading installation settings..." -admin=$(ynh_app_setting_get --app="$app" --key=admin) -public_path=$(ynh_app_setting_get --app="$app" --key=public_path) -final_path=$(ynh_app_setting_get --app="$app" --key=final_path) -log_path=$(ynh_app_setting_get --app="$app" --key=log_path) +#REMOVEME? admin=$(ynh_app_setting_get --app="$app" --key=admin) +#REMOVEME? public_path=$(ynh_app_setting_get --app="$app" --key=public_path) +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app="$app" --key=install_dir) +#REMOVEME? log_path=$(ynh_app_setting_get --app="$app" --key=log_path) -domain=$(ynh_app_setting_get --app="$app" --key=domain) -path_url=$(ynh_app_setting_get --app="$app" --key=path) +#REMOVEME? domain=$(ynh_app_setting_get --app="$app" --key=domain) +#REMOVEME? path=$(ynh_app_setting_get --app="$app" --key=path) -port=$(ynh_app_setting_get --app="$app" --key=port) +#REMOVEME? port=$(ynh_app_setting_get --app="$app" --key=port) -db_pwd=$(ynh_app_setting_get --app="$app" --key=psqlpwd) -db_name=$(ynh_sanitize_dbid --db_name="$app") -db_user=$db_name +#REMOVEME? db_pwd=$(ynh_app_setting_get --app="$app" --key=psqlpwd) +#REMOVEME? db_name=$(ynh_sanitize_dbid --db_name="$app") +#REMOVEME? db_user=$db_name -redis_db=$(ynh_app_setting_get --app="$app" --key=redis_db) +#REMOVEME? redis_db=$(ynh_app_setting_get --app="$app" --key=redis_db) #------------------------------------------------- # config_panel.toml settings: -debug_enabled=$(ynh_app_setting_get --app="$app" --key=debug_enabled) +#REMOVEME? debug_enabled=$(ynh_app_setting_get --app="$app" --key=debug_enabled) if [ -z "$debug_enabled" ]; then debug_enabled="0" ynh_app_setting_set --app="$app" --key=debug_enabled --value="$debug_enabled" fi -log_level=$(ynh_app_setting_get --app="$app" --key=log_level) +#REMOVEME? log_level=$(ynh_app_setting_get --app="$app" --key=log_level) if [ -z "$log_level" ]; then log_level="WARNING" ynh_app_setting_set --app="$app" --key=log_level --value="$log_level" fi -admin_email=$(ynh_app_setting_get --app="$app" --key=admin_email) +#REMOVEME? admin_email=$(ynh_app_setting_get --app="$app" --key=admin_email) if [ -z "$admin_email" ]; then admin_email="${admin}@${domain}" - ynh_app_setting_set --app="$app" --key=admin_email --value="$admin_email" +#REMOVEME? ynh_app_setting_set --app="$app" --key=admin_email --value="$admin_email" fi -default_from_email=$(ynh_app_setting_get --app="$app" --key=default_from_email) +#REMOVEME? default_from_email=$(ynh_app_setting_get --app="$app" --key=default_from_email) if [ -z "$default_from_email" ]; then default_from_email="${app}@${domain}" ynh_app_setting_set --app="$app" --key=default_from_email --value="$default_from_email" @@ -61,13 +61,13 @@ fi ynh_script_progression --message="Backing up $app before upgrading (may take a while)..." --weight=40 # 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 @@ -93,17 +93,17 @@ ynh_add_nginx_config "public_path" "port" #================================================= # Update dependencies #================================================= -ynh_script_progression --message="Upgrading dependencies..." --weight=20 +#REMOVEME? ynh_script_progression --message="Upgrading dependencies..." --weight=20 -ynh_exec_warn_less ynh_install_app_dependencies "$pkg_dependencies" +#REMOVEME? ynh_exec_warn_less ynh_install_app_dependencies "$pkg_dependencies" #================================================= # CREATE DEDICATED USER #================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." +#REMOVEME? ynh_script_progression --message="Making sure dedicated system user exists..." # Create a system user -ynh_system_user_create --username="$app" --home_dir="$final_path" --use_shell +#REMOVEME? ynh_system_user_create --username="$app" --home_dir="$install_dir" --use_shell #================================================= # SETUP SYSTEMD @@ -118,13 +118,13 @@ ynh_add_systemd_config --service="$app" --template="systemd.service" ynh_script_progression --message="Recreate Python virtualenv..." --weight=5 # Always recreate everything fresh with current python version -ynh_secure_remove "${final_path}/venv" +ynh_secure_remove "${install_dir}/venv" # Skip pip because of: https://github.com/YunoHost/issues/issues/1960 -python3 -m venv --without-pip "${final_path}/venv" +python3 -m venv --without-pip "${install_dir}/venv" -cp ../conf/requirements.txt "$final_path/requirements.txt" -chown -R "$app:" "$final_path" +cp ../conf/requirements.txt "$install_dir/requirements.txt" +chown -R "$app:" "$install_dir" #================================================= # PIP INSTALLATION @@ -133,11 +133,11 @@ ynh_script_progression --message="Install project via pip..." --weight=45 #run source in a 'sub shell' ( set +o nounset - source "${final_path}/venv/bin/activate" + source "${install_dir}/venv/bin/activate" set -o nounset - ynh_exec_as $app $final_path/venv/bin/python3 -m ensurepip - ynh_exec_as $app $final_path/venv/bin/pip3 install --upgrade wheel pip setuptools - ynh_exec_as $app $final_path/venv/bin/pip3 install --no-deps -r "$final_path/requirements.txt" + ynh_exec_as $app $install_dir/venv/bin/python3 -m ensurepip + ynh_exec_as $app $install_dir/venv/bin/pip3 install --upgrade wheel pip setuptools + ynh_exec_as $app $install_dir/venv/bin/pip3 install --no-deps -r "$install_dir/requirements.txt" ) #================================================= @@ -145,22 +145,22 @@ ynh_script_progression --message="Install project via pip..." --weight=45 # ================================================ ynh_script_progression --message="Create project configuration files..." -ynh_add_config --template="gunicorn.conf.py" --destination="$final_path/gunicorn.conf.py" +ynh_add_config --template="gunicorn.conf.py" --destination="$install_dir/gunicorn.conf.py" -ynh_add_config --template="manage.py" --destination="$final_path/manage.py" -chmod +x "$final_path/manage.py" +ynh_add_config --template="manage.py" --destination="$install_dir/manage.py" +chmod +x "$install_dir/manage.py" -ynh_add_config --template="settings.py" --destination="$final_path/settings.py" -ynh_add_config --template="setup_user.py" --destination="$final_path/setup_user.py" -ynh_add_config --template="urls.py" --destination="$final_path/urls.py" -ynh_add_config --template="wsgi.py" --destination="$final_path/wsgi.py" +ynh_add_config --template="settings.py" --destination="$install_dir/settings.py" +ynh_add_config --template="setup_user.py" --destination="$install_dir/setup_user.py" +ynh_add_config --template="urls.py" --destination="$install_dir/urls.py" +ynh_add_config --template="wsgi.py" --destination="$install_dir/wsgi.py" #================================================= # MIGRATE PYINVENTORY #================================================= ynh_script_progression --message="migrate/collectstatic/createadmin..." --weight=10 -cd "$final_path" || exit +cd "$install_dir" || exit # Just for debugging: ./manage.py diffsettings @@ -200,11 +200,11 @@ yunohost service add $app --description="Digital signage system for high schools # Set permissions to app files chown -R "$app:" "$log_path" chown -R "$app:www-data" "$public_path" -chown -R "$app:" "$final_path" +chown -R "$app:" "$install_dir" chmod o-rwx "$log_path" chmod o-rwx "$public_path" -chmod o-rwx "$final_path" +chmod o-rwx "$install_dir" #================================================= # Start the app server via systemd @@ -216,9 +216,9 @@ ynh_systemd_action --service_name="$app" --action="start" #================================================= # RELOAD NGINX #================================================= -ynh_script_progression --message="Reloading NGINX web server..." +#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." -ynh_systemd_action --service_name=nginx --action=reload +#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload #================================================= # END OF SCRIPT diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..d64ef3c --- /dev/null +++ b/tests.toml @@ -0,0 +1,7 @@ +test_format = 1.0 + +[default] + + # ------------ + # Tests to run + # ------------