2020-11-09 13:27:06 +01:00
|
|
|
#!/bin/bash
|
2017-03-03 21:26:30 +01:00
|
|
|
|
2020-11-09 13:27:06 +01:00
|
|
|
#=================================================
|
|
|
|
|
# GENERIC START
|
|
|
|
|
#=================================================
|
|
|
|
|
# IMPORT GENERIC HELPERS
|
|
|
|
|
#=================================================
|
2017-03-03 21:26:30 +01:00
|
|
|
|
2020-11-09 13:27:06 +01:00
|
|
|
source _common.sh
|
|
|
|
|
source /usr/share/yunohost/helpers
|
2017-03-03 21:26:30 +01:00
|
|
|
|
2020-11-09 13:27:06 +01:00
|
|
|
#=================================================
|
|
|
|
|
# MANAGE SCRIPT FAILURE
|
|
|
|
|
#=================================================
|
2017-03-03 21:26:30 +01:00
|
|
|
|
2020-11-09 13:27:06 +01:00
|
|
|
ynh_clean_setup () {
|
|
|
|
|
### Remove this function if there's nothing to clean before calling the remove script.
|
|
|
|
|
true
|
2017-03-03 21:26:30 +01:00
|
|
|
}
|
2020-11-09 13:27:06 +01:00
|
|
|
# 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="/"
|
|
|
|
|
admin=$YNH_APP_ARG_ADMIN
|
2020-11-09 13:39:10 +01:00
|
|
|
|
2020-11-09 13:27:06 +01: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, ...
|
|
|
|
|
app=$YNH_APP_INSTANCE_NAME
|
2020-11-09 13:39:10 +01:00
|
|
|
datadir="/home/yunohost.app/${app}"
|
2020-11-09 13:27:06 +01:00
|
|
|
#=================================================
|
|
|
|
|
# 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..."
|
|
|
|
|
|
|
|
|
|
### 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..."
|
|
|
|
|
|
|
|
|
|
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=datadir --value=$datadir
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# STANDARD MODIFICATIONS
|
|
|
|
|
#=================================================
|
|
|
|
|
# FIND AND OPEN A PORT
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Configuring firewall..."
|
|
|
|
|
|
|
|
|
|
### 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 an available port
|
|
|
|
|
port=$(ynh_find_port --port=43110)
|
|
|
|
|
fs_port=$(ynh_find_port --port=15441)
|
|
|
|
|
ynh_app_setting_set --app=$app --key=port --value=$port
|
|
|
|
|
ynh_app_setting_set --app=$app --key=fs_port --value=$fs_port
|
|
|
|
|
|
|
|
|
|
# Optional: Expose this port publicly
|
|
|
|
|
# (N.B. : you only need to do this if the app actually needs to expose the port publicly.
|
|
|
|
|
# If you do this and the app doesn't actually need you are CREATING SECURITY HOLES IN THE SERVER !)
|
|
|
|
|
|
|
|
|
|
# Open the port
|
|
|
|
|
ynh_exec_warn_less yunohost firewall allow --no-upnp TCP $fs_port
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# INSTALL DEPENDENCIES
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Installing 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
|
|
|
|
|
### - 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
|
|
|
|
|
|
2020-11-09 17:30:01 +01:00
|
|
|
pip3 install msgpack-python gevent
|
2020-11-09 13:27:06 +01:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# DOWNLOAD, CHECK AND UNPACK SOURCE
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="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=$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..."
|
|
|
|
|
|
|
|
|
|
### `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..."
|
|
|
|
|
|
|
|
|
|
# Create a system user
|
2020-11-12 16:41:29 +01:00
|
|
|
ynh_system_user_create --username=$app --home_dir=$datadir -s
|
2020-11-09 13:27:06 +01:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# SETUP SYSTEMD
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Configuring a systemd service..."
|
|
|
|
|
### `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
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# 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
|
|
|
|
|
mkdir -p $datadir/data
|
|
|
|
|
mkdir -p $datadir/log
|
|
|
|
|
chown -R $app: $final_path
|
|
|
|
|
chown -R $app: $datadir
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# INTEGRATE SERVICE IN YUNOHOST
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Integrating service in YunoHost..."
|
|
|
|
|
|
|
|
|
|
### `yunohost service add` integrates a service in YunoHost. It then gets
|
|
|
|
|
### displayed in the admin interface and through the others `yunohost service` commands.
|
|
|
|
|
### (N.B. : this line only makes sense if the app adds a service to the system!)
|
|
|
|
|
### If you're not using these lines:
|
|
|
|
|
### - You can remove these files in conf/.
|
|
|
|
|
### - Remove the section "REMOVE SERVICE INTEGRATION IN YUNOHOST" in the remove script
|
|
|
|
|
### - As well as the section "INTEGRATE SERVICE IN YUNOHOST" in the restore script
|
|
|
|
|
### - And the section "INTEGRATE SERVICE IN YUNOHOST" in the upgrade script
|
2020-11-09 14:13:53 +01:00
|
|
|
ynh_add_systemd_config --service="$app" --template="systemd.service" --others_var="fs_port port domain datadir"
|
2020-11-09 13:27:06 +01:00
|
|
|
|
2020-11-09 13:53:45 +01:00
|
|
|
yunohost service add $app --description "$app service" --log "$datadir/log/debug-last.log" --needs_exposed_ports "$fs_port"
|
2020-11-09 13:27:06 +01:00
|
|
|
|
|
|
|
|
### Additional options starting with 3.8:
|
|
|
|
|
###
|
|
|
|
|
### --needs_exposed_ports "$port" a list of ports that needs to be publicly exposed
|
|
|
|
|
### which will then be checked by YunoHost's diagnosis system
|
|
|
|
|
### (N.B. DO NOT USE THIS is the port is only internal !!!)
|
|
|
|
|
###
|
|
|
|
|
### --test_status "some command" a custom command to check the status of the service
|
|
|
|
|
### (only relevant if 'systemctl status' doesn't do a good job)
|
|
|
|
|
###
|
|
|
|
|
### --test_conf "some command" some command similar to "nginx -t" that validates the conf of the service
|
|
|
|
|
###
|
|
|
|
|
### Re-calling 'yunohost service add' during the upgrade script is the right way
|
|
|
|
|
### to proceed if you later realize that you need to enable some flags that
|
|
|
|
|
### weren't enabled on old installs (be careful it'll override the existing
|
|
|
|
|
### service though so you should re-provide all relevant flags when doing so)
|
|
|
|
|
###
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# START SYSTEMD SERVICE
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Starting a systemd service..."
|
|
|
|
|
### `ynh_systemd_action` is used to start a systemd service for an app.
|
|
|
|
|
### Only needed if you have configure a systemd service
|
|
|
|
|
### If you're not using these lines:
|
|
|
|
|
### - Remove the section "STOP SYSTEMD SERVICE" and "START SYSTEMD SERVICE" in the backup script
|
|
|
|
|
### - As well as the section "START SYSTEMD SERVICE" in the restore script
|
|
|
|
|
### - As well as the section"STOP SYSTEMD SERVICE" and "START SYSTEMD SERVICE" in the upgrade script
|
|
|
|
|
### - And the section "STOP SYSTEMD SERVICE" and "START SYSTEMD SERVICE" in the change_url script
|
|
|
|
|
|
|
|
|
|
# Start a systemd service
|
|
|
|
|
ynh_systemd_action --service_name=$app --action="start" --log_path="$datadir/log/debug-last.log"
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# SETUP SSOWAT
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Configuring SSOwat..."
|
|
|
|
|
|
|
|
|
|
# Restrict access to admin only
|
2020-11-09 15:46:29 +01:00
|
|
|
#yunohost app addaccess --users=$admin $app
|
2020-11-09 15:53:13 +01:00
|
|
|
ynh_app_setting_set --app=$app --key=unprotected_uris --value="/"
|
2020-11-09 13:27:06 +01:00
|
|
|
#=================================================
|
|
|
|
|
# RELOAD NGINX
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Reloading nginx web server..."
|
|
|
|
|
ynh_systemd_action --service_name=nginx --action=reload
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# END OF SCRIPT
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
ynh_script_progression --message="Installation of $app completed"
|
