2020-05-02 10:17:12 +02:00
|
|
|
#!/bin/bash
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# GENERIC START
|
|
|
|
|
#=================================================
|
|
|
|
|
# IMPORT GENERIC HELPERS
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
source _common.sh
|
|
|
|
|
source /usr/share/yunohost/helpers
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# MANAGE SCRIPT FAILURE
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
ynh_clean_setup () {
|
|
|
|
|
### Remove this function if there's nothing to clean before calling the remove script.
|
|
|
|
|
true
|
|
|
|
|
}
|
|
|
|
|
# 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
|
|
|
|
|
admin=$YNH_APP_ARG_ADMIN
|
|
|
|
|
is_public=$YNH_APP_ARG_IS_PUBLIC
|
|
|
|
|
language=$YNH_APP_ARG_LANGUAGE
|
|
|
|
|
|
|
|
|
|
### 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
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
|
|
|
|
|
#=================================================
|
|
|
|
|
### 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.
|
|
|
|
|
ynh_script_progression --message="Validating installation parameters..." --time --weight=1
|
|
|
|
|
|
|
|
|
|
### 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"
|
|
|
|
|
|
|
|
|
|
# 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..." --time --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=admin --value=$admin
|
|
|
|
|
ynh_app_setting_set --app=$app --key=is_public --value=$is_public
|
|
|
|
|
ynh_app_setting_set --app=$app --key=language --value=$language
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# STANDARD MODIFICATIONS
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# CREATE A MYSQL DATABASE
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Creating a MySQL database..." --time --weight=1
|
|
|
|
|
|
|
|
|
|
### Use these lines if you need a database for the application.
|
|
|
|
|
### `ynh_mysql_setup_db` will create a database, an associated user and a ramdom password.
|
|
|
|
|
### The password will be stored as 'mysqlpwd' into the app settings,
|
|
|
|
|
### and will be available as $db_pwd
|
|
|
|
|
### If you're not using these lines:
|
|
|
|
|
### - Remove the section "BACKUP THE MYSQL DATABASE" in the backup script
|
|
|
|
|
### - Remove also the section "REMOVE THE MYSQL DATABASE" in the remove script
|
|
|
|
|
### - As well as the section "RESTORE THE MYSQL DATABASE" in the restore script
|
|
|
|
|
|
|
|
|
|
db_name=$(ynh_sanitize_dbid --db_name=$app)
|
|
|
|
|
db_user=$db_name
|
|
|
|
|
ynh_app_setting_set --app=$app --key=db_name --value=$db_name
|
|
|
|
|
ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# DOWNLOAD, CHECK AND UNPACK SOURCE
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Setting up source files..." --time --weight=1
|
|
|
|
|
|
|
|
|
|
### `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=$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"
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# NGINX CONFIGURATION
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Configuring nginx web server..." --time --weight=1
|
|
|
|
|
|
|
|
|
|
### `ynh_add_nginx_config` will use the file conf/nginx.conf
|
|
|
|
|
|
|
|
|
|
# Create a dedicated nginx config
|
|
|
|
|
ynh_add_nginx_config
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# CREATE DEDICATED USER
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Configuring system user..." --time --weight=1
|
|
|
|
|
|
|
|
|
|
# Create a system user
|
|
|
|
|
ynh_system_user_create --username=$app
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# PHP-FPM CONFIGURATION
|
|
|
|
|
#=================================================
|
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
# Create a dedicated php-fpm config
|
|
|
|
|
ynh_add_fpm_config
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# SPECIFIC SETUP
|
|
|
|
|
#=================================================
|
|
|
|
|
# ...
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# 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_script_progression --message="Configuring SSOwat..." --time --weight=1
|
|
|
|
|
ynh_app_setting_set --app=$app --key=skipped_uris --value="/"
|
|
|
|
|
# Reload SSOwat config
|
|
|
|
|
yunohost app ssowatconf
|
|
|
|
|
|
|
|
|
|
# Reload Nginx
|
|
|
|
|
ynh_systemd_action --service_name=nginx --action=reload
|
|
|
|
|
|
|
|
|
|
# Installation with curl
|
|
|
|
|
ynh_script_progression --message="Finalizing installation..." --time --weight=1
|
|
|
|
|
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=$app --key=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)
|
|
|
|
|
|
2020-05-03 12:04:12 +02:00
|
|
|
ynh_replace_string --match_string="__LANGUAGE__" --replace_string="$language" --target_file="$final_path/.env"
|
|
|
|
|
|
2020-05-02 17:16:41 +02:00
|
|
|
ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain" --target_file="$final_path/.env"
|
|
|
|
|
ynh_replace_string --match_string="__PATH__" --replace_string="$path_url" --target_file="$final_path/.env"
|
|
|
|
|
ynh_replace_string --match_string="__DB_NAME__" --replace_string="$db_name" --target_file="$final_path/.env"
|
|
|
|
|
ynh_replace_string --match_string="__DB_USER__" --replace_string="$db_user" --target_file="$final_path/.env"
|
|
|
|
|
ynh_replace_string --match_string="__DB_PASS__" --replace_string="$db_pwd" --target_file="$final_path/.env"
|
2020-05-02 10:17:12 +02:00
|
|
|
|
2020-05-03 12:04:24 +02:00
|
|
|
ynh_replace_string --match_string="__API_SECRET__" --replace_string="$(ynh_string_random --length=32)" --target_file="$final_path/.env"
|
2020-05-02 17:16:41 +02:00
|
|
|
ynh_replace_string --match_string="__APP_KEY__" --replace_string="$(ynh_string_random --length=32)" --target_file="$final_path/.env"
|
|
|
|
|
ynh_replace_string --match_string="__PHANTOMJS_KEY__" --replace_string="$(ynh_string_random --length=32)" --target_file="$final_path/.env"
|
2020-05-02 10:17:12 +02:00
|
|
|
|
2020-05-03 12:04:38 +02:00
|
|
|
ynh_replace_string --match_string="__MAIL_FROM_ADDRESS__" --replace_string="$(ynh_user_get_info $admin mail)" --target_file="$final_path/.env"
|
|
|
|
|
ynh_replace_string --match_string="__MAIL_FROM_NAME__" --replace_string="$(ynh_user_get_info $admin firstname) $(ynh_user_get_info $admin lastname)" --target_file="$final_path/.env"
|
2020-05-02 10:17:12 +02:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# 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
|
|
|
|
|
chown -R root: $final_path
|
|
|
|
|
|
2020-05-02 17:16:41 +02:00
|
|
|
chmod -R 755 $final_path/storage
|
2020-05-02 20:20:47 +02:00
|
|
|
chown -R $app: $final_path/storage $final_path/bootstrap $final_path/public/logo $final_path/.env
|
2020-05-02 17:16:41 +02:00
|
|
|
|
|
|
|
|
|
2020-05-02 10:17:12 +02:00
|
|
|
#=================================================
|
|
|
|
|
# SETUP LOGROTATE
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Configuring log rotation..." --time --weight=1
|
|
|
|
|
|
|
|
|
|
### `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
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# SETUP FAIL2BAN
|
|
|
|
|
#=================================================
|
2020-05-02 17:16:41 +02:00
|
|
|
#ynh_script_progression --message="Configuring fail2ban..." --time --weight=1
|
2020-05-02 10:17:12 +02:00
|
|
|
|
|
|
|
|
# Create a dedicated fail2ban config
|
2020-05-02 17:16:41 +02:00
|
|
|
#ynh_add_fail2ban_config --logpath="/var/log/nginx/${domain}-error.log" --failregex="Regex to match into the log for a failed login"
|
2020-05-02 10:17:12 +02:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# SETUP SSOWAT
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Configuring SSOwat..." --time --weight=1
|
|
|
|
|
|
|
|
|
|
# Make app public if necessary
|
|
|
|
|
if [ $is_public -eq 1 ]
|
|
|
|
|
then
|
|
|
|
|
# unprotected_uris allows SSO credentials to be passed anyway.
|
|
|
|
|
ynh_app_setting_set --app=$app --key=unprotected_uris --value="/"
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# RELOAD NGINX
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Reloading nginx web server..." --time --weight=1
|
|
|
|
|
|
|
|
|
|
ynh_systemd_action --service_name=nginx --action=reload
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# END OF SCRIPT
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
ynh_script_progression --message="Installation of $app completed" --time --last
|
