emqx_plugins_schema.hocon 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. emqx_plugins_schema {
  2. check_interval.desc:
  3. """Check interval: check if the status of the plugins in the cluster is consistent, <br/>
  4. if the results of 3 consecutive checks are not consistent, then alarm."""
  5. enable.desc:
  6. """Set to 'true' to enable this plugin"""
  7. enable.label:
  8. """Enable"""
  9. install_dir.desc:
  10. """The installation directory for the external plugins.
  11. The plugin beam files and configuration files should reside in
  12. the subdirectory named as <code>emqx_foo_bar-0.1.0</code>.
  13. <br/>
  14. NOTE: For security reasons, this directory should **NOT** be writable
  15. by anyone except <code>emqx</code> (or any user which runs EMQX)."""
  16. install_dir.label:
  17. """Install Directory"""
  18. name_vsn.desc:
  19. """The `{name}-{version}` of the plugin.<br/>
  20. It should match the plugin application name-version as plugin release package name<br/>
  21. For example: `my_plugin-0.1.0`."""
  22. name_vsn.label:
  23. """Name-Version"""
  24. plugins.desc:
  25. """Manage EMQX plugins.<br/>
  26. Plugins can be pre-built as a part of EMQX package,
  27. or installed as a standalone package in a location specified by
  28. <code>install_dir</code> config key<br/>
  29. The standalone-installed plugins are referred to as 'external' plugins."""
  30. plugins.label:
  31. """Plugins"""
  32. state.desc:
  33. """A per-plugin config to describe the desired state of the plugin."""
  34. state.label:
  35. """State"""
  36. states.desc:
  37. """An array of plugins in the desired states.<br/>
  38. The plugins are started in the defined order"""
  39. states.label:
  40. """States"""
  41. }