Skip to content

Commit e19cbc5

Browse files
committed
docs: fix name of variable for publishing topics
1 parent ab72322 commit e19cbc5

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ services:
2525
environment:
2626
USBIP_DEVICE_IDS: "0000:0000"
2727
MQTT_OPTIONS: "-h broker-host"
28-
MQTT_PUBLISH_TOPIC: "rudy/server"
28+
MQTT_PUBLISH_TO_TOPIC: "rudy/server"
2929
MQTT_RELOAD_ON_TOPIC: "rudy/client/error/server"
3030
volumes:
3131
- "/sys/bus/usb/drivers/usb:/sys/bus/usb/drivers/usb"
@@ -76,7 +76,7 @@ services:
7676
USBIP_SERVER: "server-host"
7777
USBIP_DEVICE_IDS: "0000:0000"
7878
MQTT_OPTIONS: "-h broker-host"
79-
MQTT_PUBLISH_TOPIC: "rudy/client"
79+
MQTT_PUBLISH_TO_TOPIC: "rudy/client"
8080
MQTT_RELOAD_ON_TOPIC: "rudy/server/start"
8181
volumes:
8282
- "/var/run/vhci_hcd:/var/run/vhci_hcd"
@@ -179,20 +179,20 @@ $ sudo apt install docker-compose
179179

180180
## Advanced topics
181181
### MQTT publishing
182-
Configure `MQTT_PUBLISH_TOPIC` to publish client and server states via MQTT.
182+
Configure `MQTT_PUBLISH_TO_TOPIC` to publish client and server states via MQTT.
183183

184184
Example:
185185
- Server configuration:
186186
```yaml
187187
environment:
188188
USBIP_DEVICE_IDS: "4971:1011"
189-
MQTT_PUBLISH_TOPIC: "rudy/server"
189+
MQTT_PUBLISH_TO_TOPIC: "rudy/server"
190190
```
191191
- Client configuration:
192192
```yaml
193193
environment:
194194
USBIP_DEVICE_IDS: "4971:1011"
195-
MQTT_PUBLISH_TOPIC: "rudy/client"
195+
MQTT_PUBLISH_TO_TOPIC: "rudy/client"
196196
```
197197
- MQTT messages published on starting server and client and then stopping client and server:
198198
```
@@ -225,7 +225,7 @@ Example:
225225
```yaml
226226
restart: unless-stopped
227227
environment:
228-
MQTT_PUBLISH_TOPIC: "rudy/client"
228+
MQTT_PUBLISH_TO_TOPIC: "rudy/client"
229229
```
230230

231231
### Prepare Client for Server Restart
@@ -236,7 +236,7 @@ Example:
236236
```yaml
237237
environment:
238238
USBIP_DEVICE_IDS: "4971:1011"
239-
MQTT_PUBLISH_TOPIC: "rudy/server"
239+
MQTT_PUBLISH_TO_TOPIC: "rudy/server"
240240
```
241241
- Client configuration:
242242
```yaml

docker-compose.yml.example-client

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ services:
1515
USBIP_SERVER: "server-host"
1616
USBIP_DEVICE_IDS: "0000:0000,1111:1111"
1717
MQTT_OPTIONS: "-h broker-host"
18-
MQTT_PUBLISH_TOPIC: "rudy/client"
18+
MQTT_PUBLISH_TO_TOPIC: "rudy/client"
1919
MQTT_RELOAD_ON_TOPIC: "rudy/server/start"
2020
volumes:
2121
- "/var/run/vhci_hcd:/var/run/vhci_hcd"

docker-compose.yml.example-server

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ services:
1616
environment:
1717
USBIP_DEVICE_IDS: "0000:0000,1111:1111"
1818
MQTT_OPTIONS: "-h broker-host"
19-
MQTT_PUBLISH_TOPIC: "rudy/server"
19+
MQTT_PUBLISH_TO_TOPIC: "rudy/server"
2020
MQTT_RELOAD_ON_TOPIC: "rudy/client/error/server"
2121
volumes:
2222
- "/sys/bus/usb/drivers/usb:/sys/bus/usb/drivers/usb"

0 commit comments

Comments
 (0)