2020-03-01 11:28:28 +01:00
|
|
|
#!/bin/bash
|
|
|
|
|
|
2020-04-23 13:06:01 +02:00
|
|
|
# Lionwiki-t2t for YunoHost
|
2020-03-01 11:28:28 +01:00
|
|
|
#=================================================
|
|
|
|
|
# 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
|
|
|
|
|
language=$YNH_APP_ARG_LANGUAGE
|
|
|
|
|
password=$YNH_APP_ARG_PASSWORD
|
2020-03-27 11:32:49 +01:00
|
|
|
wiki=$YNH_APP_ARG_WIKI
|
2020-03-27 10:52:32 +01:00
|
|
|
color=$YNH_APP_ARG_COLOR
|
2020-03-01 11:28: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
|
|
|
|
|
|
|
|
|
|
### 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..." --time --weight=1
|
|
|
|
|
|
|
|
|
|
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=is_public --value=$is_public
|
|
|
|
|
ynh_app_setting_set --app=$app --key=language --value=$language
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# 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
|
|
|
|
|
#=================================================
|
2020-03-01 11:44:48 +01:00
|
|
|
#ynh_script_progression --message="Installing dependencies..." --time --weight=1
|
2020-03-01 11:28:28 +01:00
|
|
|
|
|
|
|
|
### `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-06 11:45:16 +02:00
|
|
|
ynh_install_app_dependencies $pkg_dependencies
|
2020-03-01 11:28:28 +01:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# CREATE A MYSQL DATABASE
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### No sql database for this application!
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# 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
|
|
|
|
|
ynh_system_user_create --username=$app
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# PHP-FPM CONFIGURATION
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Configuring php-fpm..." --time --weight=1
|
|
|
|
|
|
|
|
|
|
### `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
|
|
|
|
|
### 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
|
|
|
|
|
#=================================================
|
2020-03-01 13:21:59 +01:00
|
|
|
# customise Lionwiki-t2t
|
|
|
|
|
|
|
|
|
|
### Copy Yunohost specific configuration
|
|
|
|
|
# This File cannot be modified directly by wiki, only by hand or by Yunohost
|
|
|
|
|
# It will only be updated by Yunohost package or directly by adventurous users
|
|
|
|
|
cp ../conf/config.php $final_path/
|
|
|
|
|
|
2020-03-27 10:52:32 +01:00
|
|
|
cp ../conf/minimaxing.less $final_path/templates/minimaxing/
|
2020-04-06 11:45:16 +02:00
|
|
|
cp ../conf/minimaxing.css $final_path/templates/minimaxing/minimaxing_org.css
|
2020-04-06 01:13:43 +02:00
|
|
|
|
2020-05-14 20:56:58 +02:00
|
|
|
cp ../conf/pheditor.php $final_path/
|
|
|
|
|
|
2020-04-06 01:13:43 +02:00
|
|
|
# we already use the default html template
|
|
|
|
|
#cp ../conf/minimaxing.html $final_path/templates/
|
2020-03-27 10:52:32 +01:00
|
|
|
|
2020-03-01 13:21:59 +01:00
|
|
|
# Set the password
|
|
|
|
|
ynh_replace_string --match_string="__YNH_PASSWORD__" --replace_string="$password" --target_file="$final_path/config.php"
|
|
|
|
|
|
2020-04-23 13:06:01 +02:00
|
|
|
# Set the "admin" user (not used, admin password = user password, you can modify it later)
|
|
|
|
|
# ynh_replace_string --match_string="__YNH_ADMINPASSWORD__" --replace_string="$password" --target_file="$final_path/config.php"
|
2020-03-01 13:21:59 +01:00
|
|
|
|
2020-05-14 20:56:58 +02:00
|
|
|
# set user password in pheditor
|
|
|
|
|
|
|
|
|
|
pheditorhash=`python -c 'import hashlib; import sys; a=str(sys.argv[1]); print(hashlib.sha512(a.encode("UTF-8")).hexdigest())' $password`
|
|
|
|
|
|
|
|
|
|
ynh_replace_string --match_string="__YNH_PASSWORD__" --replace_string="$pheditorhash" --target_file="$final_path/pheditor.php"
|
|
|
|
|
|
|
|
|
|
|
2020-03-01 13:21:59 +01:00
|
|
|
ynh_replace_string --match_string="__YNH_LANG__" --replace_string="$language" --target_file="$final_path/config.php"
|
|
|
|
|
|
2020-03-27 11:26:22 +01:00
|
|
|
ynh_replace_string --match_string="__YNH_LABEL__" --replace_string="$wiki" --target_file="$final_path/config.php"
|
2020-03-27 10:52:32 +01:00
|
|
|
|
2020-04-06 01:28:35 +02:00
|
|
|
|
2020-05-14 20:56:58 +02:00
|
|
|
|
2020-04-06 09:49:53 +02:00
|
|
|
#ynh_replace_string --match_string="__YNH_COLOR__" --replace_string="$color" --target_file="$final_path/templates/minimaxing/minimaxing.less"
|
2020-04-06 01:28:35 +02:00
|
|
|
|
2020-04-06 01:13:43 +02:00
|
|
|
# test if the color was correctly set (6 hexadecimal values)
|
2020-04-23 13:06:01 +02:00
|
|
|
# if not, we'll use a default grey color (#555555)
|
2020-04-06 01:28:35 +02:00
|
|
|
|
2020-04-06 09:49:53 +02:00
|
|
|
if echo "$color" | grep -q -E '[A-Fa-f0-9]{6}'
|
|
|
|
|
then
|
|
|
|
|
ynh_replace_string --match_string="__YNH_COLOR__" --replace_string="$color" --target_file="$final_path/templates/minimaxing/minimaxing.less"
|
2020-05-14 20:56:58 +02:00
|
|
|
ynh_replace_string --match_string="__YNH_COLOR__" --replace_string="$color" --target_file="$final_path/templates/ggp/ggp.less"
|
2020-04-06 09:49:53 +02:00
|
|
|
else
|
|
|
|
|
ynh_replace_string --match_string="__YNH_COLOR__" --replace_string="555555" --target_file="$final_path/templates/minimaxing/minimaxing.less"
|
2020-05-14 20:56:58 +02:00
|
|
|
ynh_replace_string --match_string="__YNH_COLOR__" --replace_string="555555" --target_file="$final_path/templates/ggp/ggp.less"
|
2020-04-06 09:49:53 +02:00
|
|
|
fi
|
2020-04-06 01:13:43 +02:00
|
|
|
|
2020-04-06 09:34:30 +02:00
|
|
|
# soon lessc will require the --js option
|
2020-04-06 09:21:54 +02:00
|
|
|
# lessc --js $final_path/templates/minimaxing/minimaxing.less > $final_path/templates/minimaxing/minimaxing.css
|
2020-04-06 09:49:53 +02:00
|
|
|
|
2020-04-06 09:34:30 +02:00
|
|
|
lessc $final_path/templates/minimaxing/minimaxing.less > $final_path/templates/minimaxing/minimaxing.css
|
2020-04-06 01:13:43 +02:00
|
|
|
|
2020-05-14 20:56:58 +02:00
|
|
|
lessc $final_path/templates/ggp/ggp.less > $final_path/templates/ggp/ggp.css
|
|
|
|
|
|
2020-04-06 01:13:43 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
#ynh_replace_string --match_string="__YNH_COLOR__" --replace_string="$color" --target_file="$final_path/templates/minimaxing/minimaxing.css"
|
2020-03-27 10:52:32 +01:00
|
|
|
|
2020-03-01 13:21:59 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2020-03-01 11:28:28 +01:00
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# SETUP SYSTEMD
|
|
|
|
|
#=================================================
|
2020-03-27 10:52:32 +01:00
|
|
|
#ynh_script_progression --message="Configuring a systemd service..." --time --weight=1
|
2020-03-01 11:28:28 +01:00
|
|
|
|
|
|
|
|
### `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
|
2020-03-27 10:52:32 +01:00
|
|
|
#ynh_add_systemd_config
|
2020-03-01 11:28:28 +01:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# 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
|
|
|
|
|
chown -R $app: $final_path
|
|
|
|
|
|
|
|
|
|
# Set the app as temporarily public for curl call
|
|
|
|
|
ynh_script_progression --message="Configuring SSOwat..." --time --weight=1
|
|
|
|
|
ynh_app_setting_set --app=$app --key=skipped_uris --value="/"
|
|
|
|
|
# Reload SSOwat config
|
|
|
|
|
yunohost app ssowatconf
|
|
|
|
|
|
|
|
|
|
# Reload Nginx
|
|
|
|
|
ynh_systemd_action --service_name=nginx --action=reload
|
|
|
|
|
|
|
|
|
|
# Installation with curl
|
|
|
|
|
ynh_script_progression --message="Finalizing installation..." --time --weight=1
|
|
|
|
|
ynh_local_curl "/INSTALL_PATH" "key1=value1" "key2=value2" "key3=value3"
|
|
|
|
|
|
|
|
|
|
# Remove the public access
|
|
|
|
|
if [ $is_public -eq 0 ]
|
|
|
|
|
then
|
|
|
|
|
ynh_app_setting_delete --app=$app --key=skipped_uris
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# MODIFY A CONFIG FILE
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### `ynh_replace_string` is used to replace a string in a file.
|
|
|
|
|
### (It's compatible with sed regular expressions syntax)
|
|
|
|
|
|
2020-03-01 11:59:49 +01:00
|
|
|
##ynh_replace_string --match_string="match_string" --replace_string="replace_string" --target_file="$final_path/CONFIG_FILE"
|
2020-03-01 11:28:28 +01:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# 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
|
2020-03-01 11:59:49 +01:00
|
|
|
##ynh_store_file_checksum --file="$final_path/CONFIG_FILE"
|
2020-03-01 11:28:28 +01:00
|
|
|
|
2020-04-28 08:57:06 +02:00
|
|
|
ynh_store_file_checksum --file="$final_path/config.php"
|
|
|
|
|
ynh_store_file_checksum --file="$final_path/config.t2t"
|
|
|
|
|
ynh_store_file_checksum --file="$final_path/menu.php"
|
|
|
|
|
|
2020-03-01 11:28:28 +01:00
|
|
|
#=================================================
|
|
|
|
|
# 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
|
|
|
|
|
|
2020-03-01 12:53:03 +01:00
|
|
|
# Wiki needs to write inside these folders. Make "Wiki" owner
|
2020-03-01 12:58:03 +01:00
|
|
|
chown -R $app:root $final_path/var
|
2020-04-06 09:34:30 +02:00
|
|
|
chown -R $app:root $final_path/templates
|
2020-03-01 12:53:03 +01:00
|
|
|
|
2020-05-14 20:56:58 +02:00
|
|
|
# write everything, even config files, for pheditor:
|
|
|
|
|
chown -R $app:root $final_path/
|
|
|
|
|
|
2020-03-01 12:53:03 +01:00
|
|
|
# Allow access to public assets like style sheets
|
|
|
|
|
find $final_path/templates -type f -print0 | xargs -0 chmod 0644
|
|
|
|
|
find $final_path/templates -type d -print0 | xargs -0 chmod 0755
|
2020-04-06 09:34:30 +02:00
|
|
|
find $final_path/templates/minimaxing/minimaxing.css -type f -print0 | xargs -0 chmod 0755
|
2020-03-01 12:53:03 +01:00
|
|
|
# Using "find" instead of "chmod -R 755" so files does not become executable too
|
|
|
|
|
# chmod : -rwxr-xr-x 1 root root 241 May 3 08:36 index.html => BAD
|
|
|
|
|
# find : -rw-r--r-- 1 1001 1002 241 May 3 08:36 index.html => GOOD
|
|
|
|
|
|
2020-03-01 11:28:28 +01:00
|
|
|
#=================================================
|
|
|
|
|
# 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)
|
2020-04-27 19:57:43 +02:00
|
|
|
# ynh_use_logrotate
|
2020-03-01 11:28:28 +01:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# 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
|
|
|
|
|
|
2020-03-27 11:17:08 +01:00
|
|
|
# yunohost service add $app --description "A short description of the app" --log "/var/log/$app/$app.log"
|
2020-03-01 11:28:28 +01:00
|
|
|
|
|
|
|
|
### 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
|
|
|
|
|
#=================================================
|
2020-03-27 11:17:08 +01:00
|
|
|
# ynh_script_progression --message="Starting a systemd service..." --time --weight=1
|
2020-03-01 11:28:28 +01:00
|
|
|
|
|
|
|
|
### `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
|
2020-03-27 11:17:08 +01:00
|
|
|
# ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
|
2020-03-01 11:28:28 +01:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# SETUP FAIL2BAN
|
|
|
|
|
#=================================================
|
2020-03-01 12:06:24 +01:00
|
|
|
#ynh_script_progression --message="Configuring fail2ban..." --time --weight=1
|
2020-03-01 11:28:28 +01:00
|
|
|
|
|
|
|
|
# Create a dedicated fail2ban config
|
2020-03-01 12:06:24 +01:00
|
|
|
#ynh_add_fail2ban_config --logpath="/var/log/nginx/${domain}-error.log" --failregex="Regex to match into the log for a failed login"
|
2020-03-01 11:28:28 +01:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# SETUP SSOWAT
|
|
|
|
|
#=================================================
|
|
|
|
|
ynh_script_progression --message="Configuring SSOwat..." --time --weight=1
|
|
|
|
|
|
|
|
|
|
# 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=$app --key=unprotected_uris --value="/"
|
|
|
|
|
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
|
