2014-05-08 19:46:08 +02:00
|
|
|
#!/bin/bash
|
|
|
|
|
2018-06-27 17:21:59 +02:00
|
|
|
#=================================================
|
|
|
|
# GENERIC START
|
|
|
|
#=================================================
|
|
|
|
# IMPORT GENERIC HELPERS
|
|
|
|
#=================================================
|
2014-05-08 19:46:08 +02:00
|
|
|
|
2018-06-27 17:21:59 +02:00
|
|
|
source _common.sh
|
|
|
|
source /usr/share/yunohost/helpers
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
# MANAGE SCRIPT FAILURE
|
|
|
|
#=================================================
|
|
|
|
|
2020-04-26 00:47:07 +02:00
|
|
|
ynh_clean_setup () {
|
|
|
|
### Remove this function if there's nothing to clean before calling the remove script.
|
|
|
|
true
|
|
|
|
}
|
2018-06-27 17:21:59 +02:00
|
|
|
# Exit if an error occurs during the execution of the script
|
|
|
|
ynh_abort_if_errors
|
2017-06-25 00:56:50 +02:00
|
|
|
|
2018-06-27 17:21:59 +02:00
|
|
|
#=================================================
|
|
|
|
# RETRIEVE ARGUMENTS FROM THE MANIFEST
|
|
|
|
#=================================================
|
2017-06-25 00:56:50 +02:00
|
|
|
domain=$YNH_APP_ARG_DOMAIN
|
|
|
|
path_url=$YNH_APP_ARG_PATH
|
|
|
|
is_public=$YNH_APP_ARG_IS_PUBLIC
|
2017-07-04 16:18:43 +02:00
|
|
|
root_access=$YNH_APP_ARG_ROOT_ACCESS
|
2017-06-25 00:56:50 +02:00
|
|
|
|
2020-04-26 00:47:07 +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, ...
|
2018-06-27 17:21:59 +02:00
|
|
|
app=$YNH_APP_INSTANCE_NAME
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
|
|
|
|
#=================================================
|
|
|
|
|
2020-04-26 00:47:07 +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"
|
2018-06-27 17:21:59 +02:00
|
|
|
final_path=/var/www/$app
|
2020-04-26 00:47:07 +02:00
|
|
|
test ! -e "$final_path" || ynh_die --message="This path already contains a folder"
|
2018-06-27 17:21:59 +02:00
|
|
|
|
|
|
|
# Register (book) web path
|
2020-04-26 00:47:07 +02:00
|
|
|
ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
# STORE SETTINGS FROM MANIFEST
|
|
|
|
#=================================================
|
|
|
|
ynh_script_progression --message="Storing installation settings..." --time --weight=1
|
2018-06-27 17:21:59 +02:00
|
|
|
|
2020-04-26 00:47:07 +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=root_access --value=$root_access
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
# INSTALL DEPENDENCIES
|
|
|
|
#=================================================
|
|
|
|
ynh_script_progression --message="Installing dependencies..." --time --weight=1
|
2017-06-25 00:56:50 +02:00
|
|
|
|
2020-04-26 00:47:07 +02:00
|
|
|
### `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
|
2014-05-08 19:46:08 +02:00
|
|
|
|
2020-04-26 00:47:07 +02:00
|
|
|
ynh_install_app_dependencies $pkg_dependencies
|
2014-07-22 16:08:09 +02:00
|
|
|
|
2020-04-26 00:47:07 +02:00
|
|
|
|
|
|
|
#=================================================
|
|
|
|
# DOWNLOAD, CHECK AND UNPACK SOURCE
|
|
|
|
#=================================================
|
|
|
|
ynh_script_progression --message="Setting up source files..." --time --weight=1
|
|
|
|
|
|
|
|
ynh_app_setting_set --app=$app --key=final_path --value=$final_path
|
|
|
|
# Download, check integrity, uncompress and patch the source from app.src
|
|
|
|
mkdir -p $final_path
|
2018-06-27 17:21:59 +02:00
|
|
|
|
2017-07-04 16:18:43 +02:00
|
|
|
if [[ $root_access -eq 1 ]]; then
|
2018-09-16 14:47:00 +02:00
|
|
|
#copy files from with_root_access folder to the final_path
|
2020-04-26 00:47:07 +02:00
|
|
|
cp -a ../sources/with_root_access/. $final_path
|
2017-07-04 16:18:43 +02:00
|
|
|
else
|
2018-09-16 14:47:00 +02:00
|
|
|
#copy files from root_access_disabled folder to the final_path
|
2020-04-26 00:47:07 +02:00
|
|
|
cp -a ../sources/root_access_disabled/. $final_path
|
2017-07-04 16:18:43 +02:00
|
|
|
fi
|
2014-07-22 16:08:09 +02:00
|
|
|
|
2020-04-26 00:54:52 +02:00
|
|
|
#=================================================
|
|
|
|
# CREATE DEDICATED USER
|
|
|
|
#=================================================
|
|
|
|
ynh_script_progression --message="Configuring system user..." --time --weight=1
|
2018-06-27 17:21:59 +02:00
|
|
|
|
2020-04-26 00:54:52 +02:00
|
|
|
# Create a system user
|
|
|
|
ynh_system_user_create --username=$app
|
2018-06-27 17:21:59 +02:00
|
|
|
|
|
|
|
|
2017-06-25 00:56:50 +02:00
|
|
|
# Set permissions to app files
|
2018-09-16 14:47:00 +02:00
|
|
|
# Make some file and/or directory writeable by app user (nginx user)
|
2020-04-26 00:47:07 +02:00
|
|
|
find $final_path -type f | xargs sudo chmod 644
|
|
|
|
find $final_path -type d | xargs sudo chmod 755
|
|
|
|
chown -R $app: $final_path
|
2018-06-27 17:21:59 +02:00
|
|
|
|
|
|
|
#=================================================
|
|
|
|
# NGINX CONFIGURATION
|
|
|
|
#=================================================
|
2020-04-26 00:47:07 +02:00
|
|
|
ynh_script_progression --message="Configuring nginx web server..." --time --weight=1
|
|
|
|
|
|
|
|
### `ynh_add_nginx_config` will use the file conf/nginx.conf
|
2018-06-27 17:21:59 +02:00
|
|
|
|
|
|
|
# Create a dedicated nginx config
|
|
|
|
ynh_add_nginx_config
|
2017-06-25 00:56:50 +02:00
|
|
|
|
2020-04-26 00:47:07 +02:00
|
|
|
|
2018-06-27 17:21:59 +02:00
|
|
|
#=================================================
|
|
|
|
# PHP-FPM CONFIGURATION
|
|
|
|
#=================================================
|
2020-04-26 00:47:07 +02:00
|
|
|
ynh_script_progression --message="Configuring php-fpm..." --time --weight=1
|
|
|
|
|
|
|
|
### `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
|
|
|
|
### 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
|
2017-06-25 00:56:50 +02:00
|
|
|
|
2018-06-27 17:21:59 +02:00
|
|
|
# Create a dedicated php-fpm config
|
|
|
|
ynh_add_fpm_config
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
# SETUP SSOWAT
|
|
|
|
#=================================================
|
2020-04-26 00:47:07 +02:00
|
|
|
ynh_script_progression --message="Configuring SSOwat..." --time --weight=1
|
|
|
|
|
2018-06-27 17:21:59 +02:00
|
|
|
|
|
|
|
# Make app public if necessary
|
|
|
|
if [ $is_public -eq 1 ]
|
|
|
|
then
|
|
|
|
# unprotected_uris allows SSO credentials to be passed anyway.
|
2020-04-26 00:47:07 +02:00
|
|
|
ynh_app_setting_set --app=$app --key=unprotected_uris --value="/"
|
2018-06-27 17:21:59 +02:00
|
|
|
fi
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
# RELOAD NGINX
|
|
|
|
#=================================================
|
2020-04-26 00:47:07 +02:00
|
|
|
ynh_script_progression --message="Reloading nginx web server..." --time --weight=1
|
2018-06-27 17:21:59 +02:00
|
|
|
|
2020-04-26 00:47:07 +02:00
|
|
|
ynh_systemd_action --service_name=nginx --action=reload
|
2014-05-08 19:46:08 +02:00
|
|
|
|