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

docs: fix override conf note

This commit is contained in:
Zaiming (Stone) Shi 2022-01-28 09:54:12 +01:00
parent 0cde9e6ecf
commit 8da27899ea
2 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
apps/emqx_conf/etc/emqx_conf.conf
View File

@ -1,5 +1,11 @@
## NOTE: The configurations in this file will be overridden by ## NOTE:
## `<path-to-emqx-installation>/data/emqx_overrides.conf` ## Configs in this file might be overridden by:
## 1. Environment variables which start with 'EMQX_' prefix
## 2. File {{ platform_data_dir }}/configs/cluster-override.conf
## 3. File {{ platform_data_dir }}/configs/local-override.conf
##
## The *-override.conf files are overwritten at runtime when changes
## are made from EMQ X dashboard UI, management HTTP API, or CLI.
##================================================================== ##==================================================================
## Node ## Node

15
apps/emqx_conf/etc/emqx_conf.md
View File

@ -9,12 +9,15 @@ From bottom up:
1. Immutable base: `emqx.conf` + `EMQX_` prfixed environment variables.<br> 1. Immutable base: `emqx.conf` + `EMQX_` prfixed environment variables.<br>
Changes in this layer require a full node restart to take effect. Changes in this layer require a full node restart to take effect.
1. Cluster override: The path of which is configured by `cluster_override_conf_file`.<br> 1. Cluster overrides: `${data_dir}/cluster-override.conf`
Overrides made from management APIs (or dashboard) for all nodes in the cluster. 1. Local node overrides: `${data_dir}/configs/local-override.conf`
1. Local override: The path of which is configured by `local_override_conf_file`.<br>
Special overrides applied to local node.
For detailed override rules, see [Config overlay rules](#config-overlay-rules). Where `${data_dir}` is configurable from `node.data_dir`.
The `*-override.conf` files are overwritten at runtime when changes
are made from dashboard UI, management HTTP API, or CLI.
For detailed override rules, see [Config Overlay Rules](#config-overlay-rules).
## Syntax ## Syntax
@ -131,7 +134,7 @@ because the field name is `enable`, not `enabled`.
<strong>NOTE:</strong> Unknown root keys are however silently discarded. <strong>NOTE:</strong> Unknown root keys are however silently discarded.
### Config overlay rules ### Config Overlay Rules
HOCON objects are overlaid, in general: HOCON objects are overlaid, in general: