Openbsd startupscript

[pascalnl]

I'm trying to use this startup script for openbsd and HA core.
The proces of starting is the same. Set up virtual env. Activate, Change to HA user. Start bin/Hass.

When running the script I get:
router# ./homeassistant
./homeassistant: daemon is not set

I don't understand. Is this the path to the executable in my case /usr/local/homeassistant/bin/hass or something specific for the NAS?

In the script the virtual env is setup as pre_cmd. So the command to start should be bin/hass. What am I missing?

[tprelog]

Hi @pascalnl

I'm not really familiar with any BSD outside of using the plugins on TrueNAS CORE, hopefully I can still help.

The proces of starting is the same. Set up virtual env. Activate, Change to HA user. Start bin/Hass

So, is it correct to assume you can manually start HA as you stated?

./homeassistant: daemon is not set - Is not an error I have seen before. The main command of my startup script is copied from other I've seen, that run software using FreeBSD daemon - This is not exactly the same as starting Home Assistant from an activated virtualenv. I guess the first thing is, does openbsd include the same daemon program as FreeBSD?

Is this the path to the executable in my case /usr/local/homeassistant/bin/hass or something specific for the NAS?

In the script the virtual env is setup as pre_cmd. So the command to start should be bin/hass. What am I missing?

I don't think your missing anything, at least sounds like you get how it should work. Just to be sure. I'll say this anyways

The path to the virtualenv was suggested by others, I'm not sure if it's specific to anything. In this startup script, you can set any path to your virtualenv. The default is /usr/local/share/homeassistant - so the executable would be /usr/local/share/homeassistant/bin/hass

If you want to change the virtualenv, you may be able to quickly do so, without editing the file

sysrc homeassistant_venv="/path/to/virtualenv"

The script looks inside the virtualenv for /bin/hass - in other words ${homeassistant_venv}/bin/hass

---

The script only uses daemon to run Home Assistant -- What happens if try something beside start, like

service homeassistant check_config

[pascalnl]

Dear Troy @tprelog

Thank you for your help.

Well, to openbsd I'm pretty new myself. Coming from debian derivatives.
It's nice you supplied the link to the Freebsd's "daemon".

I thought you had to specify "the daemon" or something.

Your questions:
No 1: yes, I have to start it manually, no startup script yet
No 2: no, in openbsd it would be "rcctl".

And maybe it would be as simple to substitute

command = /usr/sbin/rcctl

Unfortunately it isn't. I have to plow threw the docs. Maybe I can figure it out. But not now. When I've time to spare.

I'll get back to you, with failure or succes. Hopefully the last.

Pascal.

[tprelog]

I've removed the FreeBSD daemon. At your convenience, please give the following startup script a try

#!/bin/sh
#
# PROVIDE: homeassistant
# REQUIRE: LOGIN
# KEYWORD: shutdown
#
# VERSION: 20210812.rc
#
# homeassistant_enable: Enable the Home Assistant Core service.
#       Default: "NO"
#       Enable:  sysrc homeassistant_enable="YES"
#       Reset:   sysrc -x homeassistant_enable
#
# homeassistant_user: The user account used to run the homeassistant daemon.
#       Default:  "homeassistant"
#
# homeassistant_group: The group account used to run the homeassistant daemon.
#       Default:  The primary group of the ${homeassistant_user}
#
# homeassistant_user_dir: Path to directory, where ".cache/pip" will be located. This may also be the
#       location for the user's files and ${homeassistant_config_dir}.
#       Default:  The HOME directory for the ${homeassistant_user}
#       Alternate:  If HOME is not set or does not exist -- ${homeassistant_venv}
#
# homeassistant_config_dir: Path to directory, where the Home Assistant "configuration.yaml" is located.
#       Default:  ${homeassistant_user_dir}/.homeassistant"
#       Alternate: If HOME is not set or does not exist -- "/usr/local/etc/homeassistant"
#
# homeassistant_venv: Path to directory, where the Home Assistant Core virtualenv is located or will be created.
#       https://github.com/home-assistant/architecture/blob/master/adr/0016-home-assistant-core.md
#       Default:  "/usr/local/share/homeassistant"
#
# homeassistant_python: Set a supported version of Python to be used when creating the virtualenv for Home Assistant Core.
#       https://github.com/home-assistant/architecture/blob/master/adr/0016-home-assistant-core.md#supported-python-versions
#       After changing the Python version, you must recreate the virtualenv for the updated version to take effect.
#       Default:  "python3.8"
#

