Skip to content

Commit d1b334f

Browse files
Updated README.md to reflect changes in container structure
1 parent 648f94f commit d1b334f

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
11
# c't-Smart-Home
22
Docker-environment for Node-Red with MQTT, Zigbee2MQTT, HomeKit and Bluetooth-LE-Support
33

4+
![](https://img.shields.io/github/release/ct-Open-Source/ct-Smart-Home.svg)
5+
![](https://img.shields.io/github/license/ct-Open-Source/ct-Smart-Home.svg)
46
![](https://img.shields.io/docker/pulls/ctmagazin/ctnodered.svg)
57
![](https://img.shields.io/docker/stars/ctmagazin/ctnodered.svg)
8+
![](https://img.shields.io/docker/cloud/automated/ctmagazin/ctnodered.svg)
9+
![](https://img.shields.io/docker/cloud/build/ctmagazin/ctnodered.svg)
10+
11+
## Requirements
12+
13+
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.
14+
15+
You'll also need [docker-compose](https://docs.docker.com/compose/install/) on your machine.
16+
17+
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.
618

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

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

1628
## Manual start
1729
* run `./start.sh data` to create the necessary folders
18-
* On a AMD64-System use `docker-compose -f up -d`
19-
* On a Raspberry Pi/ARM-based systems use `docker-compose -f docker-compose.yml -f docker-compose.arm.yml up -d`
20-
* 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`
30+
* Use `docker-compose up -d` to start the containers
31+
* 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.
2132

2233
## start.sh options
2334
```

0 commit comments

Comments
 (0)