kai/pounder_test
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge #430

Browse Source 
430: Adding docker instructions r=ryan-summers a=ryan-summers

This PR fixes #429 by updating the getting started page to direct users to run Mosquitto through docker. The experience is honestly a lot better on all platforms (in my experience).

Co-authored-by: Ryan Summers <ryan.summers@vertigo-designs.com>
This commit is contained in:
bors[bot] 2021-08-09 11:58:17 +00:00 committed by GitHub
commit 1a75859311
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/pages/getting-started.md
View File

@ -117,6 +117,19 @@ been used during development, but any MQTTv5 broker is supported.
Stabilizer utilizes a static IP address for broker configuration. Ensure the IP address was
[configured](#building-firmware) properly to point to your broker before continuing.
We recommend running Mosquitto through [Docker](https://docker.com) to easily run Mosquitto on
Windows, Linux, and OSX. After docker has been installed, run the following command from
the `stabilizer` repository:
```
docker run -p 1883:1883 --name mosquitto -v `pwd`/mosquitto.conf:/mosquitto/config/mosquitto.conf -v /mosquitto/data -v /mosquitto/log eclipse-mosquitto:2
```
> _Note_: The above command assumes a bash shell. If using powershell, replace `` `pwd` `` with
> `${pwd}`
This command will create a container named `mosquitto` that can be stopped and started easily via
docker.
## Test the Connection
Once your broker is running, test that Stabilizer is properly connected to it.

2
mosquitto.conf Normal file
View File

@ -0,0 +1,2 @@
allow_anonymous true
listener 1883