name=homeassistant
rcvar=${name}_enable

. /etc/rc.subr && load_rc_config ${name}

: "${homeassistant_enable:="NO"}"
: "${homeassistant_rc_debug:="NO"}"
: "${homeassistant_user:="homeassistant"}"
: "${homeassistant_python:="python3.8"}"
: "${homeassistant_venv:="/usr/local/share/homeassistant"}"

if [ ! "$(id ${homeassistant_user} 2>/dev/null)" ]; then
  err 1 "user not found: ${homeassistant_user}"
else
  : "${homeassistant_group:="$(id -gn ${homeassistant_user})"}"
  HOME="$(getent passwd "${homeassistant_user}" | cut -d: -f6)"
fi

if [ -z "${HOME}" ] || [ ! -d "${HOME}" ] || [ "${HOME}" == "/nonexistent" ] || [ "${HOME}" == "/var/empty" ]; then
  : "${homeassistant_config_dir:="/usr/local/etc/${name}"}"
  : "${homeassistant_user_dir:="${homeassistant_venv}"}"
  export HOME="${homeassistant_user_dir}"
else
  : "${homeassistant_user_dir:="${HOME}"}"
  : "${homeassistant_config_dir:="${homeassistant_user_dir}/.${name}"}"
fi

[ -n "${homeassistant_cpath:-}" ] && export CPATH="${homeassistant_cpath}"
[ -n "${homeassistant_library_path:-}" ] && export LIBRARY_PATH="${homeassistant_library_path}"
[ -n "${homeassistant_path:-}" ] && export PATH="${homeassistant_path}"

umask "${homeassistant_umask:-022}"

pidfile="/var/run/${name}.pid"
command="${homeassistant_venv}/bin/${homeassistant_python}"
extra_commands="check_config ensure_config upgrade install reinstall script test"

homeassistant_precmd() {
  local _srv_ _own_ _msg_
  local _venv_="${homeassistant_venv}"
  local _user_="${homeassistant_user}"
  if [ ! -d "${_venv_}" ]; then
    _msg_="${_venv_} not found"
  elif [ ! -f "${_venv_}/bin/activate" ]; then
    _msg_="${_venv_}/bin/activate is not found"
  elif [ ! -x "${_srv_:="${_venv_}/bin/hass"}" ]; then
    _msg_="${_srv_} is not found or is not executable"
  elif [ "${_own_:="$(stat -f '%Su' ${_srv_})"}" != ${_user_} ]; then
    warn "${_srv_} is not owned by ${_user_}"
    _msg_="${_srv_} is currently owned by ${_own_}"
  else
    HA_CMD="${_srv_}"
    cd "${_venv_}" || err 1 "cd ${_venv_}"
    return 0
  fi
  err 1 "${_msg_}"
}

start_precmd=${name}_prestart
homeassistant_prestart() {
  homeassistant_precmd
  echo "9999" > "${pidfile}" && chown "${homeassistant_user}:${homeassistant_group}" "${pidfile}"
  homeassistant_ensure_config "${homeassistant_config_dir}"
  HA_ARGS="--config ${homeassistant_config_dir}"
  if [ -n "${homeassistant_log_file:-}" ]; then
    install -g "${homeassistant_group}" -m 664 -o ${homeassistant_user} -- /dev/null "${homeassistant_log_file}" \
    && HA_ARGS="${HA_ARGS} --log-file ${homeassistant_log_file}"
  fi
  if [ -n "${homeassistant_log_rotate_days:-}" ]; then
    HA_ARGS="${HA_ARGS} --log-rotate-days ${homeassistant_log_rotate_days}"
  fi
}

