added installation instructions

This commit is contained in:
ari committed 2022-05-17 21:46:47 -04:00
1 parent d2c5310b93
commit 7f8b75fa02
2 files changed
+37

No files matched your search

+16
View File
@@ -23,6 +23,22 @@ A [home-assistant addon](https://www.home-assistant.io/addons/) for a better UI
See roadmap in [Version 1 Github Project](https://github.com/asosnovsky/Shortumation/projects/1).
## Installation
### Addon
Add the repository URL under **Supervisor → Add-on store → ⋮ → Manage add-on repositories**:
https://github.com/asosnovsky/Shortumation
It should now appear in your `Add-on Store` and you should be able to install it!
### Containerized
Please note that this way of using Shortumation is **not future proof**, currently we use the `/config/automation.yaml` file as our source of truth for the automations. Which means that we do not need access to the HA API or Websockets. In future release you may need to configure some additional compomenents to enable this.
If this warning does not scare you or you still want to try things out, then take a look at the example [docker-compose.yaml](example/containerized/docker-compose.yaml).
## FAQ
+21
View File
@@ -0,0 +1,21 @@
version: '3'
services:
homeassistant:
container_name: homeassistant
image: "ghcr.io/home-assistant/home-assistant:stable"
volumes:
- config:/config
restart: unless-stopped
privileged: true
network_mode: host
shortumation:
# make sure to replace the ARCH with whatever system you are running!
image: "asosnovsky/shortumation-${ARCH:-amd64}:latest"
volumes:
- config:/config
ports:
- 8081:8000
volumes:
config: