Skip to content

Commit

Permalink
Updated README.md to reflect changes in container structure
Browse files Browse the repository at this point in the history
  • Loading branch information
merlinschumacher committed May 17, 2019
1 parent 648f94f commit d1b334f
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
# c't-Smart-Home
Docker-environment for Node-Red with MQTT, Zigbee2MQTT, HomeKit and Bluetooth-LE-Support

![](https://img.shields.io/github/release/ct-Open-Source/ct-Smart-Home.svg)
![](https://img.shields.io/github/license/ct-Open-Source/ct-Smart-Home.svg)
![](https://img.shields.io/docker/pulls/ctmagazin/ctnodered.svg)
![](https://img.shields.io/docker/stars/ctmagazin/ctnodered.svg)
![](https://img.shields.io/docker/cloud/automated/ctmagazin/ctnodered.svg)
![](https://img.shields.io/docker/cloud/build/ctmagazin/ctnodered.svg)

## Requirements

To get this going you need a working [Docker 18.02.0+ setup](https://docs.docker.com/install/) on an AMD64 or ARM32v7 machine. This includes virtually any PC or a Raspberry Pi 3 or newer. Other ARM boards and some NAS might work too, but have not been tested.

You'll also need [docker-compose](https://docs.docker.com/compose/install/) on your machine.

If you want to controll Zigbee devices you also will need a Zigbee-Stick. Have a look at [Zigbee2MQTT's documentation](https://www.zigbee2mqtt.io/getting_started/what_do_i_need.html) for that.

## Containers
Uses mqtt, node-red and zigbee2mqtt
Uses [Eclipse Mosquitto](https://hub.docker.com/_/eclipse-mosquitto), a custom built Node-Red container and [zigbee2mqtt](https://github.com/Koenkk/zigbee2mqtt.io)

## Getting started
* Install docker and docker-compose
Expand All @@ -15,9 +27,8 @@ Uses mqtt, node-red and zigbee2mqtt

## Manual start
* run `./start.sh data` to create the necessary folders
* On a AMD64-System use `docker-compose -f up -d`
* On a Raspberry Pi/ARM-based systems use `docker-compose -f docker-compose.yml -f docker-compose.arm.yml up -d`
* If you do not want to start zigbee2mqtt, add the name of the nodered-container: `docker-compose -f docker-compose.yml -f docker-compose.arm.yml up -d nodered`
* Use `docker-compose up -d` to start the containers
* If you do not want to start zigbee2mqtt, add the name of the nodered-container: `docker-compose up -d nodered`. The mqtt container will always be started, because it's a dependency of Node-Red.

## start.sh options
```
Expand Down

0 comments on commit d1b334f

Please sign in to comment.