diff --git a/conf/extra_php-fpm.conf b/conf/extra_php-fpm.conf deleted file mode 100644 index 700c37c..0000000 --- a/conf/extra_php-fpm.conf +++ /dev/null @@ -1,4 +0,0 @@ -; Additional php.ini defines, specific to this pool of workers. - -php_admin_value[upload_max_filesize] = 50M -php_admin_value[post_max_size] = 50M diff --git a/conf/nginx.conf b/conf/nginx.conf index badda2d..84ffa34 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -10,7 +10,7 @@ location __PATH__/ { try_files $uri __PATH__/index.php; location ~ \.php$ { - fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock; + fastcgi_pass unix:/var/run/php/php__PHP_VERSION__-fpm-__APP__.sock; fastcgi_index index.php; include fastcgi_params; diff --git a/manifest.toml b/manifest.toml index 1db7f15..bb169cb 100644 --- a/manifest.toml +++ b/manifest.toml @@ -19,7 +19,8 @@ admindoc = "https://docs.cachethq.io" code = "https://github.com/CachetHQ/Cachet" [integration] -yunohost = ">= 11.2" +yunohost = ">= 11.2.18" +helpers_version = "2.1" architectures = "all" multi_instance = true @@ -62,6 +63,7 @@ ram.runtime = "50M" [resources.system_user] [resources.install_dir] + group = "www-data:r-x" [resources.permissions] main.url = "/" diff --git a/scripts/_common.sh b/scripts/_common.sh index 578215c..4c913df 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -1,23 +1,12 @@ #!/bin/bash #================================================= -# COMMON VARIABLES -#================================================= - -#================================================= -# PERSONAL HELPERS +# COMMON VARIABLES AND CUSTOM HELPERS #================================================= # Execute a command with occ exec_artisan() { - (cd "$install_dir" && - php$phpversion artisan $@ --quiet --no-interaction) + (cd "$install_dir" && + + php$php_version artisan $@ --quiet --no-interaction) } - -#================================================= -# EXPERIMENTAL HELPERS -#================================================= - -#================================================= -# FUTURE OFFICIAL HELPERS -#================================================= diff --git a/scripts/backup b/scripts/backup index 214b288..5f6ebae 100644 --- a/scripts/backup +++ b/scripts/backup @@ -1,47 +1,38 @@ #!/bin/bash -#================================================= -# GENERIC START -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - # Keep this path for calling _common.sh inside the execution's context of backup and restore scripts source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# DECLARE DATA AND CONF FILES TO BACKUP -#================================================= -ynh_print_info --message="Declaring files to be backed up..." +ynh_print_info "Declaring files to be backed up..." #================================================= # BACKUP THE APP MAIN DIR #================================================= -ynh_backup --src_path="$install_dir" +ynh_backup "$install_dir" #================================================= # BACKUP THE NGINX CONFIGURATION #================================================= -ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" +ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= # BACKUP THE PHP-FPM CONFIGURATION #================================================= -ynh_backup --src_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" +ynh_backup "/etc/php/$php_version/fpm/pool.d/$app.conf" #================================================= # BACKUP THE MYSQL DATABASE #================================================= -ynh_print_info --message="Backing up the MySQL database..." +ynh_print_info "Backing up the MySQL database..." -ynh_mysql_dump_db --database="$db_name" > db.sql +ynh_mysql_dump_db > db.sql #================================================= # END OF SCRIPT #================================================= -ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." +ynh_print_info "Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." diff --git a/scripts/change_url b/scripts/change_url index 9179462..8e45d18 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -1,45 +1,37 @@ #!/bin/bash -#================================================= -# GENERIC STARTING -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - source _common.sh source /usr/share/yunohost/helpers -#================================================= -# STANDARD MODIFICATIONS #================================================= # MODIFY URL IN NGINX CONF #================================================= -ynh_script_progression --message="Updating NGINX web server configuration..." --weight=2 +ynh_script_progression "Updating NGINX web server configuration..." -ynh_change_url_nginx_config +ynh_config_change_url_nginx #================================================= # SPECIFIC MODIFICATIONS #================================================= # UPDATE A CONFIG FILE #================================================= -ynh_script_progression --message="Updating a configuration file..." --weight=1 +ynh_script_progression "Updating configuration..." -ynh_backup_if_checksum_is_different --file="$install_dir/.env" -ynh_backup_if_checksum_is_different --file="$install_dir/bootstrap/cachet/production.php" +ynh_backup_if_checksum_is_different "$install_dir/.env" +ynh_backup_if_checksum_is_different "$install_dir/bootstrap/cachet/production.php" # Replace domain in Cachet configuration files -ynh_replace_string --match_string="$old_domain" --replace_string="$new_domain" --target_file="$install_dir/.env" -ynh_replace_string --match_string="$old_domain" --replace_string="$new_domain" --target_file="$install_dir/bootstrap/cachet/production.php" +ynh_replace --match="$old_domain" --replace="$new_domain" --file="$install_dir/.env" +ynh_replace --match="$old_domain" --replace="$new_domain" --file="$install_dir/bootstrap/cachet/production.php" -ynh_store_file_checksum --file="$install_dir/.env" -ynh_store_file_checksum --file="$install_dir/bootstrap/cachet/production.php" +ynh_store_file_checksum "$install_dir/.env" +ynh_store_file_checksum "$install_dir/bootstrap/cachet/production.php" # Replace domain in Cachet database settings -ynh_mysql_connect_as --user="$db_user" --password="$db_pwd" --database="$db_name" <<< "UPDATE settings SET value = 'https://$new_domain' WHERE name = 'app_domain'" +ynh_mysql_db_shell <<< "UPDATE settings SET value = 'https://$new_domain' WHERE name = 'app_domain'" #================================================= # END OF SCRIPT #================================================= -ynh_script_progression --message="Change of URL completed for $app" --last +ynh_script_progression "Change of URL completed for $app" diff --git a/scripts/install b/scripts/install index 81c8865..48af307 100644 --- a/scripts/install +++ b/scripts/install @@ -1,11 +1,5 @@ #!/bin/bash -#================================================= -# GENERIC START -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - source _common.sh source /usr/share/yunohost/helpers @@ -18,45 +12,45 @@ admin_mail="$(ynh_user_get_info --username=$admin --key=mail)" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= -ynh_script_progression --message="Setting up source files..." --weight=5 +ynh_script_progression "Setting up source files..." # Download, check integrity, uncompress and patch the source from app.src ynh_setup_source --dest_dir="$install_dir" -chmod -R o-rwx "$install_dir" -chown -R $app:www-data "$install_dir" - +#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod -R o-rwx "$install_dir" +#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown -R $app:www-data "$install_dir" #================================================= # SYSTEM CONFIGURATION #================================================= -ynh_script_progression --message="Adding system configurations related to $app..." --weight=1 +ynh_script_progression "Adding system configurations related to $app..." # Create a dedicated NGINX config -ynh_add_nginx_config +ynh_config_add_nginx # Create a dedicated PHP-FPM config -ynh_add_fpm_config +ynh_config_add_phpfpm #================================================= # SPECIFIC SETUP #================================================= # PRE-CONFIGURE CACHET #================================================= -ynh_script_progression --message="Pre-configuring Cachet..." --weight=10 +ynh_script_progression "Pre-configuring Cachet..." -ynh_add_config --template=".env.example" --destination="$install_dir/.env" +ynh_config_add --template=".env.example" --destination="$install_dir/.env" #================================================= # INSTALL AND INITIALIZE COMPOSER #================================================= -ynh_script_progression --message="Installing with composer..." +ynh_script_progression "Installing with composer..." -ynh_install_composer --install_args="--optimize-autoloader" +ynh_composer_install +ynh_composer_exec install --no-dev --optimize-autoloader #================================================= # FINALIZE CACHET INSTALLATION #================================================= -ynh_script_progression --message="Installing Cachet..." +ynh_script_progression "Installing Cachet..." mkdir -p "$install_dir/storage/app/public" exec_artisan "key:generate" @@ -65,18 +59,18 @@ exec_artisan "cachet:install" #================================================= # FINALIZE CACHET CONFIGURATION #================================================= -ynh_script_progression --message="Finalizing Cachet configuration..." +ynh_script_progression "Finalizing Cachet configuration..." -password_hash="$(cd $install_dir ; php$phpversion artisan tinker -q --no-ansi <<< "echo Hash::make('$password');" |head -n 1)" +password_hash="$(cd $install_dir ; php$php_version artisan tinker -q --no-ansi <<< "echo Hash::make('$password');" |head -n 1)" password_pash="${password_hash::-1}" # Remove last character # Populate MySQL database -ynh_add_config --template="init-mysql.sql" --destination="$install_dir/init-mysql.sql" -ynh_mysql_connect_as --user="$db_name" --password="$db_pwd" --database="$db_name" < "$install_dir/init-mysql.sql" -ynh_delete_file_checksum --file="$install_dir/init-mysql.sql" -#REMOVEME? ynh_secure_remove --file="$install_dir/init-mysql.sql" +ynh_config_add --template="init-mysql.sql" --destination="$install_dir/init-mysql.sql" +ynh_mysql_db_shell < "$install_dir/init-mysql.sql" +ynh_delete_file_checksum "$install_dir/init-mysql.sql" +#REMOVEME? ynh_safe_rm "$install_dir/init-mysql.sql" -ynh_add_config --template="../conf/production.php" --destination="$install_dir/bootstrap/cachet/production.php" +ynh_config_add --template="production.php" --destination="$install_dir/bootstrap/cachet/production.php" chown $app: $install_dir/bootstrap/cachet/production.php #================================================= @@ -84,13 +78,13 @@ chown $app: $install_dir/bootstrap/cachet/production.php #================================================= # Set permissions to app files -chmod 750 "$install_dir" -chmod -R o-rwx "$install_dir" -chown -R $app:www-data "$install_dir" +#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 750 "$install_dir" +#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod -R o-rwx "$install_dir" +#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown -R $app:www-data "$install_dir" chown -R $app: "${install_dir}/.env" "${install_dir}/storage/" "${install_dir}/bootstrap/" #================================================= # END OF SCRIPT #================================================= -ynh_script_progression --message="Installation of $app completed" --last +ynh_script_progression "Installation of $app completed" diff --git a/scripts/remove b/scripts/remove index 5b17c2d..8069c9c 100644 --- a/scripts/remove +++ b/scripts/remove @@ -1,27 +1,21 @@ #!/bin/bash -#================================================= -# GENERIC START -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - source _common.sh source /usr/share/yunohost/helpers #================================================= # REMOVE SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Removing system configurations related to $app..." --weight=1 +ynh_script_progression "Removing system configurations related to $app..." # Remove the dedicated NGINX config -ynh_remove_nginx_config +ynh_config_remove_nginx # Remove the dedicated PHP-FPM config -ynh_remove_fpm_config +ynh_config_remove_phpfpm #================================================= # END OF SCRIPT #================================================= -ynh_script_progression --message="Removal of $app completed" --last +ynh_script_progression "Removal of $app completed" diff --git a/scripts/restore b/scripts/restore index f30ebe1..645cf5f 100644 --- a/scripts/restore +++ b/scripts/restore @@ -1,11 +1,5 @@ #!/bin/bash -#================================================= -# GENERIC START -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - # Keep this path for calling _common.sh inside the execution's context of backup and restore scripts source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers @@ -13,44 +7,42 @@ source /usr/share/yunohost/helpers #================================================= # RESTORE THE APP MAIN DIR #================================================= -ynh_script_progression --message="Restoring the app main directory..." --weight=1 +ynh_script_progression "Restoring the app main directory..." -ynh_restore_file --origin_path="$install_dir" +ynh_restore "$install_dir" -chmod -R o-rwx "$install_dir" -chown -R $app:www-data "$install_dir" +#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod -R o-rwx "$install_dir" +#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown -R $app:www-data "$install_dir" chown -R $app: "${install_dir}/.env" "${install_dir}/storage/" "${install_dir}/bootstrap/" #================================================= # RESTORE THE MYSQL DATABASE #================================================= -ynh_script_progression --message="Restoring the MySQL database..." --weight=2 +ynh_script_progression "Restoring the MySQL database..." -ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql +ynh_mysql_db_shell < ./db.sql #================================================= # RESTORE SYSTEM CONFIGURATIONS #================================================= # RESTORE THE PHP-FPM CONFIGURATION #================================================= -ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1 +ynh_script_progression "Restoring system configurations related to $app..." -ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" +ynh_restore "/etc/php/$php_version/fpm/pool.d/$app.conf" -ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" +ynh_restore "/etc/nginx/conf.d/$domain.d/$app.conf" -#================================================= -# GENERIC FINALIZATION #================================================= # RELOAD NGINX AND PHP-FPM #================================================= -ynh_script_progression --message="Reloading NGINX web server and PHP-FPM..." --weight=1 +ynh_script_progression "Reloading NGINX web server and PHP-FPM..." -ynh_systemd_action --service_name=php$phpversion-fpm --action=reload -ynh_systemd_action --service_name=nginx --action=reload +ynh_systemctl --service=php$php_version-fpm --action=reload +ynh_systemctl --service=nginx --action=reload #================================================= # END OF SCRIPT #================================================= -ynh_script_progression --message="Restoration completed for $app" --last +ynh_script_progression "Restoration completed for $app" diff --git a/scripts/upgrade b/scripts/upgrade index ddcdd85..3eddc1b 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -1,11 +1,5 @@ #!/bin/bash -#================================================= -# GENERIC START -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - source _common.sh source /usr/share/yunohost/helpers @@ -19,49 +13,48 @@ exec_artisan "down" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= -ynh_script_progression --message="Upgrading source files..." --weight=1 +ynh_script_progression "Upgrading source files..." -ynh_setup_source --dest_dir="$install_dir" --full_replace=1 --keep=".env bootstrap/cachet/production.php" +ynh_setup_source --dest_dir="$install_dir" --full_replace --keep=".env bootstrap/cachet/production.php" -chmod -R o-rwx "$install_dir" -chown -R $app:www-data "$install_dir" +#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod -R o-rwx "$install_dir" +#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown -R $app:www-data "$install_dir" chown -R $app: "${install_dir}/.env" "${install_dir}/storage/" "${install_dir}/bootstrap/" #================================================= # REAPPLY SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1 +ynh_script_progression "Upgrading system configurations related to $app..." # Create a dedicated NGINX config -ynh_add_nginx_config +ynh_config_add_nginx # Create a dedicated PHP-FPM config -ynh_add_fpm_config +ynh_config_add_phpfpm -#================================================= -# SPECIFIC UPGRADE #================================================= # INSTALL AND INITIALIZE COMPOSER #================================================= -ynh_script_progression --message="Upgrading Cachet configuration and dependencies..." --weight=20 +ynh_script_progression "Upgrading Cachet configuration and dependencies..." -ynh_install_composer --install_args="--optimize-autoloader" +ynh_composer_install +ynh_composer_exec install --no-dev --optimize-autoloader #================================================= # UPDATE CACHET CONFIGURATION #================================================= exec_artisan "app:update" -ynh_secure_remove --file=bootstrap/cache/* +ynh_safe_rm bootstrap/cache/* #================================================= # SECURE FILES AND DIRECTORIES #================================================= # Set permissions to app files -chmod 750 "$install_dir" -chmod -R o-rwx "$install_dir" -chown -R $app:www-data "$install_dir" +#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 750 "$install_dir" +#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod -R o-rwx "$install_dir" +#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown -R $app:www-data "$install_dir" chown -R $app: "${install_dir}/.env" "${install_dir}/storage/" "${install_dir}/bootstrap/" #================================================= @@ -74,4 +67,4 @@ exec_artisan "up" # END OF SCRIPT #================================================= -ynh_script_progression --message="Upgrade of $app completed" --last +ynh_script_progression "Upgrade of $app completed"