diff --git a/README.md b/README.md index 0dddc92..68b4c2b 100755 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Integration level](https://dash.yunohost.org/integration/plume.svg)](https://dash.yunohost.org/appci/app/plume) [![Install Plume with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=plume) -> *This package allow you to install plume quickly and simply on a YunoHost server. +> *This package allow you to install Plume quickly and simply on a YunoHost server. If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* ## Overview diff --git a/check_process b/check_process index 4da5afc..bd00a97 100755 --- a/check_process +++ b/check_process @@ -1,8 +1,3 @@ -# 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" (DOMAIN) @@ -19,6 +14,7 @@ setup_private=1 setup_public=1 upgrade=1 + upgrade=1 from_commit=900b9857defd4a866907459372ed2f78a43c4229 backup_restore=1 multi_instance=1 incorrect_path=1 diff --git a/conf/app.src b/conf/app.src deleted file mode 100755 index e4dd89f..0000000 --- a/conf/app.src +++ /dev/null @@ -1,6 +0,0 @@ -SOURCE_URL=url of app's source -SOURCE_SUM=sha256 checksum -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= diff --git a/scripts/backup b/scripts/backup index b5a9ea2..b9d3de9 100755 --- a/scripts/backup +++ b/scripts/backup @@ -15,7 +15,6 @@ source ../settings/scripts/ynh_systemd_action #================================================= ynh_clean_setup () { - ### Remove this function if there's nothing to clean before calling the remove script. ynh_clean_check_starting } # Exit if an error occurs during the execution of the script @@ -48,13 +47,6 @@ ynh_print_info "Backing up nginx web server configuration..." ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" -#================================================= -# BACKUP THE PHP-FPM CONFIGURATION -#================================================= -ynh_print_info "Backing up php-fpm configuration..." - -#ynh_backup "/etc/php/7.0/fpm/pool.d/$app.conf" - #================================================= # BACKUP THE POSTGRESQL DATABASE #================================================= @@ -78,12 +70,6 @@ ynh_print_info "Backing up systemd configuration..." ynh_backup "/etc/systemd/system/$app.service" -#================================================= -# BACKUP A CRON FILE -#================================================= - -#ynh_backup "/etc/cron.d/$app" - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/change_url b/scripts/change_url index 10d1fd9..43a99d5 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -35,15 +35,6 @@ final_path=$(ynh_app_setting_get $app final_path) #db_name=$(ynh_app_setting_get "$app" db_name) #db_pwd=$(ynh_app_setting_get $app db_pwd) -#================================================= -# CHECK THE SYNTAX OF THE PATHS -#================================================= - -test -n "$old_path" || old_path="/" -test -n "$new_path" || new_path="/" -new_path=$(ynh_normalize_url_path $new_path) -old_path=$(ynh_normalize_url_path $old_path) - #================================================= # CHECK WHICH PARTS SHOULD BE CHANGED #================================================= @@ -115,8 +106,6 @@ ynh_systemd_action --action=start --service_name=$app --log_path=systemd --line_ # STORE THE CONFIG FILE CHECKSUM #================================================= -### Verify the checksum of a file, stored by `ynh_store_file_checksum` in the install script. -### And create a backup of this file if the checksum is different. So the file will be backed up if the admin had modified it. ynh_backup_if_checksum_is_different "$final_path/$app/.env" # Recalculate and store the checksum of the file for the next upgrade. ynh_store_file_checksum "$final_path/$app/.env" diff --git a/scripts/install b/scripts/install index 44c1dd3..1fbb5a3 100755 --- a/scripts/install +++ b/scripts/install @@ -15,7 +15,6 @@ source /usr/share/yunohost/helpers #================================================= ynh_clean_setup () { - ### Remove this function if there's nothing to clean before calling the remove script. ynh_clean_check_starting } # Exit if an error occurs during the execution of the script @@ -35,16 +34,6 @@ registration=$YNH_APP_ARG_REGISTRATION admin_email=$(ynh_user_get_info $admin 'mail') secret_key=$(openssl rand -base64 32) -### If it's a multi-instance app, meaning it can be installed several times independently -### The id of the app as stated in the manifest is available as $YNH_APP_ID -### The instance number is available as $YNH_APP_INSTANCE_NUMBER (equals "1", "2", ...) -### The app instance name is available as $YNH_APP_INSTANCE_NAME -### - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample -### - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2 -### - ynhexample__{N} for the subsequent installations, with N=3,4, ... -### The app instance name is probably what interests you most, since this is -### guaranteed to be unique. This is a good unique identifier to define installation path, -### db names, ... app=$YNH_APP_INSTANCE_NAME #================================================= @@ -52,14 +41,9 @@ app=$YNH_APP_INSTANCE_NAME #================================================= ynh_print_info "Validating installation parameters..." -### If the app uses nginx as web server (written in HTML/PHP in most cases), the final path should be "/var/www/$app". -### If the app provides an internal web server (or uses another application server such as uwsgi), the final path should be "/opt/yunohost/$app" final_path=/var/www/$app test ! -e "$final_path" || ynh_die "This path already contains a folder" -# Normalize the url path syntax -path_url=$(ynh_normalize_url_path $path_url) - # Register (book) web path ynh_webpath_register $app $domain $path_url @@ -72,7 +56,7 @@ ynh_app_setting_set $app domain $domain ynh_app_setting_set $app path $path_url ynh_app_setting_set $app admin $admin ynh_app_setting_set $app is_public $is_public -#ynh_app_setting_set $app language $language + ynh_app_setting_set $app instance $instance_name ynh_app_setting_set $app registration $registration ynh_app_setting_set $app admin_email $admin_email @@ -85,15 +69,9 @@ ynh_app_setting_set $app secret_key $secret_key #================================================= ynh_print_info "Configuring firewall ..." -### Use these lines if you have to open a port for the application -### `ynh_find_port` will find the first available port starting from the given port. -### If you're not using these lines: -### - Remove the section "CLOSE A PORT" in the remove script - # Find a free port port=$(ynh_find_port 8095) -# Open this port -#ynh_exec_warn_less yunohost firewall allow --no-upnp TCP $port + ynh_app_setting_set $app port $port #================================================= @@ -101,14 +79,6 @@ ynh_app_setting_set $app port $port #================================================= ynh_print_info "Installing dependencies ..." -### `ynh_install_app_dependencies` allows you to add any "apt" dependencies to the package. -### Those deb packages will be installed as dependencies of this package. -### If you're not using this helper: -### - Remove the section "REMOVE DEPENDENCIES" in the remove script -### - Remove the variable "pkg_dependencies" in _common.sh -### - As well as the section "REINSTALL DEPENDENCIES" in the restore script -### - And the section "UPGRADE DEPENDENCIES" in the upgrade script - ynh_install_app_dependencies $pkg_dependencies #================================================= @@ -116,13 +86,6 @@ ynh_install_app_dependencies $pkg_dependencies #================================================= ynh_print_info "Creating a PostgreSQL database..." -### Use these lines if you need a database for the application. -### `ynh_psql_test_if_first_run` will create a master password and set up global settings. -### If you're not using these lines: -### - Remove the section "BACKUP THE POSTGRESQL DATABASE" in the backup script -### - Remove also the section "REMOVE THE POSTGRESQL DATABASE" in the remove script -### - As well as the section "RESTORE THE POSTGRESQL DATABASE" in the restore script - ynh_psql_test_if_first_run db_name=$(ynh_sanitize_dbid $app) db_pwd=$(ynh_string_random 30) @@ -136,13 +99,8 @@ ynh_psql_execute_as_root "CREATE DATABASE $db_name ENCODING 'UTF8' LC_COLLATE='C #================================================= ynh_print_info "Setting up source files ..." -### `ynh_setup_source` is used to install an app from a zip or tar.gz file, -### downloaded from an upstream source, like a git repository. -### `ynh_setup_source` use the file conf/app.src - ynh_app_setting_set $app final_path $final_path # Download, check integrity, uncompress and patch the source from app.src -#ynh_setup_source "$final_path" git clone https://github.com/Plume-org/Plume.git "$final_path/$app" # Create the media directory, where uploads will be stored @@ -153,8 +111,6 @@ mkdir $final_path/media #================================================= ynh_print_info "Configuring nginx web server..." -### `ynh_add_nginx_config` will use the file conf/nginx.conf - # Create a dedicated nginx config ynh_add_nginx_config @@ -166,25 +122,6 @@ ynh_print_info "Configuring system user ..." # Create a system user ynh_system_user_create $app "$final_path" -#================================================= -# PHP-FPM CONFIGURATION -#================================================= -ynh_print_info "Configuring php-fpm ..." - -### `ynh_add_fpm_config` is used to set up a PHP config. -### You can remove it if your app doesn't use PHP. -### `ynh_add_fpm_config` will use the files conf/php-fpm.conf and conf/php-fpm.ini -### If you're not using these lines: -### - You can remove these files in conf/. -### - Remove the section "BACKUP THE PHP-FPM CONFIGURATION" in the backup script -### - Remove also the section "REMOVE PHP-FPM CONFIGURATION" in the remove script -### - As well as the section "RESTORE THE PHP-FPM CONFIGURATION" in the restore script -### With the reload at the end of the script. -### - And the section "PHP-FPM CONFIGURATION" in the upgrade script - -# Create a dedicated php-fpm config -#ynh_add_fpm_config - #================================================= # SPECIFIC SETUP #================================================= @@ -246,68 +183,13 @@ popd #================================================= ynh_print_info "Configuring a systemd service ..." -### `ynh_systemd_config` is used to configure a systemd script for an app. -### It can be used for apps that use sysvinit (with adaptation) or systemd. -### Have a look at the app to be sure this app needs a systemd script. -### `ynh_systemd_config` will use the file conf/systemd.service -### If you're not using these lines: -### - You can remove those files in conf/. -### - Remove the section "BACKUP SYSTEMD" in the backup script -### - Remove also the section "STOP AND REMOVE SERVICE" in the remove script -### - As well as the section "RESTORE SYSTEMD" in the restore script -### - And the section "SETUP SYSTEMD" in the upgrade script - # Create a dedicated systemd config ynh_add_systemd_config -#================================================= -# SETUP APPLICATION WITH CURL -#================================================= - -### Use these lines only if the app installation needs to be finalized through -### web forms. We generally don't want to ask the final user, -### so we're going to use curl to automatically fill the fields and submit the -### forms. - -# Set right permissions for curl install -#chown -R $app: $final_path - -# Set the app as temporarily public for curl call -#ynh_print_info "Configuring ssowat ..." -#ynh_app_setting_set $app skipped_uris "/" -# Reload SSOwat config -#yunohost app ssowatconf - -# Reload Nginx -#systemctl reload nginx - -# Installation with curl -#ynh_print_info "Finalizing install ..." -#ynh_local_curl "/INSTALL_PATH" "key1=value1" "key2=value2" "key3=value3" - -# Remove the public access -#if [ $is_public -eq 0 ] -#then -# ynh_app_setting_delete $app skipped_uris -#fi - -#================================================= -# MODIFY A CONFIG FILE -#================================================= - -### `ynh_replace_string` is used to replace a string in a file. -### (It's compatible with sed regular expressions syntax) - -#ynh_replace_string "match_string" "replace_string" "$final_path/CONFIG_FILE" - #================================================= # STORE THE CONFIG FILE CHECKSUM #================================================= -### `ynh_store_file_checksum` is used to store the checksum of a file. -### That way, during the upgrade script, by using `ynh_backup_if_checksum_is_different`, -### you can make a backup of this file before modifying it again if the admin had modified it. - # Calculate and store the config file checksum into the app settings ynh_store_file_checksum "$final_path/$app/.env" @@ -317,26 +199,14 @@ ynh_store_file_checksum "$final_path/$app/.env" # SECURE FILES AND DIRECTORIES #================================================= -### For security reason, any app should set the permissions to root: before anything else. -### Then, if write authorization is needed, any access should be given only to directories -### that really need such authorization. - # Set permissions to app files -# chown -R $app: $final_path +chown -R $app: $final_path #================================================= # SETUP LOGROTATE #================================================= ynh_print_info "Configuring log rotation ..." -### `ynh_use_logrotate` is used to configure a logrotate configuration for the logs of this app. -### Use this helper only if there is effectively a log file for this app. -### If you're not using this helper: -### - Remove the section "BACKUP LOGROTATE" in the backup script -### - Remove also the section "REMOVE LOGROTATE CONFIGURATION" in the remove script -### - As well as the section "RESTORE THE LOGROTATE CONFIGURATION" in the restore script -### - And the section "SETUP LOGROTATE" in the upgrade script - # Use logrotate to manage application logfile(s) ynh_use_logrotate @@ -344,16 +214,6 @@ ynh_use_logrotate # ADVERTISE SERVICE IN ADMIN PANEL #================================================= -### `yunohost service add` is a CLI yunohost command to add a service in the admin panel. -### You'll find the service in the 'services' section of YunoHost admin panel. -### This CLI command would be useless if the app does not have any services (systemd or sysvinit) -### If you're not using these lines: -### - You can remove these files in conf/. -### - Remove the section "REMOVE SERVICE FROM ADMIN PANEL" in the remove script -### - As well as the section ADVERTISE SERVICE IN ADMIN PANEL" in the restore script - -#yunohost service add $app --log "/var/log/$app/APP.log" -# if using yunohost version 3.2 or more in the 'manifest.json', a description can be added yunohost service add $app --description "$app daemon for XXX" --log "/var/log/$app/$app.log" #================================================= diff --git a/scripts/remove b/scripts/remove index 14a1357..29d0225 100755 --- a/scripts/remove +++ b/scripts/remove @@ -85,14 +85,6 @@ ynh_print_info "Removing nginx web server configuration" # Remove the dedicated nginx config ynh_remove_nginx_config -#================================================= -# REMOVE PHP-FPM CONFIGURATION -#================================================= -ynh_print_info "Removing php-fpm configuration" - -# Remove the dedicated php-fpm config -#ynh_remove_fpm_config - #================================================= # REMOVE LOGROTATE CONFIGURATION #================================================= @@ -118,9 +110,6 @@ fi # REMOVE THE CRON FILE #================================================= -# Remove a cron file -#ynh_secure_remove "/etc/cron.d/$app" - # Remove a directory securely ynh_secure_remove "/etc/$app/" diff --git a/scripts/restore b/scripts/restore index a444990..adf2491 100755 --- a/scripts/restore +++ b/scripts/restore @@ -15,7 +15,6 @@ source /usr/share/yunohost/helpers #================================================= ynh_clean_setup () { - #### Remove this function if there's nothing to clean before calling the remove script. ynh_clean_check_starting } # Exit if an error occurs during the execution of the script @@ -74,12 +73,6 @@ ynh_system_user_create "$app" "$final_path" # Restore permissions on app files chown -R "$app":"$app" $final_path -#================================================= -# RESTORE THE PHP-FPM CONFIGURATION -#================================================= - -#ynh_restore_file "/etc/php/7.0/fpm/pool.d/$app.conf" - #================================================= # SPECIFIC RESTORATION #================================================= @@ -130,12 +123,6 @@ chown -R "$app":"$app" "/var/log/$app" yunohost service add $app --log "/var/log/$app/$app.log" -#================================================= -# RESTORE THE CRON FILE -#================================================= - -#ynh_restore_file "/etc/cron.d/$app" - #================================================= # RESTORE THE LOGROTATE CONFIGURATION #================================================= @@ -145,11 +132,10 @@ ynh_restore_file "/etc/logrotate.d/$app" #================================================= # GENERIC FINALIZATION #================================================= -# RELOAD NGINX AND PHP-FPM +# RELOAD NGINX #================================================= -ynh_print_info "Reloading nginx web server and php-fpm..." +ynh_print_info "Reloading nginx web server..." -#systemctl reload php7.0-fpm systemctl reload nginx #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 27c06da..186d362 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -29,17 +29,6 @@ secret_key=$(ynh_app_setting_get "$app" secret_key) name=$(ynh_app_setting_get "$app" name) port=$(ynh_app_setting_get "$app" port) -psql_db=$(ynh_app_setting_get "$app" psql_db) - -if [ -n "$psql_db" ] -then - db_name=$(ynh_app_setting_get "$app" psql_db) - db_pwd=$(ynh_app_setting_get "$app" psqlpwd) - ynh_app_setting_set "$app" db_name "$db_name" - ynh_app_setting_set "$app" db_pwd "$db_pwd" - ynh_app_setting_delete "$app" psql_db - ynh_app_setting_delete "$app" psqlpwd -fi #================================================= # ENSURE DOWNWARD COMPATIBILITY @@ -67,6 +56,19 @@ if [ -z $final_path ]; then ynh_app_setting_set $app final_path $final_path fi +#Fix previous database name +psql_db=$(ynh_app_setting_get "$app" psql_db) + +if [ -n "$psql_db" ] +then + db_name=$(ynh_app_setting_get "$app" psql_db) + db_pwd=$(ynh_app_setting_get "$app" psqlpwd) + ynh_app_setting_set "$app" db_name "$db_name" + ynh_app_setting_set "$app" db_pwd "$db_pwd" + ynh_app_setting_delete "$app" psql_db + ynh_app_setting_delete "$app" psqlpwd +fi + #================================================= # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP #================================================= @@ -103,11 +105,9 @@ path_url=$(ynh_normalize_url_path $path_url) ynh_print_info "Upgrading source files..." # Download, check integrity, uncompress and patch the source from app.src -#ynh_setup_source "$final_path" -pushd $final_path/$app - git reset --hard - git pull --quiet -popd +git clone --quiet https://github.com/Plume-org/Plume.git "$final_path/upgrade" +cp -a "$final_path/upgrade/." "$final_path/$app/." +rm -r "$final_path/upgrade" #================================================= # NGINX CONFIGURATION @@ -132,14 +132,6 @@ ynh_print_info "Making sure dedicated system user exists..." # Create a dedicated user (if not existing) ynh_system_user_create "$app" "$final_path" -#================================================= -# PHP-FPM CONFIGURATION -#================================================= -ynh_print_info "Upgrading php-fpm configuration..." - -# Create a dedicated php-fpm config -#ynh_add_fpm_config - #================================================= # SPECIFIC UPGRADE #================================================= @@ -179,8 +171,6 @@ pushd $final_path/$app sudo -u "$app" env PATH=$PATH diesel migration run popd -### Verify the checksum of a file, stored by `ynh_store_file_checksum` in the install script. -### And create a backup of this file if the checksum is different. So the file will be backed up if the admin had modified it. ynh_backup_if_checksum_is_different "$final_path/.env" # Recalculate and store the checksum of the file for the next upgrade. ynh_store_file_checksum "$final_path/$app/.env"