2019-02-16 15:00:20 +01: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
|
|
|
|
|
password=$YNH_APP_ARG_PASSWORD
|
|
|
|
|
|
|
|
|
|
### 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
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
final_path=/opt/yunohost/$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)
|
|
|
|
|
|
|
|
|
|
# Does not work in subpath
|
|
|
|
|
if [ "$path_url" != "/" ]
|
|
|
|
|
then
|
|
|
|
|
ynh_die "Cannot be installed in subpath"
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
# 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 admin $admin
|
|
|
|
|
ynh_app_setting_set $app is_public $is_public
|
2019-02-17 19:02:16 +01:00
|
|
|
ynh_app_setting_set $app password $password
|
2019-02-16 15:00:20 +01:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# STANDARD MODIFICATIONS
|
|
|
|
|
#=================================================
|
|
|
|
|
# FIND AND OPEN A PORT
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### Use these lines if you have to open a port for the application
|
|
|
|
|
### `ynh_find_port` will find the first available port starting from the given port.
|
|
|
|
|
### If you're not using these lines:
|
|
|
|
|
### - Remove the section "CLOSE A PORT" in the remove script
|
|
|
|
|
|
|
|
|
|
# Find a free port
|
|
|
|
|
port=$(ynh_find_port 8080)
|
|
|
|
|
# Open this port
|
|
|
|
|
# yunohost firewall allow --no-upnp TCP $port 2>&1
|
|
|
|
|
ynh_app_setting_set $app port $port
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# CREATE 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_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" $architecture
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# NGINX CONFIGURATION
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### `ynh_add_nginx_config` will use the file conf/nginx.conf
|
|
|
|
|
|
|
|
|
|
# Create a dedicated nginx config
|
|
|
|
|
if [ "$path_url" != "/" ]
|
|
|
|
|
then
|
|
|
|
|
ynh_replace_string "^#sub_path_only" "" "../conf/nginx.conf"
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
ynh_add_nginx_config
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# CREATE DEDICATED USER
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
# Create a system user
|
|
|
|
|
ynh_system_user_create $app
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# SETUP SYSTEMD
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### `ynh_systemd_config` is used to configure a systemd script for an app.
|
|
|
|
|
### It can be used for apps that use sysvinit (with adaptation) or systemd.
|
|
|
|
|
### Have a look at the app to be sure this app needs a systemd script.
|
|
|
|
|
### `ynh_systemd_config` will use the file conf/systemd.service
|
|
|
|
|
### If you're not using these lines:
|
|
|
|
|
### - You can remove those files in conf/.
|
|
|
|
|
### - Remove the section "BACKUP SYSTEMD" in the backup script
|
|
|
|
|
### - Remove also the section "STOP AND REMOVE SERVICE" in the remove script
|
|
|
|
|
### - As well as the section "RESTORE SYSTEMD" in the restore script
|
|
|
|
|
### - And the section "SETUP SYSTEMD" in the upgrade script
|
|
|
|
|
|
|
|
|
|
# Create a dedicated systemd config
|
|
|
|
|
ynh_add_systemd_config
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# MODIFY A CONFIG FILE
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### `ynh_replace_string` is used to replace a string in a file.
|
|
|
|
|
### (It's compatible with sed regular expressions syntax)
|
|
|
|
|
cp ../conf/config.yml "$final_path/config.yml"
|
|
|
|
|
ynh_replace_string "__PORT__" $port "$final_path/config.yml"
|
|
|
|
|
ynh_replace_string "__DBNAME__" $db_name "$final_path/config.yml"
|
|
|
|
|
ynh_replace_string "__DBPASS__" $db_pwd "$final_path/config.yml"
|
|
|
|
|
ynh_replace_string "__ADMINUSER__" $admin "$final_path/config.yml"
|
|
|
|
|
ynh_replace_string "__ADMINPASS__" $password "$final_path/config.yml"
|
|
|
|
|
ynh_replace_string "__DOMAIN__" $domain "$final_path/config.yml"
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# 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.yml"
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# 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
|
|
|
|
|
mkdir $final_path/data
|
|
|
|
|
chown $app $final_path/data
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# SETUP LOGROTATE
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### `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
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# ADVERTISE SERVICE IN ADMIN PANEL
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### `yunohost service add` is a CLI yunohost command to add a service in the admin panel.
|
|
|
|
|
### You'll find the service in the 'services' section of YunoHost admin panel.
|
|
|
|
|
### This CLI command would be useless if the app does not have any services (systemd or sysvinit)
|
|
|
|
|
### If you're not using these lines:
|
|
|
|
|
### - You can remove these files in conf/.
|
|
|
|
|
### - Remove the section "REMOVE SERVICE FROM ADMIN PANEL" in the remove script
|
|
|
|
|
### - As well as the section ADVERTISE SERVICE IN ADMIN PANEL" in the restore script
|
|
|
|
|
|
|
|
|
|
yunohost service add $app
|
|
|
|
|
#--log "/var/log/FILE.log"
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# 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
|
|
|
|
|
|
|
|
|
|
# websocket must be open
|
|
|
|
|
# ynh_app_setting_set $app unprotected_uris "/stream"
|
|
|
|
|
|
|
|
|
|
ynh_app_setting_set $app unprotected_uris "/"
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# RELOAD NGINX
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
systemctl reload nginx
|
|
|
|
|
|
|
|
|
|
systemctl start $app
|
|
|
|
|
# yunohost firewall allow --no-upnp TCP $port 2>&1
|
