1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/ergo_ynh.git synced 2024-09-03 18:26:31 +02:00
ergo_ynh/scripts/install

225 lines
8.2 KiB
Text
Raw Normal View History

2022-04-18 11:09:01 +02:00
#!/bin/bash
#=================================================
# GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
source _common.sh
source /usr/share/yunohost/helpers
#=================================================
# MANAGE SCRIPT FAILURE
#=================================================
2023-06-06 20:35:54 +02:00
#REMOVEME? ynh_clean_setup () {
2022-04-18 11:09:01 +02:00
true
}
# Exit if an error occurs during the execution of the script
2023-06-06 20:35:54 +02:00
#REMOVEME? ynh_abort_if_errors
2022-04-18 11:09:01 +02:00
#=================================================
# RETRIEVE ARGUMENTS FROM THE MANIFEST
#=================================================
2023-06-06 20:35:54 +02:00
#REMOVEME? domain=$YNH_APP_ARG_DOMAIN
#REMOVEME? path=$YNH_APP_ARG_PATH
#REMOVEME? is_public=$YNH_APP_ARG_IS_PUBLIC
#REMOVEME? language=$YNH_APP_ARG_LANGUAGE
#REMOVEME? password=$YNH_APP_ARG_PASSWORD
#REMOVEME? enable_ldap=$YNH_APP_ARG_ENABLE_LDAP
#REMOVEME? network_name=$YNH_APP_ARG_NETWORK_NAME
#REMOVEME? server_name=$YNH_APP_ARG_SERVER_NAME
2022-04-18 11:09:01 +02:00
2023-06-06 20:35:54 +02:00
#REMOVEME? app=$YNH_APP_INSTANCE_NAME
2022-04-18 11:09:01 +02:00
#=================================================
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
#=================================================
2023-06-06 20:35:54 +02:00
#REMOVEME? ynh_script_progression --message="Validating installation parameters..." --weight=1
2022-04-18 11:09:01 +02:00
2023-06-06 20:35:54 +02:00
#REMOVEME? install_dir=/opt/yunohost/$app
#REMOVEME? test ! -e "$install_dir" || ynh_die --message="This path already contains a folder"
install_dir_www=/var/www/$app
#REMOVEME? test ! -e "$install_dir_www" || ynh_die --message="This path already contains a folder"
2022-04-18 11:09:01 +02:00
# Register (book) web path
2023-06-06 20:35:54 +02:00
#REMOVEME? ynh_webpath_register --app=$app --domain=$domain --path=$path
2022-04-18 11:09:01 +02:00
#=================================================
# STORE SETTINGS FROM MANIFEST
#=================================================
2023-06-06 20:35:54 +02:00
#REMOVEME? ynh_script_progression --message="Storing installation settings..." --weight=1
2022-04-18 11:09:01 +02:00
2023-06-06 20:35:54 +02:00
#REMOVEME? ynh_app_setting_set --app=$app --key=domain --value=$domain
#REMOVEME? ynh_app_setting_set --app=$app --key=path --value=$path
2022-04-18 12:00:11 +02:00
ynh_app_setting_set --app=$app --key=language --value=$language
2022-06-02 07:03:15 +02:00
ynh_app_setting_set --app=$app --key=network_name --value=$network_name
ynh_app_setting_set --app=$app --key=server_name --value=$server_name
2023-06-06 20:35:54 +02:00
#REMOVEME? ynh_app_setting_set --app=$app --key=install_dir_www --value=$install_dir_www
#REMOVEME? ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir
2022-04-18 11:09:01 +02:00
#=================================================
# STANDARD MODIFICATIONS
#=================================================
# FIND AND OPEN A PORT
#=================================================
2023-06-06 20:35:54 +02:00
#REMOVEME? ynh_script_progression --message="Finding an available port..." --weight=1
2022-04-18 11:09:01 +02:00
# Find an available port
2023-06-06 20:35:54 +02:00
#REMOVEME? port=$(ynh_find_port --port=6667) # Plaintext Port
#REMOVEME? secure_port=$(ynh_find_port --port=6697) # Secure Port
2022-06-02 06:45:15 +02:00
2023-06-06 20:35:54 +02:00
#REMOVEME? ynh_app_setting_set --app=$app --key=port --value=$port
#REMOVEME? ynh_app_setting_set --app=$app --key=secure_port --value=$secure_port
2022-06-02 06:45:15 +02:00
2022-07-06 19:55:57 +02:00
ynh_script_progression --message="Configuring firewall..." --weight=1
2022-06-01 00:04:09 +02:00
ynh_exec_warn_less yunohost firewall allow --no-upnp TCP $port
2022-06-02 06:45:15 +02:00
ynh_exec_warn_less yunohost firewall allow --no-upnp TCP $secure_port
2022-04-18 11:09:01 +02:00
#=================================================
# CREATE DEDICATED USER
#=================================================
2023-06-06 20:35:54 +02:00
#REMOVEME? ynh_script_progression --message="Configuring system user..." --weight=2
2022-04-18 11:09:01 +02:00
# Create a system user
2023-06-06 20:35:54 +02:00
#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir" --groups="ssl-cert"
2022-04-18 11:09:01 +02:00
2022-06-01 00:04:09 +02:00
#=================================================
# CREATE A MYSQL DATABASE
#=================================================
2023-06-06 20:35:54 +02:00
#REMOVEME? ynh_script_progression --message="Creating a MySQL database..." --weight=1
2022-06-01 00:04:09 +02:00
2023-06-06 20:35:54 +02:00
#REMOVEME? db_name=$(ynh_sanitize_dbid --db_name=$app)
#REMOVEME? db_user=$db_name
#REMOVEME? ynh_app_setting_set --app=$app --key=db_name --value=$db_name
#REMOVEME? ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name
2022-06-01 00:04:09 +02:00
2022-04-18 11:09:01 +02:00
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
2022-07-06 19:55:57 +02:00
ynh_script_progression --message="Setting up source files..." --weight=10
2022-04-18 11:09:01 +02:00
2023-06-06 20:35:54 +02:00
#REMOVEME? ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir
2022-04-18 11:09:01 +02:00
# Download, check integrity, uncompress and patch the source from app.src
2023-06-06 20:35:54 +02:00
ynh_setup_source --dest_dir="$install_dir" --source_id=$YNH_ARCH
ynh_setup_source --dest_dir="$install_dir" --source_id=ldap
2022-04-18 11:09:01 +02:00
2023-06-06 20:35:54 +02:00
chmod 750 "$install_dir"
chmod -R o-rwx "$install_dir"
chown -R $app:www-data "$install_dir"
chmod +x "$install_dir/ergo"
2022-04-18 11:09:01 +02:00
2022-07-06 20:04:13 +02:00
# Copy help file
2023-06-06 20:35:54 +02:00
mkdir -p "$install_dir_www/help"
2022-07-06 20:04:13 +02:00
if test -e "$YNH_APP_BASEDIR/sources/extra_files/help"; then
2023-06-06 20:35:54 +02:00
cp --archive "$YNH_APP_BASEDIR/sources/extra_files/help/." "$install_dir_www/help"
2022-07-06 20:04:13 +02:00
fi
2023-06-06 20:35:54 +02:00
ynh_replace_vars --file="$install_dir_www/help/index.html"
2022-07-06 20:04:13 +02:00
2023-06-06 20:35:54 +02:00
chmod 750 "$install_dir_www"
chmod -R o-rwx "$install_dir_www"
chown -R "www-data":"www-data" "$install_dir_www"
2022-07-06 20:04:13 +02:00
2022-04-18 11:09:01 +02:00
#=================================================
# NGINX CONFIGURATION
#=================================================
2022-07-06 19:55:57 +02:00
ynh_script_progression --message="Configuring NGINX web server..." --weight=1
2022-04-18 11:09:01 +02:00
# Create a dedicated NGINX config
ynh_add_nginx_config
2022-09-28 03:31:30 +02:00
#=================================================
# SPECIFIC SETUP
2022-04-18 11:09:01 +02:00
#=================================================
# ADD A CONFIGURATION
#=================================================
2022-07-06 19:55:57 +02:00
ynh_script_progression --message="Adding a configuration file..." --weight=2
2022-04-18 11:09:01 +02:00
2022-07-06 17:58:27 +02:00
# Get Password Hash
2023-06-06 20:35:54 +02:00
passwordhash=$((echo "$password"; echo "$password") | $install_dir/ergo genpasswd)
2022-07-06 17:58:27 +02:00
# Enable ldap authentication if necessary
ldapoption=false
if [ $enable_ldap -eq 1 ]
then
ldapoption=true
fi
2022-04-18 11:34:27 +02:00
server=$domain
2023-06-06 20:35:54 +02:00
ynh_add_config --template="../conf/default.yaml" --destination="$install_dir/ircd.yaml"
ynh_add_config --template="../conf/ldap-config.yaml" --destination="$install_dir/ldap-config.yaml"
ynh_add_config --template="../conf/ircd.motd" --destination="$install_dir/ircd.motd"
2022-04-18 11:09:01 +02:00
2023-06-06 20:35:54 +02:00
chmod 400 "$install_dir/ircd.yaml"
chown $app: "$install_dir/ircd.yaml"
2022-04-18 11:09:01 +02:00
#=================================================
# SETUP SYSTEMD
#=================================================
2022-07-06 19:55:57 +02:00
ynh_script_progression --message="Configuring a systemd service..." --weight=3
2022-04-18 11:09:01 +02:00
# Create a dedicated systemd config
ynh_add_systemd_config
#=================================================
# GENERIC FINALIZATION
#=================================================
# SETUP LOGROTATE
#=================================================
2022-07-06 19:55:57 +02:00
ynh_script_progression --message="Configuring log rotation..." --weight=2
2022-04-18 11:09:01 +02:00
# Use logrotate to manage application logfile(s)
ynh_use_logrotate
#=================================================
# INTEGRATE SERVICE IN YUNOHOST
#=================================================
2022-07-06 23:09:44 +02:00
# Build the ports list
needed_ports=()
needed_ports+=( "$port" )
needed_ports+=( "$secure_port" )
2022-07-06 19:55:57 +02:00
ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
2022-04-18 11:09:01 +02:00
2022-07-06 23:09:44 +02:00
yunohost service add $app --description="A modern IRC server" --log="/var/log/$app/$app.log" ${needed_ports:+--needs_exposed_ports} "${needed_ports[@]}"
2022-04-18 11:09:01 +02:00
#=================================================
# START SYSTEMD SERVICE
#=================================================
2022-07-06 19:55:57 +02:00
ynh_script_progression --message="Starting a systemd service..." --weight=1
2022-04-18 11:09:01 +02:00
# Start a systemd service
ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
#=================================================
# SETUP SSOWAT
#=================================================
2023-06-06 20:35:54 +02:00
#REMOVEME? ynh_script_progression --message="Configuring permissions..." --weight=1
2022-04-18 11:09:01 +02:00
# Make app public if necessary
2023-06-06 20:35:54 +02:00
#REMOVEME? if [ $is_public -eq 1 ]
2022-04-18 11:09:01 +02:00
then
# Everyone can access the app.
# The "main" permission is automatically created before the install script.
2023-06-06 20:35:54 +02:00
#REMOVEME? ynh_permission_update --permission="main" --add="visitors"
2022-04-18 11:09:01 +02:00
fi
#=================================================
# RELOAD NGINX
#=================================================
2023-06-06 20:35:54 +02:00
#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=1
2022-04-18 11:09:01 +02:00
2023-06-06 20:35:54 +02:00
#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload
2022-04-18 11:09:01 +02:00
#=================================================
# END OF SCRIPT
#=================================================
2022-07-06 19:55:57 +02:00
ynh_script_progression --message="Installation of $app completed" --last