mirror of
https://github.com/YunoHost-Apps/halcyon_ynh.git
synced 2024-09-03 20:36:21 +02:00
189 lines
7.1 KiB
Text
189 lines
7.1 KiB
Text
|
#!/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="/"
|
||
|
|
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
|
||
|
|
#=================================================
|
||
|
|
|
||
|
|
### 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)
|
||
|
|
|
||
|
|
# Check web path availability
|
||
|
|
ynh_webpath_available $domain $path_url
|
||
|
|
# Register (book) web path
|
||
|
|
ynh_webpath_register $app $domain $path_url
|
||
|
|
|
||
|
|
#=================================================
|
||
|
|
# 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 language $language
|
||
|
|
|
||
|
|
#=================================================
|
||
|
|
# STANDARD MODIFICATIONS
|
||
|
|
#=================================================
|
||
|
|
|
||
|
|
|
||
|
|
#=================================================
|
||
|
|
# INSTALL 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
|
||
|
|
### - As well as the section "REINSTALL DEPENDENCIES" in the restore script
|
||
|
|
### - And the section "UPGRADE DEPENDENCIES" in the upgrade script
|
||
|
|
|
||
|
|
ynh_install_app_dependencies php-intl php-mbstring php-curl
|
||
|
|
|
||
|
|
#=================================================
|
||
|
|
# DOWNLOAD, CHECK AND UNPACK SOURCE
|
||
|
|
#=================================================
|
||
|
|
|
||
|
|
### `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"
|
||
|
|
|
||
|
|
#=================================================
|
||
|
|
# NGINX CONFIGURATION
|
||
|
|
#=================================================
|
||
|
|
|
||
|
|
### `ynh_add_nginx_config` will use the file conf/nginx.conf
|
||
|
|
|
||
|
|
# Create a dedicated nginx config
|
||
|
|
ynh_add_nginx_config
|
||
|
|
|
||
|
|
#=================================================
|
||
|
|
# CREATE DEDICATED USER
|
||
|
|
#=================================================
|
||
|
|
|
||
|
|
# Create a system user
|
||
|
|
ynh_system_user_create $app
|
||
|
|
|
||
|
|
#=================================================
|
||
|
|
# PHP-FPM CONFIGURATION
|
||
|
|
#=================================================
|
||
|
|
|
||
|
|
### `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
|
||
|
|
#=================================================
|
||
|
|
# MODIFY A CONFIG FILE
|
||
|
|
#=================================================
|
||
|
|
|
||
|
|
### `ynh_replace_string` is used to replace a string in a file.
|
||
|
|
### (It's compatible with sed regular expressions syntax)
|
||
|
|
udo cp $final_path/config/config.ini.sample $final_path/config/config.ini
|
||
|
|
ynh_replace_string "Your application name" "Yunohost Halcyon" "$final_path/config/config.ini"
|
||
|
|
ynh_replace_string "example.com" "$domain" "$final_path/config/config.ini"
|
||
|
|
ynh_replace_string "en_US" "$language" "$final_path/config/config.ini"
|
||
|
|
|
||
|
|
#=================================================
|
||
|
|
# 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/config/config.ini"
|
||
|
|
|
||
|
|
#=================================================
|
||
|
|
# 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 $app: $final_path
|
||
|
|
chmod -R 777 $final_path/data
|
||
|
|
|
||
|
|
#=================================================
|
||
|
|
# SETUP 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
|
||
|
|
#=================================================
|
||
|
|
|
||
|
|
systemctl reload nginx
|