start_cmd="${name}_start"
homeassistant_start() {
  echo -e "\nActivating virtualenv...\n"
  # shellcheck disable=SC2016
  su - "${homeassistant_user}" -c '
    echo -e "  $(pwd)\n"
    source ${1}/bin/activate
    echo "  $(python --version)"
    echo "  Home Assistant $(pip show homeassistant | grep Version | cut -d" " -f2)"
    echo -e "\nStarting..."
    ${2} -v ${3} --pid-file ${4} --daemon
  ' _ ${homeassistant_venv} "${HA_CMD}" "${HA_ARGS}" "${pidfile}"
}

start_postcmd=${name}_poststart
homeassistant_poststart() {
  sleep 1 ; run_rc_command status
}

restart_precmd="${name}_prerestart"
homeassistant_prerestart() {
  homeassistant_check_config "${homeassistant_config_dir}"
}

stop_precmd=${name}_prestop
homeassistant_prestop() {
  local _owner_
  # shellcheck disable=SC2154
  if [ -n "${rc_pid}" ] && [ "${_owner_:="$(stat -f '%Su' ${pidfile})"}" != ${homeassistant_user} ]; then
    err 1 "${homeassistant_user} can not stop a process owned by ${_owner_}"
  fi
}

stop_postcmd=${name}_poststop
homeassistant_poststop() {
  rm -f -- "${pidfile}"
}

status_cmd=${name}_status
homeassistant_status() {
  local _http_ _ip_
  if [ -n "${rc_pid}" ]; then
    : "${homeassistant_secure:="NO"}" # This is only a cosmetic variable - used by the status_cmd
    _ip_="$(ifconfig | sed -En 's/127.0.0.1//;s/.*inet (addr:)?(([0-9]*\.){3}[0-9]*).*/\2/p')"
    checkyesno homeassistant_secure && _http_="https" || _http_="http"
    echo "${name} is running as pid ${rc_pid}."
    echo "${_http_}://${_ip_}:${homeassistant_port:-"8123"}"  # This is only a cosmetic variable
  else
    echo "${name} is not running."
    return 1
  fi
}

check_config_cmd="${name}_check_config ${1} ${2}"
homeassistant_check_config() {
  [ "${1}" == "check_config" ] || [ "${1}" == "onecheck_config" ] && shift
  homeassistant_script check_config --config "${1:-"${homeassistant_config_dir}"}"
}

ensure_config_cmd="${name}_ensure_config ${1} ${2}"
homeassistant_ensure_config() {
  [ "${1}" == "ensure_config" ] || [ "${1}" == "oneensure_config" ] && shift
  local _config_dir_="${1:-"${homeassistant_config_dir}"}"
  debug "config_dir: ${_config_dir_}"
  if [ ! -d "${_config_dir_}" ]; then
    install -d -g "${homeassistant_group}" -m 775 -o ${homeassistant_user} -- "${_config_dir_}" \
    || err 1 "unable to create directory: ${_config_dir_}"
  fi
  homeassistant_script ensure_config --config "${_config_dir_}"
}

script_cmd="${name}_script ${*}"
homeassistant_script() {
  [ "${1}" == "script" ] || [ "${1}" == "onescript" ] && shift
  local _action_="${1}" ; shift
  local _args_="${*}"
  homeassistant_precmd
  # shellcheck disable=SC2016
  su - ${homeassistant_user} -c '
    source ${1}/bin/activate || exit 1
    hass --script ${2} ${3}
    deactivate
  ' _ ${homeassistant_venv} "${_action_}" "${_args_}"
}

