Skip to content

Commit

Permalink
feat: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
escalate committed Jan 26, 2018
1 parent 4309d01 commit dc2496a
Showing 1 changed file with 44 additions and 1 deletion.
45 changes: 44 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,47 @@
# ha-bridge-raspberry-pi-docker
[![Build Status](https://travis-ci.org/escalate/ha-bridge-raspberry-pi-docker.svg?branch=master)](https://travis-ci.org/escalate/ha-bridge-raspberry-pi-docker)

Automated build for home automation bridge Docker image
Automated build of ha-bridge Docker images specialized for Raspberry Pi devices.

## How to run container
The following example explains how to run ha-bridge Docker container on Raspberry Pi 3.

```
docker run \
--name habridge \
--rm \
--init \
--detach \
--net=host \
--volume=$PWD:/habridge/data \
--volume=/etc/localtime:/etc/localtime:ro \
--volume=/etc/timezone:/etc/timezone:ro \
habridge/ha-bridge-raspberrypi3
```

To set additional arguments for ha-bridge just write them as arguments for docker run command.
```
docker run \
--name habridge \
--rm \
--init \
--detach \
--detach \
--net=host \
--volume=$PWD:/habridge/data \
--volume=/etc/localtime:/etc/localtime:ro \
--volume=/etc/timezone:/etc/timezone:ro \
habridge/ha-bridge-raspberrypi3 \
-Dserver.port=8080 \
-Dsecurity.key=secret
```

## Docker Hub Repos

* [habridge/ha-bridge-raspberry-pi](https://hub.docker.com/r/habridge/ha-bridge-raspberry-pi)
* [habridge/ha-bridge-raspberry-pi2](https://hub.docker.com/r/habridge/ha-bridge-raspberry-pi2)
* [habridge/ha-bridge-raspberrypi3](https://hub.docker.com/r/habridge/ha-bridge-raspberrypi3)

## License

MIT

0 comments on commit dc2496a

Please sign in to comment.