Skip to content

Commit

Permalink
Merge pull request #124 from lafirest/fix/readme
Browse files Browse the repository at this point in the history
chore: improve README
  • Loading branch information
zmstone authored Apr 26, 2024
2 parents 192a43f + 63373bc commit 5dc30e1
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ $ rebar3 new emqx-plugin my_emqx_plugin
$ make -C my_emqx_plugin rel
```

**NOTE**
If the `REBAR_CACHE_DIR` environment variable has been set, the directory for templates should be `$REBAR_CACHE_DIR/.config/rebar3/templates`.
[Here](https://github.com/erlang/rebar3/issues/2762) is a relevant issue.

This will create a tarball containing your custom plugin. You can use EMQX's Dashboard or it's command line tools to deploy it into your running EMQX cluster.

See [EMQX documentation](https://docs.emqx.com/en/enterprise/v5.0/extensions/plugins.html) for details on how to deploy custom plugins.

0 comments on commit 5dc30e1

Please sign in to comment.