2019-12-15 16:09:28 +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
|
|
|
|
|
is_public=$YNH_APP_ARG_IS_PUBLIC
|
2020-04-18 14:53:52 +02:00
|
|
|
admin=$YNH_APP_ARG_ADMIN
|
|
|
|
|
password=$YNH_APP_ARG_PASSWORD
|
2019-12-15 16:09:28 +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
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# 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
|
|
|
|
|
|
2020-03-20 21:16:20 +01:00
|
|
|
# Testing if ZeroTier is installed
|
2020-04-18 12:42:51 +02:00
|
|
|
yunohost app list | grep "id: zerotier" || ynh_die "ZeroTier is needed, but it is not installed. There is a package for that!"
|
2020-03-20 21:16:20 +01:00
|
|
|
|
2019-12-15 16:09:28 +01:00
|
|
|
### 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"
|
2020-04-16 16:08:39 +02:00
|
|
|
final_path=/opt/yunohost/$app
|
2019-12-15 16:09:28 +01:00
|
|
|
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=final_path --value=$final_path
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# STANDARD MODIFICATIONS
|
|
|
|
|
#=================================================
|
|
|
|
|
# FIND AND OPEN A PORT
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Configuring firewall..." --time --weight=1
|
|
|
|
|
|
|
|
|
|
### 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=8095)
|
|
|
|
|
ynh_app_setting_set --app=$app --key=port --value=$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 $port
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# INSTALL DEPENDENCIES
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Installing dependencies..." --time --weight=1
|
|
|
|
|
|
|
|
|
|
### `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-04-16 16:08:39 +02:00
|
|
|
ynh_install_app_dependencies $pkg_dependencies
|
|
|
|
|
|
2019-12-15 16:09:28 +01:00
|
|
|
ynh_install_nodejs --nodejs_version=$nodejs_version
|
|
|
|
|
ynh_use_nodejs
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# 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
|
2020-04-17 20:16:53 +02:00
|
|
|
ynh_system_user_create $app $final_path
|
2019-12-15 16:09:28 +01:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# SPECIFIC SETUP
|
|
|
|
|
#=================================================
|
|
|
|
|
# NPM INSTALL
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Performing Node app installation..." --time --weight=1
|
|
|
|
|
|
2020-04-17 20:16:53 +02:00
|
|
|
chown -R $app: $final_path
|
|
|
|
|
|
2019-12-15 16:09:28 +01:00
|
|
|
pushd $final_path/src
|
2020-04-18 10:30:09 +02:00
|
|
|
exec_as $app $nodejs_path/npm --loglevel=error install node-gyp
|
|
|
|
|
exec_as $app $nodejs_path/npm --loglevel=error install
|
2020-04-18 15:33:31 +02:00
|
|
|
exec_as $app $nodejs_path/npm --loglevel=error install argon2-cli
|
2020-04-18 10:30:09 +02:00
|
|
|
exec_as $app $nodejs_path/npm --loglevel=error audit fix
|
2019-12-15 16:09:28 +01:00
|
|
|
popd
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# MODIFY A CONFIG FILE
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
# Setup env file
|
|
|
|
|
mkdir -p $final_path
|
|
|
|
|
env_file=$final_path/src/.env
|
|
|
|
|
touch $env_file
|
2020-03-20 22:51:45 +01:00
|
|
|
chmod 600 $env_file
|
2019-12-15 16:09:28 +01:00
|
|
|
|
|
|
|
|
echo "ZT_TOKEN=$(</var/lib/zerotier-one/authtoken.secret)" >> $env_file
|
2020-03-21 00:11:35 +01:00
|
|
|
echo "ZT_ADDR=localhost:$(</var/lib/zerotier-one/zerotier-one.port)" >> $env_file
|
2019-12-15 16:09:28 +01:00
|
|
|
echo "HTTP_PORT=$port" >> $env_file
|
|
|
|
|
|
2020-04-18 14:53:52 +02:00
|
|
|
# Setup user credentials file
|
2020-04-18 15:33:31 +02:00
|
|
|
hashedpassword=$(echo -n "$password" | $final_path/src/node_modules/.bin/argon2-cli -e)
|
2020-04-18 14:53:52 +02:00
|
|
|
echo "{\"$admin\":{\"name\":\"$admin\",\"pass_set\":true,\"hash\":\"$hashedpassword\"}}" >> "$final_path/src/etc/passwd"
|
|
|
|
|
|
|
|
|
|
# Store user settings
|
|
|
|
|
ynh_app_setting_set --app=$app --key=admin --value=$admin
|
|
|
|
|
ynh_app_setting_set --app=$app --key=hashedpassword --value=$hashedpassword
|
2019-12-15 16:09:28 +01:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# LINK CERTIFICATES
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
# Even though one can stay in HTTP mode, the ztncui requires SSL certificates
|
|
|
|
|
# let's use the ones of the domain
|
|
|
|
|
pushd $final_path/src/etc/tls
|
2020-03-20 22:51:45 +01:00
|
|
|
cp /etc/yunohost/certs/$domain/key.pem privkey.pem
|
|
|
|
|
cp /etc/yunohost/certs/$domain/crt.pem fullchain.pem
|
2019-12-15 16:09:28 +01:00
|
|
|
popd
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# SETUP SYSTEMD
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Configuring a systemd service..." --time --weight=1
|
|
|
|
|
|
|
|
|
|
### `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
|
|
|
|
|
|
2020-04-18 12:42:51 +02:00
|
|
|
# Set the systemd service settings
|
|
|
|
|
ynh_replace_string "__PATH__" "$PATH" "../conf/systemd.service"
|
|
|
|
|
ynh_replace_string "__NODEJS_PATH__" "$nodejs_path" "../conf/systemd.service"
|
|
|
|
|
ynh_replace_string "__FINAL_PATH__" "$final_path" "../conf/systemd.service"
|
|
|
|
|
|
2019-12-15 16:09:28 +01:00
|
|
|
# Create a dedicated systemd config
|
|
|
|
|
ynh_add_systemd_config
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# 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
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# 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
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# INTEGRATE 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 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 --description "ZeroTier network controller user interface" --log "/var/log/$app/$app.log"
|
|
|
|
|
|
|
|
|
|
### With YunoHost 3.8 you will then be able to:
|
|
|
|
|
### - specify a list of ports that needs to be publicly exposed (c.f. --needs_exposed_ports)
|
|
|
|
|
### which will then be checked by YunoHost's diagnosis system
|
|
|
|
|
### - specify a custom command to check the status of the service (c.f. --test_status)
|
|
|
|
|
### though it's only needed for weird cases where 'systemctl status' doesn't do a good job
|
|
|
|
|
### - specify a custom command to check / validate the configuration of the service (c.f. --test_conf)
|
|
|
|
|
### for example, the command to check the configuration of nginx is "nginx -t"
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# START SYSTEMD SERVICE
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Starting the systemd service..." --time --weight=1
|
|
|
|
|
|
|
|
|
|
### `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="/var/log/$app/$app.log"
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# SETUP SSOWAT
|
|
|
|
|
#=================================================
|
2020-04-18 13:26:22 +02:00
|
|
|
ynh_script_progression --message="Configuring SSOwat..."
|
2019-12-15 16:09:28 +01:00
|
|
|
|
|
|
|
|
# Make app public if necessary
|
|
|
|
|
if [ $is_public -eq 1 ]
|
|
|
|
|
then
|
2020-04-18 13:26:22 +02:00
|
|
|
ynh_permission_update --permission "main" --add visitors
|
2019-12-15 16:09:28 +01:00
|
|
|
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
|
