Skip to content

Commit b9ae351

Browse files
committed
develop: home assistant readme
1 parent 4e9350c commit b9ae351

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed
Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
# Home Assistant OCI
22

3-
Open source home automation that puts local control and privacy first. Powered by a worldwide community of tinkerers and DIY enthusiasts
3+
Open source home automation.
44

55
- [homepage](https://www.home-assistant.io/)
66
- [docs](https://www.home-assistant.io/docs/)
77

88
## Setup
99

10-
Import `inputs.core.nixosModule.home-assistant-oci`, set `services.home-assistant-oci.enable = true` in your config and access the webUI with `http://<ip-of-your-device>:8123` locally. There should be an option for creating an account.
10+
Enable the service in your NixOS configuration:
1111

12-
## Auto-discovery
12+
```nix
13+
imports = [ inputs.core.nixosModule.home-assistant-oci ];
14+
15+
services.home-assistant-oci.enable = true;
16+
```
1317

14-
In case you cannot get your home devices discovered in your network, you might need to open TCP ports on your server that are required by your services via `networking.firewall.allowedTCPPorts` and add the services via `Settings >> Devices & Services >> Integrations >> Add Integration` manually in home-assistant.
18+
Access the web interface at `http://<ip-of-your-device>:8123`. There should be an option for creating an account.
1519

16-
## TODO
20+
## Auto-discovery
1721

18-
- [ ] let docker image update automatically
22+
In case you cannot get your home devices discovered in your network, you might need to open TCP ports on your server that are required by your services via `networking.firewall.allowedTCPPorts` and add the services via *Settings >> Devices & Services >> Integrations >> Add Integration* manually in home-assistant.

0 commit comments

Comments
 (0)