HomeAssistant_inabox

HomeAssistant_inabox

Docker app from SpaceInvaderOne's Repository

Overview

HomeAssistant_inabox downloads, installs, and automatically manages a Home Assistant VM on your Unraid server with a single click. If the VM is found to be unexpectedly stopped, the container will automatically restart it to ensure uninterrupted service. Once installed, clicking on this container's WebUI will redirect you directly to your Home Assistant VM's WebUI.

Container Variables

VM Name
Specify the desired name for the Home Assistant VM. --Default Home Assistant

VM Images Location
Set the path to where your VM images are stored

Appdata Location
Set the directory where HomeAssistant_inabox will store its appdata.

Keep VM Running
Choose Yes to automatically monitor if the Home Assistant VM is running. If it is found to be stopped, the container will attempt to restart the VM --Default Yes

Check Time
Specify how frequently (in minutes) to check if the Home Assistant VM is running.
Default: 15 minutes

HA_inabox WebUI Port
Port used by the container to access the Home Assistant WebUI --Default: 8123

Notes

  • During the VM installation, the container dynamically builds the XML template based on the current configuration.
  • It automatically detects the highest available QEMU machine type on the server and adjusts the VM template to use the optimal configuration.
  • For smooth operation, ensure that the VM storage and appdata paths are correctly set according to your Unraid shares.

Requirements

On your server make sure to have the VM service enabled. Optional have notifications enabled for HomeAssistant_inabox to send GUI messages during install.

Runtime arguments

Web UI
http://[IP]:[PORT:8123]
Network
bridge
Shell
sh
Privileged
true

Template configuration

VM NameVariable

Enter a different name if you want the VM to have a name other than the OS name. If left blank, the container will use the default OS name installed.

Target
VMNAME
Value
Home Assistant
Home Assistant URLVariable

page to scrape for download link

Target
CHECKURL
Default
https://www.home-assistant.io/installation/linux
Value
https://www.home-assistant.io/installation/linux
VM Images LocationPathrw

Please choose the storage location for your VM images on the server. The default path is set to /mnt/user/domains/

Target
/domains
Default
/mnt/user/domains/
Value
/mnt/user/domains/
Appdata Location:Pathrw

Please choose the storage location for your appdata The default path is set to /mnt/user/appdata/HomeAssistant_inabox/

Target
/config
Default
/mnt/user/appdata/HomeAssistant_inabox
Value
/mnt/user/appdata/HomeAssistant_inabox
Keep Vm RunningVariable

If VM should stop container will restart it. Ensures Home Assistant will keep running should VM stop

Target
RESTART
Default
Yes|No
Value
Yes
Check TimeVariable

Check if VM is running (default every 15 mins)

Target
CHECK
Default
15
Value
15
HA_inabox WebUI PortPorttcp
Target
8123
Default
8123
Value
8123
unraid_vm_iconsPathrw
Target
/icons
Value
/usr/local/emhttp/plugins/dynamix.vm.manager/templates/images
UNRAID /usr/lib64Pathrw

Used so container can use unraid notification system during Home Assistant VM creation process

Target
/host/usr/lib64
Default
/usr/lib64
Value
/usr/lib64
unraid vm icons host locactionPathrw

Location of where Unraid stores VM icons, aloowing container to use custom Home Assistant icon

Target
/unraid_vm_icons
Default
/usr/local/emhttp/plugins/dynamix.vm.manager/templates/images/
Value
/usr/local/emhttp/plugins/dynamix.vm.manager/templates/images/
NVRAM locationPathro

NVRAM location on host. Used so container can create a unique nvram file for the Home Assistant VM

Target
/etc/libvirt/qemu/nvram/
Default
/etc/libvirt/qemu/nvram/
Value
/etc/libvirt/qemu/nvram/
UNRIAD DOMAIN CONFIGPathrw

UNRAID domain.cfg path. Used to find VM Default network source

Target
/vm/domain.cfg
Default
/boot/config/domain.cfg
Value
/boot/config/domain.cfg
UNRAID /usr/libPathrw

Used so container can use unraid notification system during Home Assistant VM creation process

Target
/host/usr/lib
Default
/usr/lib
Value
/usr/lib
UNRAID /lib64Pathrw

Used so container can use unraid notification system during Home Assistant VM creation process

Target
/host/lib64
Default
/lib64
Value
/lib64
UNRAID /usr/local/emhttp/webGui/scripts/Pathrw

Used so container can use unraid notification system during Home Assistant VM creation process

Target
/host/usr/local/emhttp/webGui/scripts/
Default
/usr/local/emhttp/webGui/scripts/
Value
/usr/local/emhttp/webGui/scripts/
UNRAID /usr/local/emhttp/webGui/include/Pathrw

Used so container can use unraid notification system during Home Assistant VM creation process

Target
/host/usr/local/emhttp/webGui/include/
Default
/usr/local/emhttp/webGui/include/
Value
/usr/local/emhttp/webGui/include/
UNRAID /tmp/notificationsPathrw

Used so container can use unraid notification system during Home Assistant VM creation process

Target
/host/tmp/notifications
Default
/tmp/notifications
Value
/tmp/notifications
UNRAID /boot/config/plugins/dynamix/Pathrw

Used so container can use unraid notification system during Home Assistant VM creation process

Target
/host/boot/config/plugins/dynamix/
Default
/boot/config/plugins/dynamix/
Value
/boot/config/plugins/dynamix/
LIBVIRT LocationPathrw

LIBVIRT Location on host. Used so container can define the Home Assistant VM

Target
/var/run/libvirt
Default
/var/run/libvirt
Value
/var/run/libvirt
UNRAID /usr/binPathrw

Used so container can use unraid notification system during Home Assistant VM creation process

Target
/host/usr/bin
Value
/usr/bin
UNRAID /libPathrw

Used so container can use unraid notification system during Home Assistant VM creation process

Target
/host/lib
Default
/lib
Value
/lib
UNRAID docker.sockPathrw

UNRAID docker.sock. Used so container can use docker inspect to workout true locations of mapped locations to create the xml used to define the Home Assistant VM

Target
/var/run/docker.sock
Default
/var/run/docker.sock
Value
/var/run/docker.sock
HA_inabox versionVariable

template evrsion of container. used to check template is correct version for version of software

Target
WHATVERSION
Default
2
Value
2

Download Statistics

76,167
Total Downloads
5,804
This Month
5,070
Avg / Month

Total Downloads Over Time

Loading chart...

Details

Repository
spaceinvaderone/ha_inabox:latest
Last Updated2024-10-02
First Seen2024-09-29

Run HomeAssistant_inabox on Unraid.

HomeAssistant_inabox is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.