Skip to content

Commit 795a9b4

Browse files
authored
Merge pull request #16 from grafana/pre-req-install-details
include pre-requisite installation details in docs
2 parents ef82930 + 0d6847c commit 795a9b4

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,21 @@ We do plan to support more complex JSON data structures in the upcoming releases
3333

3434
### Installation Pre-requisites
3535
Refer to: [Building a Streaming Datasource Backend Plugin](https://grafana.com/tutorials/build-a-streaming-data-source-plugin/)
36-
### Installation Steps
37-
38-
1. Clone the plugin to your Grafana plugins directory.
39-
2. Build the plugin by running `yarn install` and then `yarn build`.
40-
3. Run `mage reloadPlugin` or restart Grafana for the plugin to load.
4136

37+
Details: [Ubuntu](https://github.com/grafana/mqtt-datasource/issues/15#issuecomment-894477802) [Windows](https://github.com/grafana/mqtt-datasource/issues/15#issuecomment-894534196)
4238
### Meet compatibility requirements
4339

4440
This plugin currently supports MQTT v3.1.x.
4541

4642
__Note: Since this plugin uses the Grafana Live Streaming API, make sure to use Grafana v8.0+__
43+
### Installation Steps
44+
45+
1. Clone the plugin to your Grafana plugins directory.
46+
2. Build the plugin by running `yarn install` and then `yarn build`.
47+
48+
NOTE: The `yarn build` command above might fail on a non-unix-like system, like Windows, where you can try replacing the `rm -rf` command with `rimraf` in the `./package.json` file to make it work.
49+
50+
3. Run `mage reloadPlugin` or restart Grafana for the plugin to load.
4751

4852
### Verify that the plugin is installed
4953

0 commit comments

Comments
 (0)