upgrade_cmd="${name}_upgrade"
homeassistant_upgrade() {
  homeassistant_precmd
  run_rc_command stop 2>/dev/null ; local _rcstop_=${?}
  homeassistant_install --upgrade "${name}"
  homeassistant_check_config && [ ${_rcstop_} == 0 ] && run_rc_command start
}

install_cmd="${name}_install ${*}"
homeassistant_install() {
  [ "${1}" == "install" ] || [ "${1}" == "oneinstall" ] && shift
  local _create_ _arg_ _python_
  _arg_="${*:-"${name}"}"
  _python_="$(which ${homeassistant_python})"
  debug "install: ${_arg_}"
  if [ "${1}" == "${name}" ] && { [ ! -d "${homeassistant_venv}" ] || [ ! "$(ls -A ${homeassistant_venv})" ]; }; then
    debug "creating virtualenv: ${homeassistant_venv}"
    install -d -g "${homeassistant_group}" -m 775 -o ${homeassistant_user} -- ${homeassistant_venv} \
    || err 1 "failed to create directory: ${homeassistant_venv}"
    _create_="YES"
  elif [ -d "${homeassistant_venv}" ]; then
    debug "found existing directory: ${homeassistant_venv}"
    homeassistant_precmd
  else
    echo "failed to install: ${_arg_}"
    err 1 "${name} is not installed: ${homeassistant_venv}"
  fi
  # shellcheck disable=SC2016
  su - ${homeassistant_user} -c '
    if [ ${1} == "YES" ]; then
      ${2} -m venv ${3}
      source ${3}/bin/activate || exit 1
      shift 3
      pip install wheel
      pip install ${@}
    else
      source ${3}/bin/activate || exit 1
      shift 3
      pip install ${@}
    fi
    deactivate
  ' _ ${_create_:-"NO"} ${_python_} ${homeassistant_venv} "${_arg_}" || err 1 "install function failed"
}

reinstall_cmd="${name}_reinstall ${*}"
homeassistant_reinstall() {
  [ "${1}" == "reinstall" ] || [ "${1}" == "onereinstall" ] && shift
  local _ans1_ _ans2_ _rcstop_ _version_ _arg_
  homeassistant_precmd
  if [ "${1%==*}" == "${name}" ]; then
    _arg_="${*}"
  elif [ -z "${_arg_}" ]; then
    if [ -n "${_version_:=$(cat ${homeassistant_config_dir}/.HA_VERSION 2>/dev/null)}" ]; then
      _arg_="${name}==${_version_}"
    else
      _arg_="${name}"
    fi
  else
    warn "expecting ${name} to be listed first"
    err 1 "check args: ${*}"
  fi
  echo -e "\n${orn}You are about to recreate the virtualenv:${end}\n  ${homeassistant_venv}\n"
  echo -e "${orn}The following package(s) will be installed:${end}\n  ${_arg_}\n"
  read -rp " Type 'YES' to continue: " _ans1_
  run_rc_command stop 2>/dev/null ; _rcstop_=${?}
  cd / ; rm -r -- "${homeassistant_venv}" || err 1 "failed to remove ${homeassistant_venv}"
  { homeassistant_install ${_arg_} ; homeassistant_check_config ; } \
  && [ ${_rcstop_} == 0 ] && run_rc_command start
}

test_cmd="${name}_test"
homeassistant_test() {
  echo -e "\nTesting virtualenv...\n"
  homeassistant_precmd
  ## Switch users / activate virtualenv / run a command
  # shellcheck disable=SC2016
  su "${homeassistant_user}" -c '
    echo -e "  $(pwd)\n"
    source ${1}/bin/activate
    echo "  $(python --version)"
    echo "  Home Assistant $(pip show homeassistant | grep Version | cut -d" " -f2)"
    deactivate
  ' _ ${homeassistant_venv}
  echo
}

colors () {
  export red=$'\e[1;31m'
  export orn=$'\e[38;5;208m'
  export end=$'\e[0m'
} ; colors

checkyesno homeassistant_rc_debug && rc_debug="ON"
run_rc_command "${1}"