diff --git a/README.md b/README.md index 0df8ed6..e2a808c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # bonob -A bridge between sonos and ? +A sonos SMAPI implementation to allow registering sources of music with sonos. Currently only a single integration allowing Navidrome to be registered with sonos. + +In theory as Navidrome implements the subsonic API, it *may* work with other subsonic api clones. ![Build](https://github.com/simojenki/bonob/workflows/Build/badge.svg) @@ -16,33 +18,27 @@ docker run \ simojenki/bonob ``` -### Full sonos device auto-discovery on custom port by using a sonos seed device, without requiring docker host networking +### Full sonos device auto-discovery and auto-registration on custom port by using a sonos seed device, without requiring docker host networking ``` docker run \ + -e BONOB_PORT=3000 \ + -e BONOB_SONOS_AUTO_REGISTER=true \ -e BONOB_SONOS_SEED_HOST=192.168.1.123 \ - -e PORT=3000 \ -p 3000 \ simojenki/bonob ``` -### Disabling sonos device discovery entirely -``` -docker run \ - -e BONOB_SONOS_DEVICE_DISCOVERY=false \ - -p 4534 \ - simojenki/bonob -``` - ## Configuration item | default value | description ---- | ------------- | ----------- BONOB_PORT | 4534 | Default http port for bonob to listen on -BONOB_WEB_ADDRESS | http://localhost:4534 | Web address for bonob +BONOB_WEB_ADDRESS | http://localhost:4534 | URL for bonob so that sonos devices can communicate BONOB_SECRET | bonob | secret used for encrypting credentials +BONOB_SONOS_AUTO_REGISTER | false | Whether or not to try and auto-register on startup BONOB_SONOS_DEVICE_DISCOVERY | true | whether or not sonos device discovery should be enabled BONOB_SONOS_SEED_HOST | undefined | sonos device seed host for discovery, or ommitted for for auto-discovery BONOB_SONOS_SERVICE_NAME | bonob | service name for sonos BONOB_SONOS_SERVICE_ID | 246 | service id for sonos BONOB_NAVIDROME_URL | http://localhost:4533 | URL for navidrome -BONOB_SONOS_AUTO_REGISTER | false | Whether or not to try and auto-register on startup +