https://github.com/postlund/hassio-compose
Hass.io with docker-compose
https://github.com/postlund/hassio-compose
docker docker-compose home-assistant
Last synced: about 1 month ago
JSON representation
Hass.io with docker-compose
- Host: GitHub
- URL: https://github.com/postlund/hassio-compose
- Owner: postlund
- License: apache-2.0
- Created: 2019-05-02T15:30:01.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-02-27T20:14:19.000Z (about 5 years ago)
- Last Synced: 2025-02-27T17:16:36.722Z (2 months ago)
- Topics: docker, docker-compose, home-assistant
- Language: Shell
- Size: 7.81 KB
- Stars: 94
- Watchers: 8
- Forks: 30
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hass.io with docker-compose
This is a simple docker compose file to run a full Hass.io system using
`docker-compose`. The motivation for doing so is to avoid having to install
additional packages on the host system. Also, in order to simplify installation
on plain container OSes, like Container OS or RancherOS. It comes with a few
limitations however, make sure to read about them below.
## Caveats and limitations
Nothing is perfect, so here are few general things you need to know:
* Currently only for x86_64 hosts (based on `qemux86-64-homeassistant`)
* AppArmor not supported (maybe later)
* You will get an error regarding *rauc* during startup ([you can ignore it](https://github.com/home-assistant/hassio/issues/560))
* Since HassOS is not used, upgrade of OS is not supported (related to point above)
The supervisor in particular has a few quriks:
* As it launches containers dynamically (e.g. homeassistant and all the addons),
`docker-compose` will not be aware of these containers and cannot mange them
them (e.g. stop or remove them)
* It is designed to run on a system where no one can mess with docker. It will
restart containers that crash, but if a container is manually stopped or removed
(whilst the supervisor is running), it will treat that as a non-error and do nothing.
So if you fiddle with the containers, you are on your down!
* It keeps track of the last system boot. So
if you restart only the supervisor, it will realize that and skip doing things
(like re-creating containers). I found this to be a bit annoying, so the last
boot tag is reset every time the supervisor is restarted. This makes sure that
containers are re-created properly with the sacrifice of a tad slower startup
time and maybe a few warnings about containers already running (that can be
safely ignored). Just be aware of this.
Other things, like installing addons, upgrading Home Assistant and dealing with
snapshots works correctly though :blush:
## Installation
1. Install `docker-compose` according to your operating system, e.g. `apt-get` or
`pip install docker-compose` in a virtual environment.
2. Clone this repository:
```shell
$ git clone https://github.com/postlund/hassio-compose.git
```
3. Create a `.env` file with `SUPERVISOR_SHARE` pointing to the directory where
you want to store all configuration data. __THIS MUST BE AN ABSOLUTE PATH!!!!__
```shell
$ cd hassio-compose
$ echo "SUPERVISOR_SHARE=/home/$USER/hassio-config" > .env
```
4. Start Hass.io using `docker-compose`:
```shell
$ docker-compose up
Recreating hassio_supervisor ... done
Attaching to hassio_supervisor
hassio_supervisor | Resetting last boot...
hassio_supervisor | Starting hassio...
hassio_supervisor | 19-05-02 14:29:00 INFO (MainThread) [__main__] Initialize Hass.io setup
hassio_supervisor | 19-05-02 14:29:00 INFO (MainThread) [__main__] Setup HassIO
hassio_supervisor | 19-05-02 14:29:00 INFO (SyncWorker_0) [hassio.docker.supervisor] Attach to Supervisor homeassistant/amd64-hassio-supervisor with version 162
hassio_supervisor | 19-05-02 14:29:00 INFO (SyncWorker_0) [hassio.docker.supervisor] Connect Supervisor to Hass.io Network
hassio_supervisor | 19-05-02 14:29:00 INFO (MainThread) [hassio.utils.gdbus] Introspect org.freedesktop.systemd1 on /org/freedesktop/systemd1
hassio_supervisor | 19-05-02 14:29:00 INFO (MainThread) [hassio.utils.gdbus] Connect to dbus: org.freedesktop.systemd1 - /org/freedesktop/systemd1
hassio_supervisor | 19-05-02 14:29:00 INFO (MainThread) [hassio.utils.gdbus] Introspect org.freedesktop.hostname1 on /org/freedesktop/hostname1
hassio_supervisor | 19-05-02 14:29:01 INFO (MainThread) [hassio.utils.gdbus] Connect to dbus: org.freedesktop.hostname1 - /org/freedesktop/hostname1
hassio_supervisor | 19-05-02 14:29:01 INFO (MainThread) [hassio.utils.gdbus] Introspect de.pengutronix.rauc on /
hassio_supervisor | 19-05-02 14:29:01 ERROR (MainThread) [hassio.utils.gdbus] DBus return error: b'Error: GDBus.Error:org.freedesktop.DBus.Error.ServiceUnknown: The name de.pengutronix.rauc was not provided by any .service files\n'
hassio_supervisor | 19-05-02 14:29:01 WARNING (MainThread) [hassio.dbus.rauc] Can't connect to rauc
hassio_supervisor | 19-05-02 14:29:01 INFO (MainThread) [hassio.host.info] Update local host information
hassio_supervisor | 19-05-02 14:29:01 INFO (MainThread) [hassio.utils.gdbus] Call org.freedesktop.DBus.Properties.GetAll on /org/freedesktop/hostname1
hassio_supervisor | 19-05-02 14:29:01 INFO (MainThread) [hassio.host.services] Update service information
hassio_supervisor | 19-05-02 14:29:01 INFO (MainThread) [hassio.utils.gdbus] Call org.freedesktop.systemd1.Manager.ListUnits on /org/freedesktop/systemd1
hassio_supervisor | 19-05-02 14:29:01 INFO (MainThread) [hassio.host.apparmor] Load AppArmor Profiles: set()
hassio_supervisor | 19-05-02 14:29:01 INFO (MainThread) [hassio.host.apparmor] AppArmor is not enabled on host
hassio_supervisor | 19-05-02 14:29:01 INFO (SyncWorker_2) [hassio.docker.interface] Attach to homeassistant/qemux86-64-homeassistant with version 0.92.1
hassio_supervisor | 19-05-02 14:29:01 INFO (MainThread) [hassio.addons.git] Load add-on /data/addons/core repository
hassio_supervisor | 19-05-02 14:29:01 INFO (MainThread) [hassio.addons.git] Load add-on /data/addons/git/a0d7b954 repository
hassio_supervisor | 19-05-02 14:29:01 INFO (MainThread) [hassio.addons] Load add-ons: 57 all - 57 new - 0 remove
hassio_supervisor | 19-05-02 14:29:01 INFO (MainThread) [hassio.updater] Fetch update data from https://s3.amazonaws.com/hassio-version/stable.json
hassio_supervisor | 19-05-02 14:29:02 INFO (MainThread) [hassio.snapshots] Found 0 snapshot files
hassio_supervisor | 19-05-02 14:29:02 INFO (MainThread) [hassio.discovery] Load 0 messages
hassio_supervisor | 19-05-02 14:29:02 INFO (MainThread) [hassio.ingress] Load 0 ingress session
hassio_supervisor | 19-05-02 14:29:02 INFO (MainThread) [__main__] Run Hass.io
hassio_supervisor | 19-05-02 14:29:02 INFO (MainThread) [hassio.misc.dns] Start DNS port forwarding for host add-ons
hassio_supervisor | 19-05-02 14:29:02 INFO (MainThread) [hassio.api] Start API on 172.30.32.2
hassio_supervisor | 19-05-02 14:29:02 INFO (MainThread) [hassio.addons] Startup initialize run 0 add-ons
hassio_supervisor | 19-05-02 14:29:02 INFO (MainThread) [hassio.addons] Startup system run 0 add-ons
hassio_supervisor | 19-05-02 14:29:02 INFO (MainThread) [hassio.addons] Startup services run 0 add-ons
hassio_supervisor | 19-05-02 14:29:02 INFO (SyncWorker_2) [hassio.docker.interface] Restart homeassistant/qemux86-64-homeassistant
hassio_supervisor | 19-05-02 14:29:17 INFO (MainThread) [hassio.homeassistant] Detect a running Home Assistant instance
hassio_supervisor | 19-05-02 14:29:17 INFO (MainThread) [hassio.addons] Startup application run 0 add-ons
hassio_supervisor | 19-05-02 14:29:17 INFO (MainThread) [hassio.tasks] All core tasks are scheduled
hassio_supervisor | 19-05-02 14:29:17 INFO (MainThread) [hassio.core] Hass.io is up and running
```
5. Integrate with however you run your docker instances (out of scope)
## Tips & tricks
### Stopping Containers
To stop the supervisor, just run:
```shell
$ docker-compose down
```
This will not stop Home Assistant or any addons. To do that, run:
```shell
$ docker stop homeassistant
$ docker ps | grep " addon_" | cut -f 1 -d ' ' | xargs docker stop
```
### Removing Containers
To remove the containers (stop them first), just do:
```shell
$ docker-compose rm
$ docker ps | grep " addon_" | cut -f 1 -d ' ' | xargs docker rm
```