qr_ynh/scripts/install

169 lines
6.8 KiB
Plaintext
Raw Normal View History

2019-08-12 23:55:33 +02:00
#!/bin/bash
#=================================================
# GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
2019-08-13 21:35:51 +02:00
source _common.sh
2019-08-12 23:55:33 +02:00
source /usr/share/yunohost/helpers
#=================================================
# MANAGE SCRIPT FAILURE
#=================================================
2019-08-13 21:35:51 +02:00
ynh_clean_setup () {
### Remove this function if there's nothing to clean before calling the remove script.
true
}
2019-08-12 23:55:33 +02:00
# 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
2019-08-13 21:35:51 +02:00
### 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
2019-08-12 23:55:33 +02:00
#=================================================
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
#=================================================
2019-08-13 21:35:51 +02:00
### About --weight and --time
### ynh_script_progression will show to your final users the progression of each scripts.
### In order to do that, --weight will represent the relative time of execution compared to the other steps in the script.
### --time is a packager option, it will show you the execution time since the previous call.
### This option should be removed before releasing your app.
### Use the execution time, given by --time, to estimate the weight of a step.
### A common way to do it is to set a weight equal to the execution time in second +1.
### The execution time is given for the duration since the previous call. So the weight should be applied to this previous call.
2020-10-25 16:31:23 +01:00
ynh_script_progression --message="Validating installation parameters..."
2019-08-13 21:35:51 +02:00
### 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 --message="This path already contains a folder"
2019-08-12 23:55:33 +02:00
2019-08-13 21:35:51 +02:00
# Register (book) web path
ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
2019-08-12 23:55:33 +02:00
#=================================================
# STORE SETTINGS FROM MANIFEST
#=================================================
2020-10-25 16:31:23 +01:00
ynh_script_progression --message="Storing installation settings..."
2019-08-12 23:55:33 +02:00
2019-08-13 21:35:51 +02:00
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=is_public --value=$is_public
ynh_app_setting_set --app=$app --key=final_path --value=$final_path
2019-08-12 23:55:33 +02:00
2019-08-13 21:35:51 +02:00
#=================================================
# STANDARD MODIFICATIONS
#=================================================
2019-08-12 23:55:33 +02:00
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
2020-10-25 16:31:23 +01:00
ynh_script_progression --message="Setting up source files..."
2019-08-12 23:55:33 +02:00
2019-08-13 21:35:51 +02:00
### `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
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir="$final_path"
2019-08-12 23:55:33 +02:00
#=================================================
# NGINX CONFIGURATION
#=================================================
2020-10-25 16:31:23 +01:00
ynh_script_progression --message="Configuring nginx web server..."
2019-08-13 21:35:51 +02:00
### `ynh_add_nginx_config` will use the file conf/nginx.conf
2019-08-12 23:55:33 +02:00
# Create a dedicated nginx config
ynh_add_nginx_config
2019-08-13 21:35:51 +02:00
#=================================================
# CREATE DEDICATED USER
#=================================================
2020-10-25 16:31:23 +01:00
ynh_script_progression --message="Configuring system user..."
2019-08-13 21:35:51 +02:00
# Create a system user
ynh_system_user_create --username=$app
#=================================================
# PHP-FPM CONFIGURATION
#=================================================
2020-10-25 16:31:23 +01:00
ynh_script_progression "Configuring php-fpm..."
2019-08-13 21:35:51 +02:00
### `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
#=================================================
# GENERIC FINALIZATION
#=================================================
# 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
2020-10-31 22:01:13 +01:00
chown -R root: $final_path
find $final_path -type f | xargs chmod 644
find $final_path -type d | xargs chmod 755
# For temp subdir, the user must have write permissions
mkdir -p $final_path/temp
chown -R $app:root $final_path/temp
chmod 711 $final_path/temp
2019-08-13 21:35:51 +02:00
2019-08-12 23:55:33 +02:00
#=================================================
# SETUP SSOWAT
#=================================================
2020-10-25 16:31:23 +01:00
ynh_script_progression --message="Configuring SSOwat..."
2019-08-12 23:55:33 +02:00
2019-08-13 21:35:51 +02:00
# Make app public if necessary
2019-08-12 23:55:33 +02:00
if [ $is_public -eq 1 ]
then
2020-10-25 16:31:52 +01:00
ynh_permission_update --permission "main" --add visitors
2019-08-12 23:55:33 +02:00
fi
#=================================================
# RELOAD NGINX
#=================================================
2020-10-25 16:31:23 +01:00
ynh_script_progression --message="Reloading nginx web server..."
2019-08-13 21:35:51 +02:00
ynh_systemd_action --service_name=nginx --action=reload
2019-08-12 23:55:33 +02:00
2019-08-13 21:35:51 +02:00
#=================================================
# END OF SCRIPT
#=================================================
2019-08-12 23:55:33 +02:00
2020-10-25 16:31:23 +01:00
ynh_script_progression --message="Installation of $app completed" --last