yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: fix review comments for plugins config doc

This commit is contained in:
Zaiming (Stone) Shi 2021-12-13 20:51:00 +01:00
parent 47e1875345
commit 867ebbc8a0
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
apps/emqx_plugins/src/emqx_plugins_schema.erl
View File

@ -32,7 +32,9 @@ fields("plugins") ->
Manage EMQ X plugins. Manage EMQ X plugins.
<br> <br>
Plugins can be pre-built as a part of EMQ X package, Plugins can be pre-built as a part of EMQ X package,
or installed as a standalone package to the specific directory. or installed as a standalone package in a location specified by
<code>install_dir</code> config key
<br>
The standalone-installed plugins are referred to as 'external' plugins. The standalone-installed plugins are referred to as 'external' plugins.
""" """
}. }.
@ -82,6 +84,9 @@ install_dir(desc) -> """
In which directory are the external plugins installed. In which directory are the external plugins installed.
The plugin beam files and configuration files should reside in The plugin beam files and configuration files should reside in
the sub-directory named as <code>emqx_foo_bar-0.1.0</code>. the sub-directory named as <code>emqx_foo_bar-0.1.0</code>.
<br>
NOTE: For security reasons, this directory should **NOT** be writable
by anyone expect for <code>emqx</code> (or any user which runs EMQ X)
""". """.
%% TODO: when we have some prebuilt plugins, change this function to: %% TODO: when we have some prebuilt plugins, change this function to: