From 7d1e6250083d1955dfcb814f5eb3039f7024be02 Mon Sep 17 00:00:00 2001 From: tituspijean Date: Thu, 27 Apr 2023 23:04:36 +0200 Subject: [PATCH] Packaging v2 --- conf/app-upgrade.src | 6 -- conf/app.src | 6 -- conf/ldap.src | 7 --- conf/nginx.conf | 47 ++++++++------- conf/php-fpm.conf | 2 +- config_panel.toml | 26 +++++++++ manifest.json | 86 --------------------------- manifest.toml | 80 ++++++++++++++++++++++++++ scripts/_common.sh | 5 -- scripts/backup | 20 +------ scripts/change_url | 86 +-------------------------- scripts/config | 56 +++++++++++++++++- scripts/install | 114 +++++------------------------------- scripts/remove | 38 ------------ scripts/restore | 64 ++------------------- scripts/update_version.sh | 89 ---------------------------- scripts/upgrade | 118 ++++++-------------------------------- 17 files changed, 225 insertions(+), 625 deletions(-) delete mode 100644 conf/app-upgrade.src delete mode 100644 conf/app.src delete mode 100644 conf/ldap.src delete mode 100644 manifest.json create mode 100644 manifest.toml delete mode 100755 scripts/update_version.sh diff --git a/conf/app-upgrade.src b/conf/app-upgrade.src deleted file mode 100644 index b06d61b..0000000 --- a/conf/app-upgrade.src +++ /dev/null @@ -1,6 +0,0 @@ -SOURCE_URL=https://github.com/getgrav/grav/releases/download/1.7.40/grav-update-v1.7.40.zip -SOURCE_SUM=e202ed8b74673cd30230a1349c68a7b667c6fb743b64ba796111468b9ed9fd09 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=zip -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= diff --git a/conf/app.src b/conf/app.src deleted file mode 100644 index c2eecc9..0000000 --- a/conf/app.src +++ /dev/null @@ -1,6 +0,0 @@ -SOURCE_URL=https://github.com/getgrav/grav/releases/download/1.7.40/grav-admin-v1.7.40.zip -SOURCE_SUM=c3b5735a8b3c66d7d1a9347fa3300f0a3f545fd9521304208acec2d52a3ada8d -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=zip -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= diff --git a/conf/ldap.src b/conf/ldap.src deleted file mode 100644 index 563e3a0..0000000 --- a/conf/ldap.src +++ /dev/null @@ -1,7 +0,0 @@ -SOURCE_URL=https://github.com/trilbymedia/grav-plugin-login-ldap/archive/refs/tags/1.0.2.zip -SOURCE_SUM=bdaea681730e800ab8eda7edf56d772baca1de783d0f8c321ac2ec86d82628ca -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=zip -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME=ldap.zip -SOURCE_EXTRACT=true diff --git a/conf/nginx.conf b/conf/nginx.conf index 5985a89..caab054 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,6 +1,6 @@ #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; location __PATH__/ { - alias __FINALPATH__/; + alias __INSTALL_DIR__/; index index.php; # Common parameter to increase upload size limit in conjunction with dedicated php-fpm file @@ -18,36 +18,35 @@ location __PATH__/ { try_files $uri $uri/ __PATH__/__PATH__/index.php?$query_string; location ~ \.php$ { - fastcgi_split_path_info ^(.+\.php)(/.+)$; - fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock; - fastcgi_index index.php; - include fastcgi_params; - # https://learn.getgrav.org/webservers-hosting/servers/nginx#fix-against-httpoxy-vulnerability - fastcgi_param HTTP_PROXY ""; - fastcgi_param REMOTE_USER $remote_user; - fastcgi_param PATH_INFO $fastcgi_path_info; - fastcgi_param SCRIPT_FILENAME $request_filename; + fastcgi_split_path_info ^(.+\.php)(/.+)$; + fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock; + fastcgi_index index.php; + include fastcgi_params; + # https://learn.getgrav.org/webservers-hosting/servers/nginx#fix-against-httpoxy-vulnerability + fastcgi_param HTTP_PROXY ""; + fastcgi_param REMOTE_USER $remote_user; + fastcgi_param PATH_INFO $fastcgi_path_info; + fastcgi_param SCRIPT_FILENAME $request_filename; } location ~* \.(?:ico|css|js|gif|jpe?g|png)$ { - expires 30d; - more_set_headers "Vary: Accept-Encoding"; - log_not_found off; + expires 30d; + more_set_headers "Vary: Accept-Encoding"; + log_not_found off; } location ~* ^.+\.(?:css|cur|js|jpe?g|gif|htc|ico|png|html|xml|otf|ttf|eot|woff|woff2|svg)$ { - access_log off; - expires 30d; - more_set_headers "Cache-Control: public"; + access_log off; + expires 30d; + more_set_headers "Cache-Control: public"; + ## No need to bleed constant updates. Send the all shebang in one fell swoop. + tcp_nodelay off; - ## No need to bleed constant updates. Send the all shebang in one fell swoop. - tcp_nodelay off; - - ## Set the OS file cache. - open_file_cache max=3000 inactive=120s; - open_file_cache_valid 45s; - open_file_cache_min_uses 2; - open_file_cache_errors off; + ## Set the OS file cache. + open_file_cache max=3000 inactive=120s; + open_file_cache_valid 45s; + open_file_cache_min_uses 2; + open_file_cache_errors off; } ## Begin - Security diff --git a/conf/php-fpm.conf b/conf/php-fpm.conf index 9ea382b..f3a0486 100644 --- a/conf/php-fpm.conf +++ b/conf/php-fpm.conf @@ -358,7 +358,7 @@ request_terminate_timeout = 1d ; Chdir to this directory at the start. ; Note: relative path can be used. ; Default Value: current directory or / when chroot -chdir = __FINALPATH__ +chdir = __INSTALL_DIR__ ; Redirect worker stdout and stderr into main error log. If not set, stdout and ; stderr will be redirected to /dev/null according to FastCGI specs. diff --git a/config_panel.toml b/config_panel.toml index 2b1a213..9cc4e6d 100644 --- a/config_panel.toml +++ b/config_panel.toml @@ -17,3 +17,29 @@ name = "Grav configuration" optional = true visible = "with_sftp" help = "If a password already exists, leave blank and it will not be replaced." + + [main.php_fpm_config] + name = "PHP-FPM configuration" + + [main.php_fpm_config.fpm_footprint] + ask = "Memory footprint" + type = "select" + choices.low = "Low, <= 20Mb per pool" + choices.medium = "Medium, between 20Mb and 40Mb per pool" + choices.high = "High, > 40Mb per pool" + choices.specific = "Use specific value" + default = "low" + + [main.php_fpm_config.fpm_free_footprint] + visible = "fpm_footprint == 'specific'" + ask = "Memory footprint of the service?" + type = "number" + default = "0" + help = "Free field to specify exactly the footprint in Mb if you don't want to use one of the three previous values." + + [main.php_fpm_config.fpm_usage] + ask = "Expected usage" + type = "select" + choices = ["low", "medium", "high"] + default = "low" + help = "low: Personal usage, behind the SSO. No RAM footprint when not used, but the impact on the processor can be high if many users are using the service.
medium: Low usage, few people or/and publicly accessible. Low RAM footprint, medium processor footprint when used.
high: High usage, frequently visited website. High RAM footprint, but lower on processor usage and quickly responding." diff --git a/manifest.json b/manifest.json deleted file mode 100644 index 403a074..0000000 --- a/manifest.json +++ /dev/null @@ -1,86 +0,0 @@ -{ - "name": "Grav", - "id": "grav", - "packaging_format": 1, - "description": { - "en": "Modern open source flat-file CMS", - "fr": "CMS moderne basé sur des fichiers plats" - }, - "version": "1.7.40~ynh1", - "url": "https://www.getgrav.org/", - "upstream": { - "license": "MIT", - "website": "https://www.getgrav.org/", - "demo": "https://getgrav.org/downloads/themes", - "admindoc": "https://learn.getgrav.org", - "code": "https://github.com/getgrav/grav" - }, - "license": "MIT", - "maintainer": [ - { - "name": "tituspijean", - "email": "tituspijean@outlook.com" - } - ], - "previous_maintainers": [ - { - "name": "cyp", - "email": "cyp@rouquin.me" - }, - { - "name": "lithrel", - "email": "lithrel@randomdomainname.net" - }, - { - "name": "jibec", - "email": "jean-baptiste@holcroft.fr" - } - ], - "requirements": { - "yunohost": ">= 4.3.0" - }, - "multi_instance": true, - "services": [ - "nginx" - ], - "arguments": { - "install": [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "path", - "type": "path", - "example": "/grav", - "default": "/grav" - }, - { - "name": "is_public", - "type": "boolean", - "help": { - "en": "Will anyone be able to access the website?", - "fr": "Est-ce que quiconque pourra accéder au site ?" - }, - "default": true - }, - { - "name": "language", - "type": "string", - "ask": { - "en": "Choose the application language", - "fr": "Choisissez la langue de l'application" - }, - "choices": [ - "en_EN", - "fr_FR" - ], - "default": "fr_FR" - }, - { - "name": "admin", - "type": "user" - } - ] - } -} diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..0f31c83 --- /dev/null +++ b/manifest.toml @@ -0,0 +1,80 @@ +packaging_format = 2 + +id = "grav" +name = "Grav" +description.en = "Modern open source flat-file CMS" +description.fr = "CMS moderne basé sur des fichiers plats" + +version = "1.7.40~ynh1" + +maintainers = ["tituspijean"] + +[upstream] +license = "MIT" +website = "https://www.getgrav.org/" +demo = "https://getgrav.org/downloads/themes" +admindoc = "https://learn.getgrav.org" +code = "https://github.com/getgrav/grav" +cpe = "cpe:2.3:a:getgrav:grav" +fund = "https://opencollective.com/grav" + +[integration] +yunohost = ">= 11.1" +architectures = "all" +multi_instance = true +ldap = "true" +sso = "false" +disk = "50M" +ram.build = "50M" +ram.runtime = "50M" + +[install] + [install.domain] + type = "domain" + + [install.path] + type = "path" + default = "/grav" + + [install.init_main_permission] + help.en = "Will anyone be able to access the website?" + help.fr = "Est-ce que quiconque pourra accéder au site ?" + type = "group" + default = "visitors" + + [install.language] + ask.en = "Choose the application language" + ask.fr = "Choisissez la langue de l'application" + type = "string" + choices = ["en_EN", "fr_FR"] + default = "fr_FR" + + [install.admin] + type = "user" + +[resources] + [resources.sources] + [resources.sources.ldap] + url = "https://github.com/trilbymedia/grav-plugin-login-ldap/archive/refs/tags/1.0.2.zip" + sha256 = "bdaea681730e800ab8eda7edf56d772baca1de783d0f8c321ac2ec86d82628ca" + autoupdate.strategy = "latest_github_tag" + + [resources.sources.main] + url = "https://github.com/getgrav/grav/releases/download/1.7.40/grav-admin-v1.7.40.zip" + sha256 = "c3b5735a8b3c66d7d1a9347fa3300f0a3f545fd9521304208acec2d52a3ada8d" + autoupdate.strategy = "latest_github_tag" + + [resources.sources.app-upgrade] + url = "https://github.com/getgrav/grav/releases/download/1.7.40/grav-update-v1.7.40.zip" + sha256 = "e202ed8b74673cd30230a1349c68a7b667c6fb743b64ba796111468b9ed9fd09" + autoupdate.strategy = "latest_github_tag" + + [resources.system_user] + + [resources.install_dir] + + [resources.permissions] + main.url = "/" + + [resources.apt] + packages = "php7.4, php7.4-zip, php7.4-mbstring, php7.4-curl, php7.4-dom, php7.4-gd, php7.4-xml, php7.4-ldap" diff --git a/scripts/_common.sh b/scripts/_common.sh index febad80..26d0914 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -4,11 +4,6 @@ # COMMON VARIABLES #================================================= -php_dependencies="php$YNH_DEFAULT_PHP_VERSION-zip php$YNH_DEFAULT_PHP_VERSION-mbstring php$YNH_DEFAULT_PHP_VERSION-curl php$YNH_DEFAULT_PHP_VERSION-dom php$YNH_DEFAULT_PHP_VERSION-gd php$YNH_DEFAULT_PHP_VERSION-xml php$YNH_DEFAULT_PHP_VERSION-ldap" - -# dependencies used by the app (must be on a single line) -pkg_dependencies="$php_dependencies" - #================================================= # PERSONAL HELPERS #================================================= diff --git a/scripts/backup b/scripts/backup index df79dd9..d4ae004 100644 --- a/scripts/backup +++ b/scripts/backup @@ -10,24 +10,6 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_print_info --message="Loading installation settings..." - -app=$YNH_APP_INSTANCE_NAME - -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -domain=$(ynh_app_setting_get --app=$app --key=domain) -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) - #================================================= # DECLARE DATA AND CONF FILES TO BACKUP #================================================= @@ -37,7 +19,7 @@ ynh_print_info --message="Declaring files to be backed up..." # BACKUP THE APP MAIN DIR #================================================= -ynh_backup --src_path="$final_path" +ynh_backup --src_path="$install_dir" #================================================= # BACKUP THE NGINX CONFIGURATION diff --git a/scripts/change_url b/scripts/change_url index abf1be5..d50c1a8 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,59 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# RETRIEVE ARGUMENTS -#================================================= - -old_domain=$YNH_APP_OLD_DOMAIN -old_path=$YNH_APP_OLD_PATH - -new_domain=$YNH_APP_NEW_DOMAIN -new_path=$YNH_APP_NEW_PATH - -app=$YNH_APP_INSTANCE_NAME - -#================================================= -# LOAD 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) - -#================================================= -# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=1 - -# Backup the current version of the app -ynh_backup_before_upgrade -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" - - # Restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# CHECK WHICH PARTS SHOULD BE CHANGED -#================================================= - -change_domain=0 -if [ "$old_domain" != "$new_domain" ] -then - change_domain=1 -fi - -change_path=0 -if [ "$old_path" != "$new_path" ] -then - change_path=1 -fi - #================================================= # STANDARD MODIFICATIONS #================================================= @@ -69,38 +16,7 @@ fi #================================================= ynh_script_progression --message="Updating NGINX web server configuration..." --weight=3 -nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf - -# Change the path in the NGINX config file -if [ $change_path -eq 1 ] -then - # Make a backup of the original NGINX config file if modified - ynh_backup_if_checksum_is_different --file="$nginx_conf_path" - # Set global variables for NGINX helper - domain="$old_domain" - path_url="$new_path" - # Create a dedicated NGINX config - ynh_add_nginx_config -fi - -# Change the domain for NGINX -if [ $change_domain -eq 1 ] -then - # Delete file checksum for the old conf file location - ynh_delete_file_checksum --file="$nginx_conf_path" - mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf - # Store file checksum for the new config file location - ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" -fi - -#================================================= -# GENERIC FINALISATION -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=3 - -ynh_systemd_action --service_name=nginx --action=reload +ynh_change_url_nginx_config #================================================= # END OF SCRIPT diff --git a/scripts/config b/scripts/config index 756c326..9eb2603 100644 --- a/scripts/config +++ b/scripts/config @@ -15,12 +15,37 @@ ynh_abort_if_errors # RETRIEVE ARGUMENTS #================================================= -final_path=$(ynh_app_setting_get $app final_path) +install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) +phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) +current_fpm_footprint=$(ynh_app_setting_get --app=$app --key=fpm_footprint) #================================================= # SPECIFIC GETTERS FOR TOML SHORT KEY #================================================= +get__fpm_footprint() { + # Free footprint value for php-fpm + # Check if current_fpm_footprint is an integer + if [ "$current_fpm_footprint" -eq "$current_fpm_footprint" ] 2> /dev/null + then + echo "specific" + else + echo "$current_fpm_footprint" + fi +} + +get__free_footprint() { + # Free footprint value for php-fpm + # Check if current_fpm_footprint is an integer + if [ "$current_fpm_footprint" -eq "$current_fpm_footprint" ] 2> /dev/null + then + # If current_fpm_footprint is an integer, that's a numeric value for the footprint + echo "$current_fpm_footprint" + else + echo "0" + fi +} + #================================================= # SPECIFIC VALIDATORS FOR TOML SHORT KEYS #================================================= @@ -36,6 +61,20 @@ set__password() { fi } +set__fpm_footprint() { + if [ "$fpm_footprint" != "specific" ] + then + ynh_app_setting_set --app=$app --key=fpm_footprint --value="$fpm_footprint" + fi +} + +set__fpm_free_footprint() { + if [ "$fpm_footprint" = "specific" ] + then + ynh_app_setting_set --app=$app --key=fpm_footprint --value="$fpm_free_footprint" + fi +} + #================================================= # GENERIC FINALIZATION #================================================= @@ -47,6 +86,20 @@ ynh_app_config_validate() { then ynh_die --message="You need to set a password to enable SSH and SFTP" fi + + if [ "${changed[fpm_usage]}" == "true" ] || [ "${changed[fpm_footprint]}" == "true" ] || [ "${changed[fpm_free_footprint]}" == "true" ]; then + # If fpm_footprint is set to 'specific', use $fpm_free_footprint value. + if [ "$fpm_footprint" = "specific" ] + then + fpm_footprint=$fpm_free_footprint + fi + + if [ "$fpm_footprint" == "0" ] + then + ynh_print_err --message="When selecting 'specific', you have to set a footprint value into the field below." + exit 0 + fi + fi } ynh_app_config_apply() { @@ -67,6 +120,7 @@ ynh_app_config_apply() { usermod --shel /usr/sbin/nologin $app fi + ynh_add_fpm_config --phpversion=$phpversion --usage=$fpm_usage --footprint=$fpm_footprint } ynh_app_config_run $1 diff --git a/scripts/install b/scripts/install index 8e12fb4..9e2d1fc 100644 --- a/scripts/install +++ b/scripts/install @@ -9,81 +9,24 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# RETRIEVE ARGUMENTS FROM THE MANIFEST -#================================================= - -domain=$YNH_APP_ARG_DOMAIN -path_url=$YNH_APP_ARG_PATH -is_public=$YNH_APP_ARG_IS_PUBLIC -language=$YNH_APP_ARG_LANGUAGE -admin=$YNH_APP_ARG_ADMIN - -app=$YNH_APP_INSTANCE_NAME - -#================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS -#================================================= -ynh_script_progression --message="Validating installation parameters..." --weight=1 - -final_path=/var/www/$app -test ! -e "$final_path" || ynh_die --message="This path already contains a folder" - -# Register (book) web path -ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url - -#================================================= -# STORE SETTINGS FROM MANIFEST -#================================================= -ynh_script_progression --message="Storing installation settings..." --weight=1 - -ynh_app_setting_set --app=$app --key=domain --value=$domain -ynh_app_setting_set --app=$app --key=path --value=$path_url -ynh_app_setting_set --app=$app --key=language --value=$language -ynh_app_setting_set --app=$app --key=admin --value=$admin +# Initialize the with_sftp setting for the config panel ynh_app_setting_set --app=$app --key=with_sftp --value="false" -ynh_app_setting_set --app=$app --key=password --value=$(ynh_string_random) - -#================================================= -# STANDARD MODIFICATIONS -#================================================= -# INSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Installing dependencies..." --weight=1 - -ynh_install_app_dependencies $pkg_dependencies - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user..." --weight=1 - -# Create a system user -ynh_system_user_create --username=$app --home_dir="$final_path" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Setting up source files..." --weight=2 -ynh_app_setting_set --app=$app --key=final_path --value=$final_path # Download, check integrity, uncompress and patch the source from app.src -ynh_setup_source --dest_dir="$final_path" -ynh_setup_source --dest_dir="$final_path/user/plugins/login-ldap" --source_id="ldap" +ynh_setup_source --dest_dir="$install_dir" +ynh_setup_source --dest_dir="$install_dir/user/plugins/login-ldap" --source_id="ldap" # Set permissions on app files -chown -R $app:www-data "$final_path" -find "$final_path" -type f -exec chmod 640 {} \; -find "$final_path/bin" -type f -exec chmod 750 {} \; -find "$final_path" -type d -exec chmod 750 {} \; -find "$final_path" -type d -exec chmod +s {} \; +chown -R $app:www-data "$install_dir" +find "$install_dir" -type f -exec chmod 640 {} \; +find "$install_dir/bin" -type f -exec chmod 750 {} \; +find "$install_dir" -type d -exec chmod 750 {} \; +find "$install_dir" -type d -exec chmod +s {} \; #================================================= # PHP-FPM CONFIGURATION @@ -92,7 +35,6 @@ ynh_script_progression --message="Configuring PHP-FPM..." --weight=3 # Create a dedicated PHP-FPM config ynh_add_fpm_config --usage=medium --footprint=medium -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) #================================================= # NGINX CONFIGURATION @@ -110,51 +52,23 @@ ynh_add_nginx_config ynh_script_progression --message="Adding a configuration file..." --weight=1 # Preparing config -ynh_exec_as $app mkdir -p "$final_path/user/config/plugins/login-ldap" -ynh_exec_as $app touch "$final_path/user/accounts/admin.yaml" +ynh_exec_as $app mkdir -p "$install_dir/user/config/plugins/login-ldap" +ynh_exec_as $app touch "$install_dir/user/accounts/admin.yaml" # Setting up config -ynh_add_config --template="../conf/login-ldap.yaml" --destination="$final_path/user/config/plugins/login-ldap.yaml" -chown $app:$app "$final_path/user/config/plugins/login-ldap.yaml" -chmod 640 "$final_path/user/config/plugins/login-ldap.yaml" +ynh_add_config --template="../conf/login-ldap.yaml" --destination="$install_dir/user/config/plugins/login-ldap.yaml" +chown $app:$app "$install_dir/user/config/plugins/login-ldap.yaml" +chmod 640 "$install_dir/user/config/plugins/login-ldap.yaml" #================================================= # CREATE A CRON TASK #================================================= ynh_script_progression --message="Creating a cron task..." --weight=1 -echo "* * * * * $app php$phpversion $final_path/bin/grav scheduler 1>> /dev/null 2>&1" > /etc/cron.d/$app +echo "* * * * * $app php$phpversion $install_dir/bin/grav scheduler 1>> /dev/null 2>&1" > /etc/cron.d/$app chmod 644 /etc/cron.d/$app -#================================================= -# GENERIC FINALIZATION -#================================================= -# SETUP SSOWAT -#================================================= -ynh_script_progression --message="Configuring permissions..." --weight=1 - -# Make app public if necessary -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 - -# Giving admin permission to the specified used -ynh_permission_create --permission="admin" --allowed=$admin - -# Creating user permission -ynh_permission_create --permission="user" - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/remove b/scripts/remove index d9d704e..0031436 100644 --- a/scripts/remove +++ b/scripts/remove @@ -9,26 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) - -#================================================= -# STANDARD REMOVE -#================================================= -# REMOVE APP MAIN DIR -#================================================= -ynh_script_progression --message="Removing app main directory..." --weight=1 - -# Remove the app directory securely -ynh_secure_remove --file="$final_path" - #================================================= # REMOVE NGINX CONFIGURATION #================================================= @@ -45,14 +25,6 @@ ynh_script_progression --message="Removing PHP-FPM configuration..." --weight=2 # Remove the dedicated PHP-FPM config ynh_remove_fpm_config -#================================================= -# REMOVE DEPENDENCIES -#================================================= -ynh_script_progression --message="Removing dependencies..." --weight=1 - -# Remove metapackage and its dependencies -ynh_remove_app_dependencies - #================================================= # SPECIFIC REMOVE #================================================= @@ -63,16 +35,6 @@ ynh_script_progression --message="Removing various files..." --weight=1 # Remove a cron file ynh_secure_remove --file="/etc/cron.d/$app" -#================================================= -# GENERIC FINALIZATION -#================================================= -# REMOVE DEDICATED USER -#================================================= -ynh_script_progression --message="Removing the dedicated system user..." --weight=1 - -# Delete a system user -ynh_system_user_delete --username=$app - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/restore b/scripts/restore index 843210c..edc753a 100644 --- a/scripts/restore +++ b/scripts/restore @@ -10,70 +10,18 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -ynh_clean_setup () { - true -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -path_url=$(ynh_app_setting_get --app=$app --key=path) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) -fpm_footprint=$(ynh_app_setting_get --app=$app --key=fpm_footprint) -fpm_usage=$(ynh_app_setting_get --app=$app --key=fpm_usage) - -#================================================= -# CHECK IF THE APP CAN BE RESTORED -#================================================= -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 -#================================================= -# RECREATE THE DEDICATED USER -#================================================= -ynh_script_progression --message="Recreating the dedicated system user..." --weight=3 - -# Create the dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" - #================================================= # RESTORE THE APP MAIN DIR #================================================= ynh_script_progression --message="Restoring the app main directory..." --weight=2 -ynh_restore_file --origin_path="$final_path" +ynh_restore_file --origin_path="$install_dir" -chown -R $app:www-data "$final_path" -find "$final_path" -type f -exec chmod 640 {} \; -find "$final_path/bin" -type f -exec chmod 750 {} \; -find "$final_path" -type d -exec chmod 750 {} \; -find "$final_path" -type d -exec chmod +s {} \; - -#================================================= -# SPECIFIC RESTORATION -#================================================= -# REINSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Reinstalling dependencies..." --weight=1 - -# Define and install dependencies -ynh_install_app_dependencies $pkg_dependencies +chown -R $app:www-data "$install_dir" +find "$install_dir" -type f -exec chmod 640 {} \; +find "$install_dir/bin" -type f -exec chmod 750 {} \; +find "$install_dir" -type d -exec chmod 750 {} \; +find "$install_dir" -type d -exec chmod +s {} \; #================================================= # RESTORE THE PHP-FPM CONFIGURATION diff --git a/scripts/update_version.sh b/scripts/update_version.sh deleted file mode 100755 index 9824561..0000000 --- a/scripts/update_version.sh +++ /dev/null @@ -1,89 +0,0 @@ -#!/bin/bash - -source /usr/share/yunohost/helpers - -repo="getgrav/grav" - -#================================================= -# META HELPER FOR PACKAGE RELEASES -#================================================= - -# This script is meant to be manually run by the app packagers -# to automatically update the source files. - -# Thanks @lukechild and @jbellocastro -# https://gist.github.com/lukechilds/a83e1d7127b78fef38c2914c4ececc3c -version=$(curl --silent "https://api.github.com/repos/$repo/releases/latest" | jq -r ".tag_name") -app_url=$(curl --silent "https://api.github.com/repos/$repo/releases/latest" | jq -r ".assets[0].browser_download_url") -app_upgrade_url=$(curl --silent "https://api.github.com/repos/$repo/releases/latest" | jq -r ".assets[0].browser_download_url") - -### -# APP.SRC -### - -# Create the temporary directory -tempdir="$(mktemp -d)" - -# Download sources and calculate checksum -filename=${app_url##*/} -curl --silent -4 -L $app_url -o "$tempdir/$filename" -checksum=$(sha256sum "$tempdir/$filename" | head -c 64) -ynh_secure_remove $tempdir - -# Get extension -if [[ $filename == *.tar.gz ]]; then - extension=tar.gz -else - extension=${filename##*.} -fi - -cat < ../conf/app.src -SOURCE_URL=$app_url -SOURCE_SUM=$checksum -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=$extension -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= -EOT - -### -# APP.UPDATE.SRC -### - -# Create the temporary directory -tempdir="$(mktemp -d)" - -# Download sources and calculate checksum -filename=${app_upgrade_url##*/} -curl --silent -4 -L $app_upgrade_url -o "$tempdir/$filename" -checksum=$(sha256sum "$tempdir/$filename" | head -c 64) -ynh_secure_remove $tempdir - -# Get extension -if [[ $filename == *.tar.gz ]]; then - extension=tar.gz -else - extension=${filename##*.} -fi - -cat < ../conf/app.src -SOURCE_URL=$app_upgrade_url -SOURCE_SUM=$checksum -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=$extension -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= -EOT - -### -# README and COMMIT -### - -sed -i "s# \"version\": \".*# \"version\": \"${version}\~ynh1\",#" ../manifest.json - -message="Upgrade to v$version" -if [ "$message" == "$(git show -s --format=%s)" ]; then - git commit ../manifest.json ../conf/app.src --amend -m "$message" -else - git commit ../manifest.json ../conf/app.src -m "$message" -fi diff --git a/scripts/upgrade b/scripts/upgrade index a5b85e3..178a811 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -9,24 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -path_url=$(ynh_app_setting_get --app=$app --key=path) -language=$(ynh_app_setting_get --app=$app --key=language) -admin=$(ynh_app_setting_get --app=$app --key=admin) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -fpm_footprint=$(ynh_app_setting_get --app=$app --key=fpm_footprint) -fpm_usage=$(ynh_app_setting_get --app=$app --key=fpm_usage) - -with_sftp=$(ynh_app_setting_get --app=$app --key=with_sftp) -password=$(ynh_app_setting_get --app=$app --key=password) - #================================================= # CHECK VERSION #================================================= @@ -34,20 +16,6 @@ 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)..." --weight=4 - -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - # Restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - #================================================= # STANDARD UPGRADE STEPS #================================================= @@ -55,31 +23,6 @@ ynh_abort_if_errors #================================================= ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 -# If final_path doesn't exist, create it -if [ -z "$final_path" ]; then - final_path=/var/www/$app - ynh_app_setting_set --app=$app --key=final_path --value=$final_path -fi - -# Cleaning legacy permissions -if ynh_legacy_permissions_exists; then - ynh_legacy_permissions_delete_all - - ynh_app_setting_delete --app=$app --key=is_public -fi - -# Giving admin permission to the specified used -if ! ynh_permission_exists --permission="admin" -then - ynh_permission_create --permission="admin" --allowed="$admin" -fi - -# Creating user permission -if ! ynh_permission_exists --permission="user" -then - ynh_permission_create --permission="user" -fi - # If fpm_footprint doesn't exist, create it if [ -z "$fpm_footprint" ]; then fpm_footprint=medium @@ -95,22 +38,14 @@ fi # If with_sftp or password don't exist, create them if [ -z "$with_sftp" ] || [ -z "$password" ]; then ynh_app_setting_set --app=$app --key=with_sftp --value="false" - ynh_app_setting_set --app=$app --key=password --value=$(ynh_string_random) + ynh_app_setting_set --app=$app --key=password --value=$(ynh_string_random) fi # Delete existing ini configuration file (backward compatibility) -if [ -f /etc/php/$YNH_PHP_VERSION/fpm/conf.d/20-$app.ini ]; then - ynh_secure_remove --file=/etc/php/$YNH_PHP_VERSION/fpm/conf.d/20-$app.ini +if [ -f /etc/php/$phpversion/fpm/conf.d/20-$app.ini ]; then + ynh_secure_remove --file=/etc/php/$phpversion/fpm/conf.d/20-$app.ini fi -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." --weight=3 - -# Create a dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" - #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= @@ -120,23 +55,16 @@ then ynh_script_progression --message="Upgrading source files..." --weight=2 # Download, check integrity, uncompress and patch the source from app.src - ynh_setup_source --dest_dir="$final_path" --source_id="app-upgrade" - ynh_setup_source --dest_dir="$final_path/user/plugins/login-ldap" --source_id="ldap" + ynh_setup_source --dest_dir="$install_dir" --source_id="app-upgrade" + ynh_setup_source --dest_dir="$install_dir/user/plugins/login-ldap" --source_id="ldap" fi # Set permissions on app files -chown -R $app:www-data "$final_path" -find "$final_path" -type f -exec chmod 640 {} \; -find "$final_path/bin" -type f -exec chmod 750 {} \; -find "$final_path" -type d -exec chmod 750 {} \; -find "$final_path" -type d -exec chmod +s {} \; - -#================================================= -# UPGRADE DEPENDENCIES -#================================================= -ynh_script_progression --message="Upgrading dependencies..." --weight=1 - -ynh_install_app_dependencies $pkg_dependencies +chown -R $app:www-data "$install_dir" +find "$install_dir" -type f -exec chmod 640 {} \; +find "$install_dir/bin" -type f -exec chmod 750 {} \; +find "$install_dir" -type d -exec chmod 750 {} \; +find "$install_dir" -type d -exec chmod +s {} \; #================================================= # PHP-FPM CONFIGURATION @@ -145,7 +73,6 @@ ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=1 # Create a dedicated PHP-FPM config ynh_add_fpm_config --usage=$fpm_usage --footprint=$fpm_footprint -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) #================================================= # NGINX CONFIGURATION @@ -162,20 +89,20 @@ ynh_add_nginx_config #================================================= ynh_script_progression --message="Updating a configuration file..." --weight=3 -mkdir -p "$final_path/user/config/plugins/login-ldap" -touch "$final_path/user/accounts/admin.yaml" +mkdir -p "$install_dir/user/config/plugins/login-ldap" +touch "$install_dir/user/accounts/admin.yaml" -ynh_add_config --template="../conf/login-ldap.yaml" --destination="$final_path/user/config/plugins/login-ldap.yaml" -chown $app:$app "$final_path/user/config/plugins/login-ldap.yaml" -chmod 640 "$final_path/user/config/plugins/login-ldap.yaml" +ynh_add_config --template="../conf/login-ldap.yaml" --destination="$install_dir/user/config/plugins/login-ldap.yaml" +chown $app:$app "$install_dir/user/config/plugins/login-ldap.yaml" +chmod 640 "$install_dir/user/config/plugins/login-ldap.yaml" #================================================= # UPGRADE PLUGINS #================================================= ynh_script_progression --message="Updating all plugins..." --weight=1 -pushd "$final_path" - ynh_exec_warn_less yes N | ynh_exec_warn_less ynh_exec_as $app php${YNH_PHP_VERSION} bin/gpm update --all-yes --no-interaction || ynh_print_warn --message="Automatic plugin upgrade has failed, you can upgrade them from your Grav admin panel." +pushd "$install_dir" + ynh_exec_warn_less yes N | ynh_exec_warn_less ynh_exec_as $app php${phpversion} bin/gpm update --all-yes --no-interaction || ynh_print_warn --message="Automatic plugin upgrade has failed, you can upgrade them from your Grav admin panel." popd #================================================= @@ -183,18 +110,9 @@ popd #================================================ ynh_script_progression --message="Updating a cron task..." --weight=1 -echo "* * * * * $app php${YNH_PHP_VERSION} $final_path/bin/grav scheduler 1>> /dev/null 2>&1" > /etc/cron.d/$app +echo "* * * * * $app php${phpversion} $install_dir/bin/grav scheduler 1>> /dev/null 2>&1" > /etc/cron.d/$app chmod 644 /etc/cron.d/$app -#================================================= -# GENERIC FINALIZATION -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #=================================================