search

vernemq / vernemq

A distributed MQTT message broker based on Erlang/OTP. Built for high quality & Industrial use cases. The VerneMQ mission is active & the project maintained. Thank you for your support!
https://vernemq.com
Apache License 2.0
3.24k stars 395 forks source link

Plugin enabling documentation is wrong #518

Closed anonymouse64 closed 7 years ago

anonymouse64 commented 7 years ago

Environment

Expected behavior

Docs are wrong when talking about how to enable plugins from the vernemq.conf file. They say that the correct way to enable a plugin is like this:

plugins.vmq_passwd = PathToPlugin

The correct spec is for mentioned in the changelog:

plugins.myplugin = on 
plugins.myplugin.path = /path/to/plugin

Note the missing .path in the docs version.

anonymouse64 commented 7 years ago

Specifically the docs here : https://vernemq.com/docs/configuration/plugins.html

ioolkos commented 7 years ago

@anonymouse64 thanks for pointing this out, and apologies in case you ran into friction/frustration.

I'll assign myself to clean up the doc. Maybe some more stuff needs and update in the plugin docs.

codeadict commented 7 years ago

I found the same issue but figured it out myself looking at the code and forgot to report heh :)

ioolkos commented 7 years ago

@codeadict @anonymouse64 thanks a lot guys! I fixed the doc as suggested.