Start Home Assistant CLI on tty1 without login (#1366)

* Start ha-cli on tty1 instead of a getty Instead of starting a getty start the ha-cli directly. This will show the banner right on startup with the important information such as IP address of the instance or the URL to reach it. * Use default shell as root shell instead of HA CLI Instead of using the ha-cli.sh script as login shell use the regular shell. Amongst other things, this allows to run VS Code devcontainers remotely via SSH or using scp. The HA CLI is still available using the `ha` command.
2025-07-24 13:36:31 +00:00 · 2021-05-19 13:18:02 +02:00 · 2021-05-19 13:18:02 +02:00 · 40b4d5ca2e
commit 40b4d5ca2e
parent 25d1f5d7d1
20 changed files with 59 additions and 57 deletions
--- a/buildroot-external/configs/generic_x86_64_defconfig
+++ b/buildroot-external/configs/generic_x86_64_defconfig
@ -14,7 +14,6 @@ BR2_GCC_ENABLE_LTO=y
 BR2_TARGET_GENERIC_HOSTNAME="homeassistant"
 BR2_TARGET_GENERIC_ISSUE="Welcome to Home Assistant"
 BR2_INIT_SYSTEMD=y
-BR2_TARGET_GENERIC_GETTY_PORT="tty1"
 # BR2_TARGET_GENERIC_REMOUNT_ROOTFS_RW is not set
 BR2_ROOTFS_OVERLAY="$(BR2_EXTERNAL_HASSOS_PATH)/rootfs-overlay"
 BR2_ROOTFS_POST_BUILD_SCRIPT="$(BR2_EXTERNAL_HASSOS_PATH)/scripts/post-build.sh"
--- a/buildroot-external/configs/odroid_c2_defconfig
+++ b/buildroot-external/configs/odroid_c2_defconfig
@ -14,7 +14,6 @@ BR2_GCC_ENABLE_LTO=y
 BR2_TARGET_GENERIC_HOSTNAME="homeassistant"
 BR2_TARGET_GENERIC_ISSUE="Welcome to Home Assistant"
 BR2_INIT_SYSTEMD=y
-BR2_TARGET_GENERIC_GETTY_PORT="tty1"
 # BR2_TARGET_GENERIC_REMOUNT_ROOTFS_RW is not set
 BR2_ROOTFS_OVERLAY="$(BR2_EXTERNAL_HASSOS_PATH)/rootfs-overlay"
 BR2_ROOTFS_POST_BUILD_SCRIPT="$(BR2_EXTERNAL_HASSOS_PATH)/scripts/post-build.sh"
--- a/buildroot-external/configs/odroid_c4_defconfig
+++ b/buildroot-external/configs/odroid_c4_defconfig
@ -14,7 +14,6 @@ BR2_GCC_ENABLE_LTO=y
 BR2_TARGET_GENERIC_HOSTNAME="homeassistant"
 BR2_TARGET_GENERIC_ISSUE="Welcome to Home Assistant"
 BR2_INIT_SYSTEMD=y
-BR2_TARGET_GENERIC_GETTY_PORT="tty1"
 # BR2_TARGET_GENERIC_REMOUNT_ROOTFS_RW is not set
 BR2_ROOTFS_OVERLAY="$(BR2_EXTERNAL_HASSOS_PATH)/rootfs-overlay"
 BR2_ROOTFS_POST_BUILD_SCRIPT="$(BR2_EXTERNAL_HASSOS_PATH)/scripts/post-build.sh"
--- a/buildroot-external/configs/odroid_n2_defconfig
+++ b/buildroot-external/configs/odroid_n2_defconfig
@ -14,7 +14,6 @@ BR2_GCC_ENABLE_LTO=y
 BR2_TARGET_GENERIC_HOSTNAME="homeassistant"
 BR2_TARGET_GENERIC_ISSUE="Welcome to Home Assistant"
 BR2_INIT_SYSTEMD=y
-BR2_TARGET_GENERIC_GETTY_PORT="tty1"
 # BR2_TARGET_GENERIC_REMOUNT_ROOTFS_RW is not set
 BR2_ROOTFS_OVERLAY="$(BR2_EXTERNAL_HASSOS_PATH)/rootfs-overlay"
 BR2_ROOTFS_POST_BUILD_SCRIPT="$(BR2_EXTERNAL_HASSOS_PATH)/scripts/post-build.sh"
--- a/buildroot-external/configs/odroid_xu4_defconfig
+++ b/buildroot-external/configs/odroid_xu4_defconfig
@ -15,7 +15,6 @@ BR2_GCC_ENABLE_LTO=y
 BR2_TARGET_GENERIC_HOSTNAME="homeassistant"
 BR2_TARGET_GENERIC_ISSUE="Welcome to Home Assistant"
 BR2_INIT_SYSTEMD=y
-BR2_TARGET_GENERIC_GETTY_PORT="tty1"
 # BR2_TARGET_GENERIC_REMOUNT_ROOTFS_RW is not set
 BR2_ROOTFS_OVERLAY="$(BR2_EXTERNAL_HASSOS_PATH)/rootfs-overlay"
 BR2_ROOTFS_POST_BUILD_SCRIPT="$(BR2_EXTERNAL_HASSOS_PATH)/scripts/post-build.sh"
--- a/buildroot-external/configs/ova_defconfig
+++ b/buildroot-external/configs/ova_defconfig
@ -15,7 +15,6 @@ BR2_TARGET_GENERIC_HOSTNAME="homeassistant"
 BR2_TARGET_GENERIC_ISSUE="Welcome to Home Assistant"
 BR2_INIT_SYSTEMD=y
 BR2_TARGET_GENERIC_GETTY=y
-BR2_TARGET_GENERIC_GETTY_PORT="tty1"
 # BR2_TARGET_GENERIC_REMOUNT_ROOTFS_RW is not set
 BR2_ROOTFS_OVERLAY="$(BR2_EXTERNAL_HASSOS_PATH)/rootfs-overlay"
 BR2_ROOTFS_POST_BUILD_SCRIPT="$(BR2_EXTERNAL_HASSOS_PATH)/scripts/post-build.sh"
--- a/buildroot-external/configs/rpi0_w_defconfig
+++ b/buildroot-external/configs/rpi0_w_defconfig
@ -16,7 +16,6 @@ BR2_GCC_ENABLE_LTO=y
 BR2_TARGET_GENERIC_HOSTNAME="homeassistant"
 BR2_TARGET_GENERIC_ISSUE="Welcome to Home Assistant"
 BR2_INIT_SYSTEMD=y
-BR2_TARGET_GENERIC_GETTY_PORT="tty1"
 # BR2_TARGET_GENERIC_REMOUNT_ROOTFS_RW is not set
 BR2_ROOTFS_OVERLAY="$(BR2_EXTERNAL_HASSOS_PATH)/rootfs-overlay $(BR2_EXTERNAL_HASSOS_PATH)/board/raspberrypi/rootfs-overlay"
 BR2_ROOTFS_POST_BUILD_SCRIPT="$(BR2_EXTERNAL_HASSOS_PATH)/scripts/post-build.sh"
--- a/buildroot-external/configs/rpi2_defconfig
+++ b/buildroot-external/configs/rpi2_defconfig
@ -16,7 +16,6 @@ BR2_GCC_ENABLE_LTO=y
 BR2_TARGET_GENERIC_HOSTNAME="homeassistant"
 BR2_TARGET_GENERIC_ISSUE="Welcome to Home Assistant"
 BR2_INIT_SYSTEMD=y
-BR2_TARGET_GENERIC_GETTY_PORT="tty1"
 # BR2_TARGET_GENERIC_REMOUNT_ROOTFS_RW is not set
 BR2_ROOTFS_OVERLAY="$(BR2_EXTERNAL_HASSOS_PATH)/rootfs-overlay $(BR2_EXTERNAL_HASSOS_PATH)/board/raspberrypi/rootfs-overlay"
 BR2_ROOTFS_POST_BUILD_SCRIPT="$(BR2_EXTERNAL_HASSOS_PATH)/scripts/post-build.sh"
--- a/buildroot-external/configs/rpi3_64_defconfig
+++ b/buildroot-external/configs/rpi3_64_defconfig
@ -16,7 +16,6 @@ BR2_GCC_ENABLE_LTO=y
 BR2_TARGET_GENERIC_HOSTNAME="homeassistant"
 BR2_TARGET_GENERIC_ISSUE="Welcome to Home Assistant"
 BR2_INIT_SYSTEMD=y
-BR2_TARGET_GENERIC_GETTY_PORT="tty1"
 # BR2_TARGET_GENERIC_REMOUNT_ROOTFS_RW is not set
 BR2_ROOTFS_OVERLAY="$(BR2_EXTERNAL_HASSOS_PATH)/rootfs-overlay $(BR2_EXTERNAL_HASSOS_PATH)/board/raspberrypi/rootfs-overlay"
 BR2_ROOTFS_POST_BUILD_SCRIPT="$(BR2_EXTERNAL_HASSOS_PATH)/scripts/post-build.sh"
--- a/buildroot-external/configs/rpi3_defconfig
+++ b/buildroot-external/configs/rpi3_defconfig
@ -16,7 +16,6 @@ BR2_GCC_ENABLE_LTO=y
 BR2_TARGET_GENERIC_HOSTNAME="homeassistant"
 BR2_TARGET_GENERIC_ISSUE="Welcome to Home Assistant"
 BR2_INIT_SYSTEMD=y
-BR2_TARGET_GENERIC_GETTY_PORT="tty1"
 # BR2_TARGET_GENERIC_REMOUNT_ROOTFS_RW is not set
 BR2_ROOTFS_OVERLAY="$(BR2_EXTERNAL_HASSOS_PATH)/rootfs-overlay $(BR2_EXTERNAL_HASSOS_PATH)/board/raspberrypi/rootfs-overlay"
 BR2_ROOTFS_POST_BUILD_SCRIPT="$(BR2_EXTERNAL_HASSOS_PATH)/scripts/post-build.sh"
--- a/buildroot-external/configs/rpi4_64_defconfig
+++ b/buildroot-external/configs/rpi4_64_defconfig
@ -16,7 +16,6 @@ BR2_GCC_ENABLE_LTO=y
 BR2_TARGET_GENERIC_HOSTNAME="homeassistant"
 BR2_TARGET_GENERIC_ISSUE="Welcome to Home Assistant"
 BR2_INIT_SYSTEMD=y
-BR2_TARGET_GENERIC_GETTY_PORT="tty1"
 # BR2_TARGET_GENERIC_REMOUNT_ROOTFS_RW is not set
 BR2_ROOTFS_OVERLAY="$(BR2_EXTERNAL_HASSOS_PATH)/rootfs-overlay $(BR2_EXTERNAL_HASSOS_PATH)/board/raspberrypi/rootfs-overlay"
 BR2_ROOTFS_POST_BUILD_SCRIPT="$(BR2_EXTERNAL_HASSOS_PATH)/scripts/post-build.sh"
--- a/buildroot-external/configs/rpi4_defconfig
+++ b/buildroot-external/configs/rpi4_defconfig
@ -16,7 +16,6 @@ BR2_GCC_ENABLE_LTO=y
 BR2_TARGET_GENERIC_HOSTNAME="homeassistant"
 BR2_TARGET_GENERIC_ISSUE="Welcome to Home Assistant"
 BR2_INIT_SYSTEMD=y
-BR2_TARGET_GENERIC_GETTY_PORT="tty1"
 # BR2_TARGET_GENERIC_REMOUNT_ROOTFS_RW is not set
 BR2_ROOTFS_OVERLAY="$(BR2_EXTERNAL_HASSOS_PATH)/rootfs-overlay $(BR2_EXTERNAL_HASSOS_PATH)/board/raspberrypi/rootfs-overlay"
 BR2_ROOTFS_POST_BUILD_SCRIPT="$(BR2_EXTERNAL_HASSOS_PATH)/scripts/post-build.sh"
--- a/buildroot-external/configs/rpi_defconfig
+++ b/buildroot-external/configs/rpi_defconfig
@ -16,7 +16,6 @@ BR2_GCC_ENABLE_LTO=y
 BR2_TARGET_GENERIC_HOSTNAME="homeassistant"
 BR2_TARGET_GENERIC_ISSUE="Welcome to Home Assistant"
 BR2_INIT_SYSTEMD=y
-BR2_TARGET_GENERIC_GETTY_PORT="tty1"
 # BR2_TARGET_GENERIC_REMOUNT_ROOTFS_RW is not set
 BR2_ROOTFS_OVERLAY="$(BR2_EXTERNAL_HASSOS_PATH)/rootfs-overlay $(BR2_EXTERNAL_HASSOS_PATH)/board/raspberrypi/rootfs-overlay"
 BR2_ROOTFS_POST_BUILD_SCRIPT="$(BR2_EXTERNAL_HASSOS_PATH)/scripts/post-build.sh"
--- a/buildroot-external/configs/tinker_defconfig
+++ b/buildroot-external/configs/tinker_defconfig
@ -16,7 +16,6 @@ BR2_GCC_ENABLE_LTO=y
 BR2_TARGET_GENERIC_HOSTNAME="homeassistant"
 BR2_TARGET_GENERIC_ISSUE="Welcome to Home Assistant"
 BR2_INIT_SYSTEMD=y
-BR2_TARGET_GENERIC_GETTY_PORT="tty1"
 # BR2_TARGET_GENERIC_REMOUNT_ROOTFS_RW is not set
 BR2_ROOTFS_OVERLAY="$(BR2_EXTERNAL_HASSOS_PATH)/rootfs-overlay"
 BR2_ROOTFS_POST_BUILD_SCRIPT="$(BR2_EXTERNAL_HASSOS_PATH)/scripts/post-build.sh"
--- a/buildroot-external/rootfs-overlay/etc/systemd/system/getty@.service.d/hassos.conf
+++ b/buildroot-external/rootfs-overlay/etc/systemd/system/getty@.service.d/hassos.conf
@ -1,3 +0,0 @@
-[Unit]
-Wants=hassos-supervisor.service
-After=hassos-supervisor.service
--- a/buildroot-external/rootfs-overlay/usr/lib/systemd/system/ha-cli@.service
+++ b/buildroot-external/rootfs-overlay/usr/lib/systemd/system/ha-cli@.service
@ -0,0 +1,41 @@
+[Unit]
+Description=Home Assistant CLI
+Wants=hassos-supervisor.service
+After=systemd-user-sessions.service plymouth-quit-wait.service getty-pre.target hassos-supervisor.service
+Conflicts=getty@%i.service
+
+# If additional gettys are spawned during boot then we should make
+# sure that this is synchronized before getty.target, even though
+# getty.target didn't actually pull it in.
+Before=getty.target
+IgnoreOnIsolate=yes
+
+# IgnoreOnIsolate causes issues with sulogin, if someone isolates
+# rescue.target or starts rescue.service from multi-user.target or
+# graphical.target.
+Conflicts=rescue.service
+Before=rescue.service
+
+[Service]
+# the VT is cleared by TTYVTDisallocate
+# The '-o' option value tells agetty to replace 'login' arguments with an
+# option to preserve environment (-p), followed by '--' for safety, and then
+# the entered username.
+ExecStart=/usr/sbin/hassos-cli
+RemainAfterExit=yes
+Type=idle
+Restart=always
+RestartSec=0
+UtmpIdentifier=%I
+TTYPath=/dev/%I
+TTYReset=yes
+TTYVHangup=yes
+TTYVTDisallocate=yes
+IgnoreSIGPIPE=no
+SendSIGHUP=yes
+StandardInput=tty-force
+StandardOutput=inherit
+StandardError=inherit
+
+[Install]
+WantedBy=multi-user.target
--- a/buildroot-external/rootfs-overlay/usr/lib/systemd/system/ha-cli@.service.d/haos.conf
+++ b/buildroot-external/rootfs-overlay/usr/lib/systemd/system/ha-cli@.service.d/haos.conf
@ -0,0 +1,2 @@
+[Install]
+DefaultInstance=tty1
--- a/buildroot-external/rootfs-overlay/usr/sbin/hassos-cli
+++ b/buildroot-external/rootfs-overlay/usr/sbin/hassos-cli
@ -3,35 +3,23 @@
 # Run logging cli
 # ==============================================================================

-# Setup terminal size on serial console
-if [ "${TERM}" = "vt220" ] || [ "${TERM}" = "vt102" ] || \
-   [ "${TERM}" = "vt100" ]; then
-	resize
-fi
+echo "Waiting for the Home Assistant CLI to be ready..."

-if [ "$(systemctl is-active default.target)" != "active" ]; then
-    echo "[INFO] System not in default.target! Jump into emergency console..."
-    exec /bin/ash -l
-fi
-
-if [ ! "$(findmnt /mnt/data)" ]; then
-    echo "[WARN] Data partition not mounted! Jump into emergency console..."
-    exec /bin/ash -l
-fi
-
-# Run CLI container
-if [ "$(docker ps -q -f name=hassio_cli)" ]; then
-    docker container exec \
-        -ti hassio_cli \
-        /usr/bin/cli.sh \
-
-    # Jump to root login shell
-    if [ $? -eq 10 ]; then
-        /bin/ash -l
+i=0
+while [ ! "$(docker ps -q -f name=hassio_cli)" ]; do
+    sleep 1
+    i=$((i+1))
+    if [ $i = 60 ]; then
+        echo "[WARN] Home Assistant CLI not starting! Jump into emergency console..."
+        exec /bin/ash -l
    fi
-else
-    echo "[WARN] Home Assistant CLI is not running! Jump into emergency console..."
+done
+
+docker container exec \
+    -ti hassio_cli \
+    /usr/bin/cli.sh
+
+# Jump to root login shell
+if [ $? -eq 10 ]; then
    exec /bin/ash -l
 fi
-
-exit
--- a/buildroot-external/scripts/post-build.sh
+++ b/buildroot-external/scripts/post-build.sh
@ -16,7 +16,6 @@ BOARD_DIR=${2}
 # HassOS tasks
 fix_rootfs
 install_tini_docker
-install_hassos_cli

 # Write os-release
 # shellcheck disable=SC2153
--- a/buildroot-external/scripts/rootfs-layer.sh
+++ b/buildroot-external/scripts/rootfs-layer.sh
@ -37,17 +37,6 @@ function fix_rootfs() {
 }


-function install_hassos_cli() {
-
-    # shellcheck disable=SC1117
-    sed -i "s|\(root:.*\)/bin/sh|\1/usr/sbin/hassos-cli|" "${TARGET_DIR}/etc/passwd"
-    
-    if ! grep "hassos-cli" "${TARGET_DIR}/etc/shells"; then
-        echo "/usr/sbin/hassos-cli" >> "${TARGET_DIR}/etc/shells"
-    fi
-}
-
-
 function install_tini_docker() {
    ln -fs /usr/bin/tini "${TARGET_DIR}/usr/bin/docker-init"
 }