From 08cecb4045fe4f2905bedbefbcd44af0739ecbfe Mon Sep 17 00:00:00 2001 From: Ryan Summers Date: Mon, 9 Aug 2021 13:12:27 +0200 Subject: [PATCH 1/2] Adding docker instructions --- docs/pages/getting-started.md | 9 +++++++++ mosquitto.conf | 2 ++ 2 files changed, 11 insertions(+) create mode 100644 mosquitto.conf diff --git a/docs/pages/getting-started.md b/docs/pages/getting-started.md index c81480e..9f40c84 100644 --- a/docs/pages/getting-started.md +++ b/docs/pages/getting-started.md @@ -117,6 +117,15 @@ 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). 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}` + ## Test the Connection Once your broker is running, test that Stabilizer is properly connected to it. diff --git a/mosquitto.conf b/mosquitto.conf new file mode 100644 index 0000000..76c1e95 --- /dev/null +++ b/mosquitto.conf @@ -0,0 +1,2 @@ +allow_anonymous true +listener 1883 From 726edc576b6747b598830efa7d9a33482676ba8f Mon Sep 17 00:00:00 2001 From: Ryan Summers Date: Mon, 9 Aug 2021 13:53:05 +0200 Subject: [PATCH 2/2] Adding verbage to indicate cross-platform support for Docker, adding note about start/stop of container --- docs/pages/getting-started.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/pages/getting-started.md b/docs/pages/getting-started.md index 9f40c84..8603b2e 100644 --- a/docs/pages/getting-started.md +++ b/docs/pages/getting-started.md @@ -117,8 +117,9 @@ 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). After docker has been -installed, run the following command from the `stabilizer` repository: +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 ``` @@ -126,6 +127,9 @@ docker run -p 1883:1883 --name mosquitto -v `pwd`/mosquitto.conf:/mosquitto/conf > _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.