jeans/operating-system
jeans/operating-system
1
0
Fork 0
mirror of https://github.com/home-assistant/operating-system.git synced 2025-07-28 15:36:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #7 from home-assistant/readme

Browse Source 
Fix typos and layout
This commit is contained in:
Fabian Affolter 2018-04-29 00:06:54 +02:00 committed by GitHub
commit b53b2bdf99
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,13 +1,14 @@
# WORK IN PROGRESS! # WORK IN PROGRESS!
# Hass.io OS # Hass.io OS
Hass.io OS based on buildroot. It's a hypervisor for docker and support many kind of IoT hardware. It is also available as Virtual Appliance. It's optimazed for embedded system and high security. You can update the system simple with OTA updates or offline Updates. Hass.io OS based on [buildroot](https://buildroot.org/). It's a hypervisor for Docker and supports various kind of IoT hardware. It is also available as virtual appliance. The whole system is optimized for embedded system and security. You can update the system simple with OTA updates or offline updates.
## Focus ## Focus
- Linux kernel 4.15 - Linux kernel 4.15
- Barebox as bootloader - Barebox as bootloader
- RAUC for OTA updates - RAUC for OTA updates
- SquashFS LZ4 for filesystem - SquashFS LZ4 as filesystem
- Docker 17.12.1 - Docker 17.12.1
- ZRAM LZ4 for /tmp, /var, swap - ZRAM LZ4 for /tmp, /var, swap
- Run every supervisor - Run every supervisor
@ -15,8 +16,9 @@ Hass.io OS based on buildroot. It's a hypervisor for docker and support many kin
## Schemas ## Schemas
![](misc/hassio-os-partition.png?raw=true) ![](misc/hassio-os-partition.png?raw=true)
## Config ## Configuration
Create a USB stick with a partition "hassio-config". This partition can include follow files:
Create a USB stick with a partition named "hassio-config". This partition can include follow files:
- network-* (NetworkManager keyfiles) - network-* (NetworkManager keyfiles)
- known_hosts (SSH) - known_hosts (SSH)
@ -26,7 +28,8 @@ Create a USB stick with a partition "hassio-config". This partition can include
## Supervisor/Cli ## Supervisor/Cli
Provide a `hassio.json` on your data partition they can/need follow struct: Provide a file with the name `hassio.json` in your data partition and the following structure:
```json ```json
{ {
"supervisor": "repo/image", "supervisor": "repo/image",
@ -37,10 +40,10 @@ Provide a `hassio.json` on your data partition they can/need follow struct:
``` ```
# Building # Building
Running sudo `./enter.sh` will get you into the build docker container. Running `sudo ./enter.sh` will get you into the build Docker container.
`make -C /build/buildroot BR2_EXTERNAL=/build/buildroot-external xy_defconfig` `make -C /build/buildroot BR2_EXTERNAL=/build/buildroot-external xy_defconfig`
From outside the docker container, while it is still running you can use `./getimage.sh` to get the output image. From outside the Docker container, while it is still running you can use `./getimage.sh` to get the output image.
## Helpers ## Helpers