From 87aec6f60de1891fa79f2f3954c458689a9d4253 Mon Sep 17 00:00:00 2001 From: ewilly Date: Wed, 12 Aug 2020 14:36:40 +0200 Subject: [PATCH 01/13] Fix onboarding and LDAP sign in --- conf/homeassistant_conf_files/.storage/onboarding | 11 +++++++++++ conf/homeassistant_conf_files/configuration.yaml | 7 ------- 2 files changed, 11 insertions(+), 7 deletions(-) create mode 100644 conf/homeassistant_conf_files/.storage/onboarding diff --git a/conf/homeassistant_conf_files/.storage/onboarding b/conf/homeassistant_conf_files/.storage/onboarding new file mode 100644 index 0000000..b92aa42 --- /dev/null +++ b/conf/homeassistant_conf_files/.storage/onboarding @@ -0,0 +1,11 @@ +{ + "data": { + "done": [ + "user", + "core_config", + "integration" + ] + }, + "key": "onboarding", + "version": 3 +} diff --git a/conf/homeassistant_conf_files/configuration.yaml b/conf/homeassistant_conf_files/configuration.yaml index c02777b..e96a6d2 100644 --- a/conf/homeassistant_conf_files/configuration.yaml +++ b/conf/homeassistant_conf_files/configuration.yaml @@ -3,13 +3,6 @@ homeassistant: - type: command_line command: /home/homeassistant/.homeassistant/bin/ynh_ldap-auth.sh meta: true - - type: homeassistant - - type: trusted_networks - trusted_networks: - - 127.0.0.1 - - ::1 - - 192.168.0.0/24 - - fd00::/8 name: Home latitude: 0 longitude: 0 From 82198d4e6c8e83ede062027d0164f6232a40f86c Mon Sep 17 00:00:00 2001 From: ewilly Date: Wed, 12 Aug 2020 16:51:17 +0200 Subject: [PATCH 02/13] Update HA version --- scripts/_common.sh | 3 +++ scripts/install | 2 +- scripts/upgrade | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/scripts/_common.sh b/scripts/_common.sh index b32d5cf..9ce60dd 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -2,6 +2,9 @@ # Common variables & functions # +# Release to install +VERSION=0.114.0 + # Package dependencies PKG_DEPENDENCIES="python3 python3-venv python3-pip build-essential libssl-dev libffi-dev python3-dev" diff --git a/scripts/install b/scripts/install index 42ec570..ab0577f 100644 --- a/scripts/install +++ b/scripts/install @@ -60,7 +60,7 @@ exec_as $app -H -s /bin/bash -c " \ && echo 'install a required python package' \ && pip install --upgrade wheel \ && echo 'install Home Assistant' \ - && pip install --upgrade $app==0.96.5 \ + && pip install --upgrade $app==$VERSION \ " # set default configuration files diff --git a/scripts/upgrade b/scripts/upgrade index 2ce4e78..7638ff5 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -43,7 +43,7 @@ exec_as "$app" -H -s /bin/bash -c " \ && echo 'install a required python package' \ && pip install --upgrade wheel \ && echo 'install Home Assistant' \ - && pip install --upgrade $app==0.96.5 \ + && pip install --upgrade $app==$VERSION \ " # setup up autostart using systemd From e67e2ffde53818544feb00a36f7fb61748db0475 Mon Sep 17 00:00:00 2001 From: ewilly Date: Wed, 12 Aug 2020 22:22:59 +0200 Subject: [PATCH 03/13] Update syntax --- manifest.json | 2 +- scripts/backup | 12 ++++++------ scripts/install | 10 ++-------- scripts/remove | 12 ++++++------ scripts/restore | 29 ++++++++++------------------- scripts/upgrade | 12 +++++++++--- 6 files changed, 34 insertions(+), 43 deletions(-) diff --git a/manifest.json b/manifest.json index acc662f..9fa81e4 100644 --- a/manifest.json +++ b/manifest.json @@ -14,7 +14,7 @@ "email": "ewilly@ewilly.fr" }, "requirements": { - "yunohost": ">= 3.1" + "yunohost": ">= 3.7" }, "multi_instance": false, "services": [ diff --git a/scripts/backup b/scripts/backup index 772bf4c..512bdfe 100644 --- a/scripts/backup +++ b/scripts/backup @@ -10,15 +10,15 @@ ynh_abort_if_errors # retrieve arguments app=$YNH_APP_INSTANCE_NAME -domain=$(ynh_app_setting_get "$app" domain) +domain=$(ynh_app_setting_get --app=$app --key=domain) # definie useful vars final_path="/opt/yunohost/$app" home_path="/home/$app" # backup source & conf files -ynh_backup "$final_path" -ynh_backup "$home_path" -ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" -ynh_backup "/etc/sudoers.d/$app" -ynh_backup "/etc/systemd/system/$app@$app.service" +ynh_backup --src_path="$final_path" +ynh_backup --src_path="$home_path" +ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" +ynh_backup --src_path="/etc/sudoers.d/$app" +ynh_backup --src_path="/etc/systemd/system/$app@$app.service" diff --git a/scripts/install b/scripts/install index ab0577f..c0cea8c 100644 --- a/scripts/install +++ b/scripts/install @@ -29,7 +29,6 @@ ynh_install_app_dependencies "$PKG_DEPENDENCIES" # save app settings ynh_script_progression --message="Storing installation settings..." ynh_app_setting_set $app domain "$domain" -ynh_app_setting_set $app is_public $is_public # find a free port & open it ynh_script_progression --message="Looking for a free port and opening it..." @@ -90,12 +89,7 @@ ynh_add_nginx_config ynh_system_reload --service_name=nginx # unprotect app access if public (needed for Android app to work) -ynh_script_progression --message="Configuring SSOwat..." -[ $is_public -eq 1 ] && ynh_app_setting_set $app unprotected_uris "/" - -# alert about administrator creator -message="Your installation is not yet secure : please, IMMEDIATELY go to $domain in order to create the admin user of Home Assistant." -ynh_script_progression --message="$message" -ynh_send_readme_to_admin --app_message="$message" --recipients="root" +ynh_script_progression --message="Configuring permissions..." +[ $is_public -eq 1 ] && ynh_permission_update --permission "main" --add "visitors" ynh_script_progression --message="Installation of $app completed" --last diff --git a/scripts/remove b/scripts/remove index e04eeb8..7f355f4 100644 --- a/scripts/remove +++ b/scripts/remove @@ -7,8 +7,8 @@ source /usr/share/yunohost/helpers # retrieve arguments app=$YNH_APP_INSTANCE_NAME -domain=$(ynh_app_setting_get "$app" domain) -port=$(ynh_app_setting_get $app port) +domain=$(ynh_app_setting_get --app=$app --key=domain) +port=$(ynh_app_setting_get --app=$app --key=port) # definie useful vars final_path="/opt/yunohost/$app" @@ -18,13 +18,13 @@ home_path="/home/$app" ynh_remove_app_dependencies # remove the app directory securely -ynh_secure_remove "$final_path" +ynh_secure_remove --file="$final_path" # remove the dedicated nginx config ynh_remove_nginx_config # remove a directory securely -ynh_secure_remove "$home_path" +ynh_secure_remove --file="$home_path" # remove service from admin panel if yunohost service status | grep -q "$app@$app" @@ -35,13 +35,13 @@ fi # remove systemd service ynh_system_reload --service_name="$app@$app" --action=stop ynh_system_reload --service_name="$app@$app" --action=disable -ynh_secure_remove "/etc/systemd/system/$app.service" +ynh_secure_remove --file="/etc/systemd/system/$app.service" # close port ynh_exec_fully_quiet yunohost firewall disallow TCP $port # delete a system user -ynh_system_user_delete "$app" +ynh_system_user_delete --username=$app # remove sudoers file ynh_secure_remove "/etc/sudoers.d/$app" diff --git a/scripts/restore b/scripts/restore index 7a4c6ce..37b6503 100644 --- a/scripts/restore +++ b/scripts/restore @@ -12,8 +12,8 @@ ynh_abort_if_errors # retrieve arguments app=$YNH_APP_INSTANCE_NAME -domain=$(ynh_app_setting_get "$app" domain) -port=$(ynh_app_setting_get "$app" port) +domain=$(ynh_app_setting_get --app=$app --key=domain) +port=$(ynh_app_setting_get --app=$app --key=port) # definie useful vars final_path="/opt/yunohost/$app" @@ -28,29 +28,20 @@ ynh_webpath_available $domain $path_url || ynh_die "$domain/$path_url is not ava ynh_install_app_dependencies "$PKG_DEPENDENCIES" # restore dedicated system user -ynh_system_user_exists "$app" && ynh_die "User $app is not available" -ynh_system_user_create "$app" +ynh_system_user_create --username="$app" # restore conf files -ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf" -ynh_restore_file "/etc/sudoers.d/$app" -ynh_restore_file "/etc/systemd/system/$app@$app.service" +ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" +ynh_restore_file --origin_path="/etc/sudoers.d/$app" +ynh_restore_file --origin_path="/etc/systemd/system/$app@$app.service" # restore source -if [ ! -d "$final_path" ]; then - ynh_restore_file "$final_path" -else - ynh_die "There is already a directory: $final_path" -fi +ynh_restore_file --origin_path="$final_path" # restore data -if [ ! -d "$home_path" ]; then - ynh_restore_file "$home_path" - chown -R $app: "$home_path" - chmod -R +x "$home_path/.homeassistant/bin" -else - ynh_die "$home_path already exists and will not be overwritten" -fi +ynh_restore_file --origin_path="$home_path" +chown -R $app: "$home_path" +chmod -R +x "$home_path/.homeassistant/bin" # restore port [ $port -eq $(ynh_find_port $port) ] || ynh_die "$port is not available, please use an other port" diff --git a/scripts/upgrade b/scripts/upgrade index 7638ff5..55ff495 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -8,9 +8,15 @@ ynh_abort_if_errors # retrieve arguments app=$YNH_APP_INSTANCE_NAME -domain=$(ynh_app_setting_get $app domain) -port=$(ynh_app_setting_get $app port) -is_public=$(ynh_app_setting_get $app is_public) +domain=$(ynh_app_setting_get --app=$app --key=domain) +port=$(ynh_app_setting_get --app=$app --key=port) + +# Cleaning legacy permissions +is_public=$(ynh_app_setting_get --app=$app --key=is_public) +if [ -n "$is_public" ]; then + ynh_app_setting_delete --app=$app --key=is_public + ynh_app_setting_delete --app=$app --key=unprotected_uris +fi # definie useful vars final_path="/opt/yunohost/$app" From 8e342cc34c31644862dc6b6078d8f81f1e0cfa66 Mon Sep 17 00:00:00 2001 From: ewilly Date: Thu, 13 Aug 2020 20:50:44 +0200 Subject: [PATCH 04/13] Refractor --- .../configuration.yaml | 1 - scripts/_common.sh | 388 ------------------ scripts/install | 15 +- scripts/remove | 13 +- scripts/restore | 8 +- scripts/upgrade | 32 +- 6 files changed, 41 insertions(+), 416 deletions(-) diff --git a/conf/homeassistant_conf_files/configuration.yaml b/conf/homeassistant_conf_files/configuration.yaml index e96a6d2..a46e77a 100644 --- a/conf/homeassistant_conf_files/configuration.yaml +++ b/conf/homeassistant_conf_files/configuration.yaml @@ -11,7 +11,6 @@ homeassistant: time_zone: UTC http: - base_url: __DOMAIN__:__PORT__ server_port: __PORT__ use_x_forwarded_for: True trusted_proxies: diff --git a/scripts/_common.sh b/scripts/_common.sh index 9ce60dd..61e51e1 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -20,39 +20,6 @@ myynh_create_dir () { [ -d "$1" ] || mkdir -p "$1" } -# Check if enough disk space available on backup storage -myynh_check_disk_space () { - file_to_analyse=$1 - backup_size=$(du --summarize "$1" | cut -f1) - free_space=$(df --output=avail "/home/yunohost.backup" | sed 1d) - if [ $free_space -le $backup_size ]; then - WARNING echo "Not enough backup disk space for: $1" - WARNING echo "Space available: $(HUMAN_SIZE $free_space)" - ynh_die "Space needed: $(HUMAN_SIZE $backup_size)" - fi -} - -# Clean & copy files needed to final folder -myynh_clean_source () { - find "$TMPDIR" -type f -name ".htaccess" | xargs rm - [ -e "$TMPDIR/.gitignore" ] && rm -r "$TMPDIR/.gitignore" -} - -#================================================= -# FUTURE YUNOHOST HELPERS - TO BE REMOVED LATER -#================================================= - -# Delete a file checksum from the app settings -# -# $app should be defined when calling this helper -# -# usage: ynh_remove_file_checksum file -# | arg: file - The file for which the checksum will be deleted -ynh_delete_file_checksum () { - local checksum_setting_name=checksum_${1//[\/ ]/_} # Replace all '/' and ' ' by '_' - ynh_app_setting_delete $app $checksum_setting_name -} - # Execute a command as another user # usage: exec_as USER COMMAND [ARG ...] exec_as() { @@ -65,358 +32,3 @@ exec_as() { sudo -u "$USER" "$@" fi } - -# Internal helper design to allow helpers to use getopts to manage their arguments -# -# example: function my_helper() -# { -# declare -Ar args_array=( [a]=arg1= [b]=arg2= [c]=arg3 ) -# local arg1 -# local arg2 -# local arg3 -# ynh_handle_getopts_args "$@" -# -# [...] -# } -# my_helper --arg1 "val1" -b val2 -c -# -# usage: ynh_handle_getopts_args "$@" -# | arg: $@ - Simply "$@" to tranfert all the positionnal arguments to the function -# -# This helper need an array, named "args_array" with all the arguments used by the helper -# that want to use ynh_handle_getopts_args -# Be carreful, this array has to be an associative array, as the following example: -# declare -Ar args_array=( [a]=arg1 [b]=arg2= [c]=arg3 ) -# Let's explain this array: -# a, b and c are short options, -a, -b and -c -# arg1, arg2 and arg3 are the long options associated to the previous short ones. --arg1, --arg2 and --arg3 -# For each option, a short and long version has to be defined. -# Let's see something more significant -# declare -Ar args_array=( [u]=user [f]=finalpath= [d]=database ) -# -# NB: Because we're using 'declare' without -g, the array will be declared as a local variable. -# -# Please keep in mind that the long option will be used as a variable to store the values for this option. -# For the previous example, that means that $finalpath will be fill with the value given as argument for this option. -# -# Also, in the previous example, finalpath has a '=' at the end. That means this option need a value. -# So, the helper has to be call with --finalpath /final/path, --finalpath=/final/path or -f /final/path, the variable $finalpath will get the value /final/path -# If there's many values for an option, -f /final /path, the value will be separated by a ';' $finalpath=/final;/path -# For an option without value, like --user in the example, the helper can be called only with --user or -u. $user will then get the value 1. -# -# To keep a retrocompatibility, a package can still call a helper, using getopts, with positional arguments. -# The "legacy mode" will manage the positional arguments and fill the variable in the same order than they are given in $args_array. -# e.g. for `my_helper "val1" val2`, arg1 will be filled with val1, and arg2 with val2. -ynh_handle_getopts_args () { - # Manage arguments only if there's some provided - set +x - if [ $# -ne 0 ] - then - # Store arguments in an array to keep each argument separated - local arguments=("$@") - - # For each option in the array, reduce to short options for getopts (e.g. for [u]=user, --user will be -u) - # And built parameters string for getopts - # ${!args_array[@]} is the list of all keys in the array (A key is 'u' in [u]=user, user is a value) - local getopts_parameters="" - local key="" - for key in "${!args_array[@]}" - do - # Concatenate each keys of the array to build the string of arguments for getopts - # Will looks like 'abcd' for -a -b -c -d - # If the value of a key finish by =, it's an option with additionnal values. (e.g. --user bob or -u bob) - # Check the last character of the value associate to the key - if [ "${args_array[$key]: -1}" = "=" ] - then - # For an option with additionnal values, add a ':' after the letter for getopts. - getopts_parameters="${getopts_parameters}${key}:" - else - getopts_parameters="${getopts_parameters}${key}" - fi - # Check each argument given to the function - local arg="" - # ${#arguments[@]} is the size of the array - for arg in `seq 0 $(( ${#arguments[@]} - 1 ))` - do - # And replace long option (value of the key) by the short option, the key itself - # (e.g. for [u]=user, --user will be -u) - # Replace long option with = - arguments[arg]="${arguments[arg]//--${args_array[$key]}/-${key} }" - # And long option without = - arguments[arg]="${arguments[arg]//--${args_array[$key]%=}/-${key}}" - done - done - - # Read and parse all the arguments - # Use a function here, to use standart arguments $@ and be able to use shift. - parse_arg () { - # Read all arguments, until no arguments are left - while [ $# -ne 0 ] - do - # Initialize the index of getopts - OPTIND=1 - # Parse with getopts only if the argument begin by -, that means the argument is an option - # getopts will fill $parameter with the letter of the option it has read. - local parameter="" - getopts ":$getopts_parameters" parameter || true - - if [ "$parameter" = "?" ] - then - ynh_die "Invalid argument: -${OPTARG:-}" - elif [ "$parameter" = ":" ] - then - ynh_die "-$OPTARG parameter requires an argument." - else - local shift_value=1 - # Use the long option, corresponding to the short option read by getopts, as a variable - # (e.g. for [u]=user, 'user' will be used as a variable) - # Also, remove '=' at the end of the long option - # The variable name will be stored in 'option_var' - local option_var="${args_array[$parameter]%=}" - # If this option doesn't take values - # if there's a '=' at the end of the long option name, this option takes values - if [ "${args_array[$parameter]: -1}" != "=" ] - then - # 'eval ${option_var}' will use the content of 'option_var' - eval ${option_var}=1 - else - # Read all other arguments to find multiple value for this option. - # Load args in a array - local all_args=("$@") - - # If the first argument is longer than 2 characters, - # There's a value attached to the option, in the same array cell - if [ ${#all_args[0]} -gt 2 ]; then - # Remove the option and the space, so keep only the value itself. - all_args[0]="${all_args[0]#-${parameter} }" - # Reduce the value of shift, because the option has been removed manually - shift_value=$(( shift_value - 1 )) - fi - - # Then read the array value per value - for i in `seq 0 $(( ${#all_args[@]} - 1 ))` - do - # If this argument is an option, end here. - if [ "${all_args[$i]:0:1}" == "-" ] || [ -z "${all_args[$i]}" ] - then - # Ignore the first value of the array, which is the option itself - if [ "$i" -ne 0 ]; then - break - fi - else - # Declare the content of option_var as a variable. - eval ${option_var}="" - # Else, add this value to this option - # Each value will be separated by ';' - if [ -n "${!option_var}" ] - then - # If there's already another value for this option, add a ; before adding the new value - eval ${option_var}+="\;" - fi - eval ${option_var}+=\"${all_args[$i]}\" - shift_value=$(( shift_value + 1 )) - fi - done - fi - fi - - # Shift the parameter and its argument(s) - shift $shift_value - done - } - - # LEGACY MODE - # Check if there's getopts arguments - if [ "${arguments[0]:0:1}" != "-" ] - then - # If not, enter in legacy mode and manage the arguments as positionnal ones. - echo "! Helper used in legacy mode !" - for i in `seq 0 $(( ${#arguments[@]} -1 ))` - do - # Use getopts_parameters as a list of key of the array args_array - # Remove all ':' in getopts_parameters - getopts_parameters=${getopts_parameters//:} - # Get the key from getopts_parameters, by using the key according to the position of the argument. - key=${getopts_parameters:$i:1} - # Use the long option, corresponding to the key, as a variable - # (e.g. for [u]=user, 'user' will be used as a variable) - # Also, remove '=' at the end of the long option - # The variable name will be stored in 'option_var' - local option_var="${args_array[$key]%=}" - - # Store each value given as argument in the corresponding variable - # The values will be stored in the same order than $args_array - eval ${option_var}+=\"${arguments[$i]}\" - done - else - # END LEGACY MODE - # Call parse_arg and pass the modified list of args as an array of arguments. - parse_arg "${arguments[@]}" - fi - fi - set -x -} - -#================================================= - -# Start or restart a service and follow its booting -# -# usage: ynh_check_starting "Line to match" [Log file] [Timeout] [Service name] -# -# | arg: -m, --line_to_match= - Line to match - The line to find in the log to attest the service have finished to boot. -# | arg: -l, --app_log= - Log file - The log file to watch; specify "systemd" to read systemd journal for specified service -# /var/log/$app/$app.log will be used if no other log is defined. -# | arg: -t, --timeout= - Timeout - The maximum time to wait before ending the watching. Defaut 300 seconds. -# | arg: -n, --service_name= - Service name - -ynh_check_starting () { - # Declare an array to define the options of this helper. - declare -Ar args_array=( [m]=line_to_match= [l]=app_log= [t]=timeout= [n]=service_name= ) - local line_to_match - local app_log - local timeout - local service_name - # Manage arguments with getopts - ynh_handle_getopts_args "$@" - local app_log="${app_log:-/var/log/$service_name/$service_name.log}" - local timeout=${timeout:-300} - local service_name="${service_name:-$app}" - - echo "Starting of $service_name" >&2 - systemctl stop $service_name - local templog="$(mktemp)" - # Following the starting of the app in its log - if [ "$app_log" == "systemd" ] ; then - # Read the systemd journal - journalctl -u $service_name -f --since=-45 > "$templog" & - else - # Read the specified log file - tail -F -n0 "$app_log" > "$templog" & - fi - # Get the PID of the last command - local pid_tail=$! - systemctl start $service_name - - local i=0 - for i in `seq 1 $timeout` - do - # Read the log until the sentence is found, which means the app finished starting. Or run until the timeout. - if grep --quiet "$line_to_match" "$templog" - then - echo "The service $service_name has correctly started." >&2 - break - fi - echo -n "." >&2 - sleep 1 - done - if [ $i -eq $timeout ] - then - echo "The service $service_name didn't fully start before the timeout." >&2 - fi - - echo "" - ynh_clean_check_starting -} - -# Clean temporary process and file used by ynh_check_starting -# (usually used in ynh_clean_setup scripts) -# -# usage: ynh_clean_check_starting -ynh_clean_check_starting () { - # Stop the execution of tail. - kill -s 15 $pid_tail 2>&1 - #echo "$(cat $templog)" - ynh_secure_remove "$templog" 2>&1 -} - -# Reload (or other actions) a service and print a log in case of failure. -# -# usage: ynh_system_reload service_name [action] -# | arg: -n, --service_name= - Name of the service to reload -# | arg: -a, --action= - Action to perform with systemctl. Default: reload -ynh_system_reload () { - # Declare an array to define the options of this helper. - declare -Ar args_array=( [n]=service_name= [a]=action= ) - local service_name - local action - # Manage arguments with getopts - ynh_handle_getopts_args "$@" - local action=${action:-reload} - - # Reload, restart or start and print the log if the service fail to start or reload - systemctl $action $service_name || ( journalctl --lines=20 -u $service_name >&2 && false) -} - -# Execute a command and redirect stdout and stderr in /dev/null -# -# usage: ynh_exec_fully_quiet command to execute -# usage: ynh_exec_fully_quiet "command to execute | following command" -# In case of use of pipes, you have to use double quotes. Otherwise, this helper will be executed with the first command, then be send to the next pipe. -# -# | arg: command - command to execute -ynh_exec_fully_quiet () { - eval $@ > /dev/null 2>&1 -} - -# Send an email to inform the administrator -# -# usage: ynh_send_readme_to_admin app_message [recipients] -# | arg: -m --app_message= - The message to send to the administrator. -# | arg: -r, --recipients= - The recipients of this email. Use spaces to separate multiples recipients. - default: root -# example: "root admin@domain" -# If you give the name of a YunoHost user, ynh_send_readme_to_admin will find its email adress for you -# example: "root admin@domain user1 user2" -ynh_send_readme_to_admin() { - # Declare an array to define the options of this helper. - declare -Ar args_array=( [m]=app_message= [r]=recipients= ) - local app_message - local recipients - # Manage arguments with getopts - ynh_handle_getopts_args "$@" - local app_message="${app_message:-...No specific information...}" - local recipients="${recipients:-root}" - - # Retrieve the email of users - find_mails () { - local list_mails="$1" - local mail - local recipients=" " - # Read each mail in argument - for mail in $list_mails - do - # Keep root or a real email address as it is - if [ "$mail" = "root" ] || echo "$mail" | grep --quiet "@" - then - recipients="$recipients $mail" - else - # But replace an user name without a domain after by its email - if mail=$(ynh_user_get_info "$mail" "mail" 2> /dev/null) - then - recipients="$recipients $mail" - fi - fi - done - echo "$recipients" - } - recipients=$(find_mails "$recipients") - - local mail_subject="☁️🆈🅽🅷☁️: \`$app\` was just installed!" - - local mail_message="This is an automated message from your beloved YunoHost server. -Specific information for the application $app. -$app_message ---- -Automatic diagnosis data from YunoHost -$(yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d')" - - # Define binary to use for mail command - if [ -e /usr/bin/bsd-mailx ] - then - local mail_bin=/usr/bin/bsd-mailx - else - local mail_bin=/usr/bin/mail.mailutils - fi - - # Send the email to the recipients - echo "$mail_message" | $mail_bin -a "Content-Type: text/plain; charset=UTF-8" -s "$mail_subject" "$recipients" -} diff --git a/scripts/install b/scripts/install index c0cea8c..17895fe 100644 --- a/scripts/install +++ b/scripts/install @@ -4,6 +4,9 @@ source _common.sh source /usr/share/yunohost/helpers # manage script failure +ynh_clean_setup () { + ynh_clean_check_starting +} ynh_abort_if_errors # retrieve arguments @@ -65,28 +68,26 @@ exec_as $app -H -s /bin/bash -c " \ # set default configuration files ynh_script_progression --message="Configuring the installation..." ynh_replace_string "__PORT__" "$port" "../conf/homeassistant_conf_files/configuration.yaml" -ynh_replace_string "__DOMAIN__" "$domain" "../conf/homeassistant_conf_files/configuration.yaml" chmod -R +x "../conf/homeassistant_conf_files/bin/" ## move all homeassistant_conf_files cp -r "../conf/homeassistant_conf_files/." "$data_path/" chown -R $app: "$data_path" -# setup up autostart using systemd +# setup up systemd service ynh_script_progression --message="Adding the dedicated service..." -ynh_add_systemd_config "$app@$app" +ynh_add_systemd_config --service="$app@$app" ## add service in admin panel yunohost service add "$app@$app" --log "$data_path/home-assistant.log" --description "Home Assistant server" -# enable & restart systemd service +# start systemd service ynh_script_progression --message="Starting the Home Assistant server..." -ynh_system_reload --service_name="$app@$app" --action=enable -ynh_check_starting --line_to_match="Home Assistant initialized" --app_log="systemd" --timeout=1000 --service_name="$app@$app" +ynh_systemd_action --service_name="$app@$app" --action=start --line_to_match="Home Assistant initialized" --log_path="systemd" --timeout=1000 # create a dedicated nginx config ynh_script_progression --message="Configuring nginx web server..." ynh_add_nginx_config ## reload nginx -ynh_system_reload --service_name=nginx +ynh_systemd_action --service_name=nginx --action=reload # unprotect app access if public (needed for Android app to work) ynh_script_progression --message="Configuring permissions..." diff --git a/scripts/remove b/scripts/remove index 7f355f4..f576598 100644 --- a/scripts/remove +++ b/scripts/remove @@ -26,15 +26,14 @@ ynh_remove_nginx_config # remove a directory securely ynh_secure_remove --file="$home_path" -# remove service from admin panel -if yunohost service status | grep -q "$app@$app" -then - yunohost service remove "$app@$app" +# Remove a service from the admin panel, added by `yunohost service add` +if yunohost service status "$app@$app" >/dev/null 2>&1 ; then + yunohost service remove "$app@$app" fi # remove systemd service -ynh_system_reload --service_name="$app@$app" --action=stop -ynh_system_reload --service_name="$app@$app" --action=disable +ynh_systemd_action --service_name="$app@$app" --action=stop +ynh_systemd_action --service_name="$app@$app" --action=disable ynh_secure_remove --file="/etc/systemd/system/$app.service" # close port @@ -44,4 +43,4 @@ ynh_exec_fully_quiet yunohost firewall disallow TCP $port ynh_system_user_delete --username=$app # remove sudoers file -ynh_secure_remove "/etc/sudoers.d/$app" +ynh_secure_remove --file="/etc/sudoers.d/$app" diff --git a/scripts/restore b/scripts/restore index 37b6503..7cf9410 100644 --- a/scripts/restore +++ b/scripts/restore @@ -8,6 +8,9 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers # manage script failure +ynh_clean_setup () { + ynh_clean_check_starting +} ynh_abort_if_errors # retrieve arguments @@ -51,8 +54,7 @@ ynh_exec_fully_quiet yunohost firewall allow TCP $port yunohost service add "$app@$app" --log "$data_path/home-assistant.log" --description "Home Assistant server" # enable & restart systemd service -ynh_system_reload --service_name="$app@$app" --action=enable -ynh_check_starting --line_to_match="Home Assistant initialized" --app_log="systemd" --timeout=1000 --service_name="$app@$app" +ynh_systemd_action --service_name="$app@$app" --action=start --line_to_match="Home Assistant initialized" --log_path="systemd" --timeout=1000 # reload nginx -ynh_system_reload --service_name=nginx +ynh_systemd_action --service_name=nginx --action=reload diff --git a/scripts/upgrade b/scripts/upgrade index 55ff495..958e056 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -4,6 +4,9 @@ source _common.sh source /usr/share/yunohost/helpers # manage script failure +ynh_clean_setup () { + ynh_clean_check_starting +} ynh_abort_if_errors # retrieve arguments @@ -12,6 +15,7 @@ domain=$(ynh_app_setting_get --app=$app --key=domain) port=$(ynh_app_setting_get --app=$app --key=port) # Cleaning legacy permissions +ynh_script_progression --message="Cleaning legacy permissions..." is_public=$(ynh_app_setting_get --app=$app --key=is_public) if [ -n "$is_public" ]; then ynh_app_setting_delete --app=$app --key=is_public @@ -22,25 +26,30 @@ fi final_path="/opt/yunohost/$app" # use prior backup and restore on error only if backup feature exists on installed instance +ynh_script_progression --message="Creating backup in case of failure..." if [ -f "/etc/yunohost/apps/$app/scripts/backup" ] ; then ynh_backup_before_upgrade # Backup the current version of the app ynh_clean_setup () { ynh_restore_upgradebackup + ynh_clean_check_starting } fi # grant sudo permissions to the user to manage his own systemd service +ynh_script_progression --message="Creating dedicated user, rights and folders..." myynh_create_dir "/etc/sudoers.d" cp "../conf/sudoers" "/etc/sudoers.d/$app" # add required packages +ynh_script_progression --message="Installing dependencies..." ynh_install_app_dependencies "$PKG_DEPENDENCIES" # stop systemd service -ynh_system_reload --service_name="$app@$app" --action=stop -ynh_system_reload --service_name="$app@$app" --action=disable +ynh_script_progression --message="Stoping service..." +ynh_systemd_action --service_name="$app@$app" --action=stop -# upgrade +# installation in a virtual environment +ynh_script_progression --message="Installing Home Assistant in a virtual environment..." exec_as "$app" -H -s /bin/bash -c " \ echo 'create the virtual environment' \ && python3 -m venv $final_path \ @@ -52,15 +61,18 @@ exec_as "$app" -H -s /bin/bash -c " \ && pip install --upgrade $app==$VERSION \ " -# setup up autostart using systemd -ynh_add_systemd_config "$app@$app" +# setup up systemd service +ynh_script_progression --message="Adding the dedicated service..." +ynh_add_systemd_config --service="$app@$app" -# enable & restart systemd service -ynh_system_reload --service_name="$app@$app" --action=enable -ynh_check_starting --line_to_match="Home Assistant initialized" --app_log="systemd" --timeout=1000 --service_name="$app@$app" +# start systemd service +ynh_script_progression --message="Starting the Home Assistant server..." +ynh_systemd_action --service_name="$app@$app" --action=start --line_to_match="Home Assistant initialized" --log_path="systemd" --timeout=1000 # create a dedicated nginx config +ynh_script_progression --message="Configuring nginx web server..." ynh_add_nginx_config - # reload nginx -ynh_system_reload --service_name=nginx +ynh_systemd_action --service_name=nginx --action=reload + +ynh_script_progression --message="Installation of $app completed" --last From 04f7966e55140ca9761de830e2644eb0f3faa72c Mon Sep 17 00:00:00 2001 From: ewilly Date: Thu, 13 Aug 2020 21:04:43 +0200 Subject: [PATCH 05/13] Fix typo --- scripts/install | 2 +- scripts/restore | 2 +- scripts/upgrade | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/scripts/install b/scripts/install index 17895fe..badb5f0 100644 --- a/scripts/install +++ b/scripts/install @@ -81,7 +81,7 @@ yunohost service add "$app@$app" --log "$data_path/home-assistant.log" --descrip # start systemd service ynh_script_progression --message="Starting the Home Assistant server..." -ynh_systemd_action --service_name="$app@$app" --action=start --line_to_match="Home Assistant initialized" --log_path="systemd" --timeout=1000 +ynh_systemd_action --service_name="$app@$app" --action=start --line_match="Home Assistant initialized" --log_path="systemd" --timeout=1000 # create a dedicated nginx config ynh_script_progression --message="Configuring nginx web server..." diff --git a/scripts/restore b/scripts/restore index 7cf9410..02b6fb0 100644 --- a/scripts/restore +++ b/scripts/restore @@ -54,7 +54,7 @@ ynh_exec_fully_quiet yunohost firewall allow TCP $port yunohost service add "$app@$app" --log "$data_path/home-assistant.log" --description "Home Assistant server" # enable & restart systemd service -ynh_systemd_action --service_name="$app@$app" --action=start --line_to_match="Home Assistant initialized" --log_path="systemd" --timeout=1000 +ynh_systemd_action --service_name="$app@$app" --action=start --line_match="Home Assistant initialized" --log_path="systemd" --timeout=1000 # reload nginx ynh_systemd_action --service_name=nginx --action=reload diff --git a/scripts/upgrade b/scripts/upgrade index 958e056..f525f5f 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -67,7 +67,7 @@ ynh_add_systemd_config --service="$app@$app" # start systemd service ynh_script_progression --message="Starting the Home Assistant server..." -ynh_systemd_action --service_name="$app@$app" --action=start --line_to_match="Home Assistant initialized" --log_path="systemd" --timeout=1000 +ynh_systemd_action --service_name="$app@$app" --action=start --line_match="Home Assistant initialized" --log_path="systemd" --timeout=1000 # create a dedicated nginx config ynh_script_progression --message="Configuring nginx web server..." From 80061bfdb08ebf26bd65b299f6bd5bb61a13760a Mon Sep 17 00:00:00 2001 From: ewilly Date: Thu, 13 Aug 2020 22:10:20 +0200 Subject: [PATCH 06/13] Fix systemd service remove --- scripts/remove | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/remove b/scripts/remove index f576598..fa5cab3 100644 --- a/scripts/remove +++ b/scripts/remove @@ -34,7 +34,7 @@ fi # remove systemd service ynh_systemd_action --service_name="$app@$app" --action=stop ynh_systemd_action --service_name="$app@$app" --action=disable -ynh_secure_remove --file="/etc/systemd/system/$app.service" +ynh_secure_remove --file="/etc/systemd/system/$app@$app.service" # close port ynh_exec_fully_quiet yunohost firewall disallow TCP $port From 86aca0935e62830a65fa9e0471b564923e5eff70 Mon Sep 17 00:00:00 2001 From: ewilly Date: Fri, 14 Aug 2020 09:03:45 +0200 Subject: [PATCH 07/13] Fix vs HA 0.114 --- conf/homeassistant_conf_files/ui-lovelace.yaml | 13 +++++++++++++ conf/systemd.service | 1 + 2 files changed, 14 insertions(+) create mode 100644 conf/homeassistant_conf_files/ui-lovelace.yaml diff --git a/conf/homeassistant_conf_files/ui-lovelace.yaml b/conf/homeassistant_conf_files/ui-lovelace.yaml new file mode 100644 index 0000000..284a3de --- /dev/null +++ b/conf/homeassistant_conf_files/ui-lovelace.yaml @@ -0,0 +1,13 @@ +title: Home +views: + - path: default_view + title: Home + badges: + - entity: sun.sun + cards: + - type: entities + entities: + - sensor.current_version + - sensor.latest_available_version + - switch.upgrade_homeassistant + title: Home Assistant diff --git a/conf/systemd.service b/conf/systemd.service index e5f3a3c..cd202d9 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -5,6 +5,7 @@ After=network-online.target [Service] Type=simple User=homeassistant +WorkingDirectory=/home/homeassistant/.homeassistant ExecStart=/opt/yunohost/homeassistant/bin/hass -c "/home/homeassistant/.homeassistant" [Install] From 6368f759c44faba5f96d645591668222799c1552 Mon Sep 17 00:00:00 2001 From: ewilly Date: Fri, 14 Aug 2020 09:06:05 +0200 Subject: [PATCH 08/13] Add debug to hass command --- conf/systemd.service | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/conf/systemd.service b/conf/systemd.service index cd202d9..283225c 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -6,7 +6,7 @@ After=network-online.target Type=simple User=homeassistant WorkingDirectory=/home/homeassistant/.homeassistant -ExecStart=/opt/yunohost/homeassistant/bin/hass -c "/home/homeassistant/.homeassistant" +ExecStart=/opt/yunohost/homeassistant/bin/hass -c "/home/homeassistant/.homeassistant" --debug [Install] WantedBy=multi-user.target From bd41de5df3c71699464bb7bf77143c603d90652c Mon Sep 17 00:00:00 2001 From: ewilly Date: Fri, 14 Aug 2020 13:25:58 +0200 Subject: [PATCH 09/13] Update --- conf/systemd.service | 2 +- scripts/install | 4 ++-- scripts/upgrade | 10 +++++----- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/conf/systemd.service b/conf/systemd.service index 283225c..8f9fe92 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -6,7 +6,7 @@ After=network-online.target Type=simple User=homeassistant WorkingDirectory=/home/homeassistant/.homeassistant -ExecStart=/opt/yunohost/homeassistant/bin/hass -c "/home/homeassistant/.homeassistant" --debug +ExecStart=/opt/yunohost/homeassistant/bin/hass -c "/home/homeassistant/.homeassistant" --verbose [Install] WantedBy=multi-user.target diff --git a/scripts/install b/scripts/install index badb5f0..2ec0832 100644 --- a/scripts/install +++ b/scripts/install @@ -60,9 +60,9 @@ exec_as $app -H -s /bin/bash -c " \ && echo 'activate the virtual environment' \ && source "$final_path/bin/activate" \ && echo 'install a required python package' \ - && pip install --upgrade wheel \ + && python3 -m pip install --upgrade wheel \ && echo 'install Home Assistant' \ - && pip install --upgrade $app==$VERSION \ + && pip3 install --upgrade $app==$VERSION \ " # set default configuration files diff --git a/scripts/upgrade b/scripts/upgrade index f525f5f..0c06c4b 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -50,15 +50,15 @@ ynh_systemd_action --service_name="$app@$app" --action=stop # installation in a virtual environment ynh_script_progression --message="Installing Home Assistant in a virtual environment..." -exec_as "$app" -H -s /bin/bash -c " \ +exec_as $app -H -s /bin/bash -c " \ echo 'create the virtual environment' \ - && python3 -m venv $final_path \ + && python3 -m venv "$final_path" \ && echo 'activate the virtual environment' \ - && source $final_path/bin/activate \ + && source "$final_path/bin/activate" \ && echo 'install a required python package' \ - && pip install --upgrade wheel \ + && python3 -m pip install --upgrade wheel \ && echo 'install Home Assistant' \ - && pip install --upgrade $app==$VERSION \ + && pip3 install --upgrade $app==$VERSION \ " # setup up systemd service From e508881b4806bb070e91866f2d0cfc4184d444c1 Mon Sep 17 00:00:00 2001 From: ewilly Date: Fri, 14 Aug 2020 14:26:27 +0200 Subject: [PATCH 10/13] Remove verbose mode after first start --- scripts/install | 4 ++++ scripts/upgrade | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/scripts/install b/scripts/install index 2ec0832..2973c62 100644 --- a/scripts/install +++ b/scripts/install @@ -82,6 +82,10 @@ yunohost service add "$app@$app" --log "$data_path/home-assistant.log" --descrip # start systemd service ynh_script_progression --message="Starting the Home Assistant server..." ynh_systemd_action --service_name="$app@$app" --action=start --line_match="Home Assistant initialized" --log_path="systemd" --timeout=1000 +# remove --verbose from service +ynh_replace_string " --verbose" "" "/etc/systemd/system/$app@$app.service" +systemctl daemon-reload +ynh_systemd_action --service_name="$app@$app" --action=restart # create a dedicated nginx config ynh_script_progression --message="Configuring nginx web server..." diff --git a/scripts/upgrade b/scripts/upgrade index 0c06c4b..b89c493 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -68,6 +68,10 @@ ynh_add_systemd_config --service="$app@$app" # start systemd service ynh_script_progression --message="Starting the Home Assistant server..." ynh_systemd_action --service_name="$app@$app" --action=start --line_match="Home Assistant initialized" --log_path="systemd" --timeout=1000 +# remove --verbose from service +ynh_replace_string " --verbose" "" "/etc/systemd/system/$app@$app.service" +systemctl daemon-reload +ynh_systemd_action --service_name="$app@$app" --action=restart # create a dedicated nginx config ynh_script_progression --message="Configuring nginx web server..." From 73792363efe98f0baacfc5421f9e8d76113234f9 Mon Sep 17 00:00:00 2001 From: ewilly Date: Fri, 14 Aug 2020 16:22:51 +0200 Subject: [PATCH 11/13] Update manifest --- manifest.json | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/manifest.json b/manifest.json index 9fa81e4..5f4267b 100644 --- a/manifest.json +++ b/manifest.json @@ -14,7 +14,7 @@ "email": "ewilly@ewilly.fr" }, "requirements": { - "yunohost": ">= 3.7" + "yunohost": ">= 4.0" }, "multi_instance": false, "services": [ @@ -29,7 +29,11 @@ "en": "Choose a domain for Home Assistant", "fr": "Choisissez un domaine pour Home Assistant" }, - "example": "domain.org" + "help": { + "en": "Installation in a path is not possible", + "fr": "L'installation sous un chemin de domaine n'est pas possible" + }, + "example": "domain.org or homeassistant.domain.org" }, { "name": "is_public", From 7c63a8802813ec6ea259cc3623be4ba443863417 Mon Sep 17 00:00:00 2001 From: ewilly Date: Fri, 14 Aug 2020 16:28:27 +0200 Subject: [PATCH 12/13] Update Readme --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index b3e155c..0b4b862 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,3 @@ Home Assistant is a home automation platform running on Python 3. It is able to ## Links * [Home Assistant website](https://www.home-assistant.io/) * [Home Assistant git repository](https://github.com/home-assistant/home-assistant) - -## Versions -Python 3.5 support is deprecated in the first release oh Home Assitant after August 1 (0.97). Yunohost provide python 3.5 (based on debian stretch). According to that, the latest compatible version with yunohost is 0.96.5. As soon as yunohost is compatible with debian buster, scripts will be updated to provide the latest version of Home Assistant. From c6629f129d790cb984b8eae67a036384839d1ead Mon Sep 17 00:00:00 2001 From: ewilly Date: Fri, 14 Aug 2020 22:09:32 +0200 Subject: [PATCH 13/13] Fix restore --- scripts/restore | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/restore b/scripts/restore index 02b6fb0..c60fa29 100644 --- a/scripts/restore +++ b/scripts/restore @@ -53,8 +53,8 @@ ynh_exec_fully_quiet yunohost firewall allow TCP $port # add service in admin panel yunohost service add "$app@$app" --log "$data_path/home-assistant.log" --description "Home Assistant server" -# enable & restart systemd service -ynh_systemd_action --service_name="$app@$app" --action=start --line_match="Home Assistant initialized" --log_path="systemd" --timeout=1000 +# start systemd service +ynh_systemd_action --service_name="$app@$app" --action=start # reload nginx ynh_systemd_action --service_name=nginx --action=reload