mirror of
https://github.com/YunoHost-Apps/rainloop_ynh.git
synced 2024-09-03 20:16:18 +02:00
251 lines
9.6 KiB
Bash
251 lines
9.6 KiB
Bash
#!/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
|
|
#=================================================
|
|
ynh_print_info "Retrieve arguments from the manifest ..."
|
|
|
|
domain=$YNH_APP_ARG_DOMAIN
|
|
path_url=$YNH_APP_ARG_PATH
|
|
is_public=$YNH_APP_ARG_IS_PUBLIC
|
|
lang=$YNH_APP_ARG_LANG
|
|
password=$YNH_APP_ARG_PASSWORD
|
|
ldap=$YNH_APP_ARG_LDAP
|
|
|
|
### 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
|
|
#=================================================
|
|
ynh_print_info "Validating arguments ..."
|
|
|
|
### 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
|
|
|
|
#=================================================
|
|
# STORE SETTINGS FROM MANIFEST
|
|
#=================================================
|
|
ynh_print_info "Store settings from manifest ..."
|
|
|
|
ynh_app_setting_set $app domain $domain
|
|
ynh_app_setting_set $app path $path_url
|
|
ynh_app_setting_set $app is_public $is_public
|
|
ynh_app_setting_set $app lang $lang
|
|
ynh_app_setting_set $app password $password #9999 Check if it's need to save password
|
|
ynh_app_setting_set $app ldap $ldap
|
|
|
|
#=================================================
|
|
# STANDARD MODIFICATIONS
|
|
#=================================================
|
|
# CREATE A MYSQL DATABASE
|
|
#=================================================
|
|
ynh_print_info "Creating a mysql database ..."
|
|
|
|
### 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 $app)
|
|
ynh_app_setting_set $app db_name $db_name
|
|
ynh_mysql_setup_db $db_name $db_name
|
|
|
|
#=================================================
|
|
# DOWNLOAD, CHECK AND UNPACK SOURCE
|
|
#=================================================
|
|
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/app"
|
|
|
|
#=================================================
|
|
# NGINX CONFIGURATION
|
|
#=================================================
|
|
ynh_print_info "Configuring nginx ..."
|
|
|
|
### `ynh_add_nginx_config` will use the file conf/nginx.conf
|
|
|
|
# Create a dedicated nginx config
|
|
ynh_add_nginx_config
|
|
|
|
#=================================================
|
|
# CREATE DEDICATED USER
|
|
#=================================================
|
|
ynh_print_info "Configuring system user ..."
|
|
|
|
# Create a system user
|
|
ynh_system_user_create $app
|
|
|
|
#=================================================
|
|
# 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
|
|
#=================================================
|
|
# AUTOCONFIG
|
|
#=================================================
|
|
|
|
|
|
|
|
# Set plugins
|
|
plugins="ynh-login-mapping,auto-domain-grab" # This plugin is trying to automatically grab unknown domains if users want to add external email accounts
|
|
if [ $ldap -eq 1 ]
|
|
then
|
|
plugins="$plugins,ynh-ldap-suggestions" # This plugin is to suggest YunoHost users in recipients list
|
|
fi
|
|
ynh_app_setting_set "$app" plugins "$plugins"
|
|
|
|
|
|
mkdir -p "$final_path/app/data/_data_/_default_/configs/"
|
|
application_file="$final_path/app/data/_data_/_default_/configs/application.ini"
|
|
|
|
sudo cp ../conf/data/configs/application.ini "$application_file"
|
|
ynh_replace_string "domain.tld" "$domain" "$application_file"
|
|
ynh_replace_string "MYSQLUSER" "$db_name" "$application_file"
|
|
ynh_replace_string "MYSQLPASSWORD" "$db_pwd" "$application_file"
|
|
ynh_replace_string "LANGTOCHANGE" "$lang" "$application_file"
|
|
ynh_replace_string "PLUGINSTOENABLE" "$plugins" "$application_file"
|
|
|
|
|
|
# Set admin password
|
|
php ../conf/config.php --index="$final_path/app/index.php" --password="$password"
|
|
|
|
|
|
# Add default domain configs by looping through all the domains already added
|
|
mkdir -p "$final_path/app/data/_data_/_default_/domains/"
|
|
# get list of ldap domains
|
|
alldomains=`ldapsearch -LLL -x -b ou=domains,dc=yunohost,dc=org -s one "objectclass=top" virtualdomain | grep -v "dn:" | sed "s/virtualdomain://" `
|
|
for ldomain in $alldomains ; do
|
|
cp ../conf/data/domains/domain.tld.ini "$final_path/app/data/_data_/_default_/domains/$ldomain.ini"
|
|
done
|
|
# Add wildcard domain for auto-grab
|
|
cp ../conf/data/domains/default.ini "$final_path/app/data/_data_/_default_/domains/default.ini"
|
|
|
|
|
|
# install SSO - at the moment the index is the SSO and rainloop is installed in /app
|
|
cp ../sources/sso/sso.php "$final_path/index.php"
|
|
ynh_replace_string "domain.tld" "$domain" "$final_path/index.php"
|
|
ynh_replace_string "ALIASTOCHANGE" "$final_path" "$final_path/index.php"
|
|
if [ $path_url = "/" ]; then
|
|
ynh_replace_string "ROOTTOCHANGE" "" "$final_path/index.php"
|
|
else
|
|
ynh_replace_string "ROOTTOCHANGE" "$path_url" "$final_path/index.php"
|
|
fi
|
|
|
|
|
|
# Install PGPback by chtixof to allow users to backup/restore their PGP private keys on the server
|
|
cp -rf ../sources/pgpback "$final_path/"
|
|
|
|
#=================================================
|
|
# 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 "$application_file"
|
|
|
|
#=================================================
|
|
# 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
|
|
find $final_path/. -type d -exec chmod 755 {} \;
|
|
find $final_path/. -type f -exec chmod 644 {} \;
|
|
chown -R $app: $final_path
|
|
|
|
#=================================================
|
|
# SETUP SSOWAT
|
|
#=================================================
|
|
ynh_print_info "Configuring SSOwat ..."
|
|
|
|
# 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 unprotected_uris "/"
|
|
fi
|
|
|
|
#=================================================
|
|
# RELOAD NGINX
|
|
#=================================================
|
|
ynh_print_info "Reloading nginx ..."
|
|
|
|
systemctl reload nginx
|
|
|
|
#=================================================
|
|
# END OF SCRIPT
|
|
#=================================================
|
|
|
|
ynh_print_info "Installation completed"
|