Skip to content

Commit 57b5528

Browse files
committed
docs(chrome): Update device connection instructions
1 parent bd8cf18 commit 57b5528

File tree

5 files changed

+36
-4
lines changed

5 files changed

+36
-4
lines changed

docsite/docs/configuration/configuration.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -701,21 +701,25 @@ If your media device can be **Cast** to using this button ![Chromecast Icon](htt
701701

702702
**Note:** This source relies on common, **basic** music data provided by the cast device which will always be less exhaustive than data parsed from full source integrations. If there is an existing [Source](#source-configurations) it is recommended to configure for it and blacklist the app on Google Cast, rather than relying solely on Google Cast for scrobbling.
703703

704-
#### Networking Requirements
704+
#### Connecting Devices
705+
706+
Cast devices can be manually configured using [File-based configuration](#file-based-14) OR automatically discovered using **mDNS.**
707+
708+
##### mDNS Discovery
705709

706710
The host machine running multi-scrobbler must be configured to allow [mDNS traffic on port 5353/UDP](https://book.hacktricks.xyz/network-services-pentesting/5353-udp-multicast-dns-mdns).
707711

708712
##### Linux
709713

710714
**Docker**
711715

712-
The host machine must have [avahi-daemon](https://avahi.org/) running to circumvent limitations with DNS resolution due to musl in Alpine. All major linux distributions package avahi and many have it built-in. Once avahi is running you must pass D-Bus and the avahi daemon socket to your container like so:
716+
The host machine must have [avahi-daemon](https://avahi.org/) running to circumvent limitations with DNS resolution due to musl in Alpine. Most major linux distributions package avahi and many have it built-in. Once avahi is running you must pass D-Bus and the avahi daemon socket to your container like so:
713717

714718
```
715719
docker run ... -v /var/run/dbus:/var/run/dbus -v /var/run/avahi-daemon/socket:/var/run/avahi-daemon/socket ... foxxmd/multi-scrobbler
716720
```
717721

718-
**Flatpak**
722+
**Flatpak/Nodejs**
719723

720724
No additional steps are required.
721725

@@ -725,6 +729,10 @@ No additional steps are required.
725729

726730
Unsupported at this time.
727731

732+
**Nodejs**
733+
734+
No additional steps are required.
735+
728736
#### Cast Troubleshooting
729737

730738
Please include any/all logs with raw output if there are any errors encountered as this is critical to diagnosing issues.
@@ -749,6 +757,8 @@ To diagnose bad/incomplete track information or strange MS player behavior pleas
749757

750758
### ENV-Based
751759

760+
Note: [Manually configuring cast device connections](#connecting-devices) is only available through [File-based config.](#file-based-14)
761+
752762
| Environmental Variable | Required? | Default | Description |
753763
|------------------------|-----------|---------|--------------------------------------------------------------------------------------|
754764
| CC_ENABLE | No | | Set to 'true' to enable Cast monitoring without needing to define other ENVs |
@@ -759,7 +769,7 @@ To diagnose bad/incomplete track information or strange MS player behavior pleas
759769

760770
### File-Based
761771

762-
See [`chromecast.json.example`](https://github.com/FoxxMD/multi-scrobbler/blob/master/config/webscrobbler.json.example) or [explore the schema with an example and live editor/validator](https://json-schema.app/view/%23%2Fdefinitions%2FChromecastSourceConfig/%23%2Fdefinitions%2FChromecastData?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fmaster%2Fsrc%2Fbackend%2Fcommon%2Fschema%2Fsource.json)
772+
See [`chromecast.json.example`](https://github.com/FoxxMD/multi-scrobbler/blob/master/config/chromecast.json.example) or [explore the schema with an example and live editor/validator](https://json-schema.app/view/%23%2Fdefinitions%2FChromecastSourceConfig/%23%2Fdefinitions%2FChromecastData?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fmaster%2Fsrc%2Fbackend%2Fcommon%2Fschema%2Fsource.json)
763773

764774
# Client Configurations
765775

src/backend/common/infrastructure/config/source/chromecast.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,14 @@ export interface ChromecastData extends CommonSourceData {
8484
export interface ChromecastDeviceInfo {
8585
/**
8686
* A friendly name to identify this device
87+
*
88+
* @examples ["MySmartTV"]
8789
* */
8890
name: string
8991
/**
9092
* The IP address of the device
93+
*
94+
* @examples ["192.168.0.115"]
9195
* */
9296
address: string
9397
}

src/backend/common/schema/aio-source.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,11 +174,17 @@
174174
"properties": {
175175
"address": {
176176
"description": "The IP address of the device",
177+
"examples": [
178+
"192.168.0.115"
179+
],
177180
"title": "address",
178181
"type": "string"
179182
},
180183
"name": {
181184
"description": "A friendly name to identify this device",
185+
"examples": [
186+
"MySmartTV"
187+
],
182188
"title": "name",
183189
"type": "string"
184190
}

src/backend/common/schema/aio.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,11 +174,17 @@
174174
"properties": {
175175
"address": {
176176
"description": "The IP address of the device",
177+
"examples": [
178+
"192.168.0.115"
179+
],
177180
"title": "address",
178181
"type": "string"
179182
},
180183
"name": {
181184
"description": "A friendly name to identify this device",
185+
"examples": [
186+
"MySmartTV"
187+
],
182188
"title": "name",
183189
"type": "string"
184190
}

src/backend/common/schema/source.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,11 +221,17 @@
221221
"properties": {
222222
"address": {
223223
"description": "The IP address of the device",
224+
"examples": [
225+
"192.168.0.115"
226+
],
224227
"title": "address",
225228
"type": "string"
226229
},
227230
"name": {
228231
"description": "A friendly name to identify this device",
232+
"examples": [
233+
"MySmartTV"
234+
],
229235
"title": "name",
230236
"type": "string"
231237
}

0 commit comments

Comments
 (0)