Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md Issue#580 #581

Open
wants to merge 1 commit into
base: latest
Choose a base branch
from
Open

Update README.md Issue#580 #581

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,15 @@ Homebridge requires full access to your local network to function correctly whic
1. Create the file `docker-compose.yml`

```yml
---
version: '2'
services:
homebridge:
image: homebridge/homebridge:latest
restart: always
network_mode: host
cap_add:
- NET_RAW
volumes:
- ./volumes/homebridge:/homebridge
logging:
Expand All @@ -67,15 +70,16 @@ docker compose up
### Or Command Line:

```bash
docker run --net=host --name=homebridge -v $(pwd)/homebridge:/homebridge homebridge/homebridge:latest
docker run --volume=$(pwd)/homebridge:/homebridge --net=host --cap-add=NET_RAW --name=homebridge homebridge/homebridge:latest
```

## Parameters

The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.

* `--volume=$(pwd)/homebridge:/homebridge` - The Homebridge config and plugin location, **required**
* `--net=host` - Shares host networking with container, **required**
* `-v /homebridge` - The Homebridge config and plugin location, **required**
* `--cap-add=NET_RAW` - Allow RAW and PACKET [capabilities]([url](https://docs.docker.com/engine/containers/run/#runtime-privilege-and-linux-capabilities)) for plugins that use ping **recommended**

##### *Optional Settings:*

Expand Down
Loading