Merge pull request #10451 from HJianBo/update-conf-plugin-readme

chore: update README files
This commit is contained in:
JianBo He 2023-04-25 14:43:55 +08:00 committed by GitHub
commit 699bd4b85b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 0 deletions

15
apps/emqx_conf/README.md Normal file
View File

@ -0,0 +1,15 @@
# Configuration Management
This application provides configuration management capabilities for EMQX.
At compile time it reads all configuration schemas and generates 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`.

View File

@ -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.