From 13f50b2ba9e92d77c233d453f87d93192e43d07c Mon Sep 17 00:00:00 2001 From: JianBo He Date: Wed, 19 Apr 2023 21:05:10 +0800 Subject: [PATCH] chore: update README files --- apps/emqx_conf/README.md | 16 ++++++++++++++++ apps/emqx_plugins/README.md | 12 ++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 apps/emqx_conf/README.md create mode 100644 apps/emqx_plugins/README.md diff --git a/apps/emqx_conf/README.md b/apps/emqx_conf/README.md new file mode 100644 index 000000000..726fd72cd --- /dev/null +++ b/apps/emqx_conf/README.md @@ -0,0 +1,16 @@ +# Configuration Management + +This application provides configuration management capabilities for EMQX. + +This includes, during compilation: +- Read all configuration schemas and generate the following files: + * `config-en.md`: documentation for all configuration options. + * `schema-en.json`: JSON description of all configuration schema options. + * `emqx.conf.example`: an example of a complete configuration file. + +At runtime, it provides: +- Cluster configuration synchronization capability. + Responsible for synchronizing hot-update configurations from the HTTP API to the entire cluster + and ensuring consistency. + +In addition, this application manages system-level configurations such as `cluster`, `node`, `log`. diff --git a/apps/emqx_plugins/README.md b/apps/emqx_plugins/README.md new file mode 100644 index 000000000..9c8faccd1 --- /dev/null +++ b/apps/emqx_plugins/README.md @@ -0,0 +1,12 @@ +# Plugins Management + +This application provides the feature for users to upload and install custom, Erlang-based plugins. + +More introduction about [Plugins](https://www.emqx.io/docs/en/v5.0/extensions/plugins.html#develop-emqx-plugins) + +See HTTP API to learn how to [Install/Uninstall a Plugin](https://www.emqx.io/docs/en/v5.0/admin/api-docs.html#tag/Plugins) + +## Plugin Template + +We provide a [plugin template](https://github.com/emqx/emqx-plugin-template) that +you can use to learn how to write and package custom plugins.