emqx_plugins_schema.conf 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. emqx_plugins_schema {
  2. plugins {
  3. desc {
  4. en: """Manage EMQX plugins.<br/>
  5. Plugins can be pre-built as a part of EMQX package,
  6. or installed as a standalone package in a location specified by
  7. <code>install_dir</code> config key<br/>
  8. The standalone-installed plugins are referred to as 'external' plugins."""
  9. zh: """管理EMQX插件。<br/>
  10. 插件可以是EMQX安装包中的一部分,也可以是一个独立的安装包。<br/>
  11. 独立安装的插件称为“外部插件”。"""
  12. }
  13. label {
  14. en: "Plugins"
  15. zh: "插件"
  16. }
  17. }
  18. state {
  19. desc {
  20. en: "A per-plugin config to describe the desired state of the plugin."
  21. zh: "描述插件的状态"
  22. }
  23. label {
  24. en: "State"
  25. zh: "插件状态"
  26. }
  27. }
  28. name_vsn {
  29. desc {
  30. en: """The {name}-{version} of the plugin.<br/>
  31. It should match the plugin application name-version as the for the plugin release package name<br/>
  32. For example: my_plugin-0.1.0."""
  33. zh: """插件的名称{name}-{version}。<br/>
  34. 它应该与插件的发布包名称一致,如my_plugin-0.1.0。"""
  35. }
  36. label {
  37. en: "Name-Version"
  38. zh: "名称-版本"
  39. }
  40. }
  41. enable {
  42. desc {
  43. en: "Set to 'true' to enable this plugin"
  44. zh: "设置为“true”以启用此插件"
  45. }
  46. label {
  47. en: "Enable"
  48. zh: "启用"
  49. }
  50. }
  51. states {
  52. desc {
  53. en: """An array of plugins in the desired states.<br/>
  54. The plugins are started in the defined order"""
  55. zh: """一组插件的状态。插件将按照定义的顺序启动"""
  56. }
  57. label {
  58. en: "States"
  59. zh: "插件启动顺序及状态"
  60. }
  61. }
  62. install_dir {
  63. desc {
  64. en: """The installation directory for the external plugins.
  65. The plugin beam files and configuration files should reside in
  66. the subdirectory named as <code>emqx_foo_bar-0.1.0</code>.
  67. <br/>
  68. NOTE: For security reasons, this directory should **NOT** be writable
  69. by anyone except <code>emqx</code> (or any user which runs EMQX)."""
  70. zh: "插件安装包的目录,出于安全考虑,该目录应该值允许 <code>emqx</code>,或用于运行 EMQX 服务的用户拥有写入权限。"
  71. }
  72. label {
  73. en: "Install Directory"
  74. zh: "安装目录"
  75. }
  76. }
  77. check_interval {
  78. desc {
  79. en: """Check interval: check if the status of the plugins in the cluster is consistent, <br/>
  80. if the results of 3 consecutive checks are not consistent, then alarm."""
  81. zh: """检查间隔:检查集群中插件的状态是否一致,<br/>
  82. 如果连续3次检查结果不一致,则报警。"""
  83. }
  84. }
  85. }