Home Assistant (Deprecated)
Home Assistant is an open source home automation that puts local control and privacy first.
- 1Copy the script below
- 2In HexOS, open Apps, find Home Assistant (Deprecated) and choose Custom Install
- 3Paste, then press Install — full guide with screenshots
1{
12 "version": 5,
23 "script": {
4 "version": "0.1.0",
5 "changeLog": "Auto-generated draft from TrueNAS home-assistant 1.8.67"
6 },
7 "requirements": {
38 "locations": ["ApplicationsPerformance", "Media"],
49 "specifications": ["2CORE"],
510 "permissions": ["READ_WRITE_LOCATIONS"],
611 "ports": [30103]
12 },
713 "ensure_directories_exists": [
14 {"path": "$LOCATION(ApplicationsPerformance)"},
15 {"path": "$LOCATION(ApplicationsPerformance)/home-assistant"},
16 {"path": "$LOCATION(Media)", "network_share": true},
17 {
18 "path": "$LOCATION(ApplicationsPerformance)/home-assistant/config",
19 "snapshot": {"id": "config"}
20 },
21 {
22 "path": "$LOCATION(ApplicationsPerformance)/home-assistant/postgres_data",
23 "owner": {"user": "netdata", "group": "docker"},
24 "snapshot": {"id": "postgres_data"}
25 }
26 ],
27 "app_values": {
828 "home_assistant": {"db_password": "$RANDOM_STRING(16)"},
29 "storage": {
930 "config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/home-assistant/config)",
1031 "media": "$HOST_PATH($LOCATION(Media))",
1132 "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/home-assistant/postgres_data)"
33 },
34 "network": {
1235 "web_port": {"bind_mode": "published", "port_number": 30103}
36 },
1337 "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
38 }
39}
What this script does
Hover or tap a box to see the lines it explains.
-
Script format
Tells HexOS this is a version 5 install script, so it knows how to read the rest.
Line 2
-
Script revision
This copy of the script is revision 0.1.0. Latest change: “Auto-generated draft from TrueNAS home-assistant 1.8.67”.
Lines 3–6
-
Storage locations it needs
The app uses these HexOS storage locations: App storage (fast) and Media. If one isn't set up yet, HexOS will ask you to pick a place for it.
Line 8
-
Minimum hardware
Recommended minimum: 2 CPU cores.
Line 9
-
Permission to use your folders
Allows the app to read and write files inside the storage locations listed above — and nowhere else.
Line 10
-
Network ports
The app needs port 30103 to be free on your server. A port is like an apartment number for your server's address.
Line 11
-
Folders created on install
Creates the folders the app needs before it starts: App storage (fast) › home-assistant, App storage (fast) › home-assistant › config and App storage (fast) › home-assistant › postgres_data. Some folders are handed to a specific system user so the app is allowed to write to them. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.
Lines 13–26
-
Auto-generated db password
HexOS makes up a long random db password during install. It's only used inside Home Assistant (Deprecated), so you never need to know it.
Line 28
-
Where the app's settings is saved
Where the app's settings is saved on your server: App storage (fast) › home-assistant › config.
Line 30
-
Where your media is saved
Where your media is saved on your server: Media.
Line 31
-
Where the app's database is saved
Where the app's database is saved on your server: App storage (fast) › home-assistant › postgres_data.
Line 32
-
Web port: 30103
The app's web page is published on port 30103. You don't need to remember it — clicking the app's card in HexOS takes you there.
Line 35
-
Resource limits
Caps how much of your server the app can use: 2 CPU cores and 10% of your server's memory, but never more than 4 GB. This keeps one busy app from slowing everything else down.
Line 37