From 5ac9e9f82456becc345479d658308236715af07f Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Fri, 24 Jun 2022 13:04:19 +0200 Subject: [PATCH 1/5] docs: refine authz file path doc --- apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf b/apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf index 161f6ed1b..1225ccad8 100644 --- a/apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf +++ b/apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf @@ -97,19 +97,20 @@ It is NOT allowed to configure two or more sources of the same type. Path to the file which contains the ACL rules. If the file provisioned before starting EMQX node, it can be placed anywhere as long as EMQX has read access to it. +That is, EMQX will treat it as readonly. -In case the rule-set is created from EMQX Dashboard or management API, -the file will be placed in `authz` subdirectory inside EMQX's `data_dir`, -and the new rules will override all rules from the old config file. +In case the rule-set is created or updated from EMQX Dashboard or management API, +a new file will be created and placed in `authz` subdirectory inside EMQX's `data_dir`, +and the old file will not be used anymore. """ zh: """ 包含 ACL 规则的文件路径。 如果在启动 EMQX 节点前预先配置该路径， 那么可以将该文件置于任何 EMQX 可以访问到的位置。 -如果从 EMQX Dashboard 或 management API 创建规则集， -那么文件将会自动生成在 `authz` 目录下，该目录位于 EMQX 的 `data_dir` 子目录下， -并且之后新的规则集将会覆写旧文件。""" +如果从 EMQX Dashboard 或 management API 创建或修改了规则集， +那么EMQX将会生成一个新的文件并将它存放在 `data_dir` 下的 `authz` 子目录中, +并从此启用旧的文件。""" } label { en: """path""" From 39638564805596be38d61cfca5ed3d9d375d3e93 Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Thu, 30 Jun 2022 08:08:01 +0200 Subject: [PATCH 2/5] docs: Update apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf Co-authored-by: JianBo He --- apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf b/apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf index 1225ccad8..b3a1425f7 100644 --- a/apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf +++ b/apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf @@ -99,7 +99,7 @@ If the file provisioned before starting EMQX node, it can be placed anywhere as long as EMQX has read access to it. That is, EMQX will treat it as readonly. -In case the rule-set is created or updated from EMQX Dashboard or management API, +In case the rule-set is created or updated from EMQX Dashboard or HTTP API, a new file will be created and placed in `authz` subdirectory inside EMQX's `data_dir`, and the old file will not be used anymore. """ From fd86e8bf0b76798e2a84aab63ad35b44b5055871 Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Thu, 30 Jun 2022 08:08:07 +0200 Subject: [PATCH 3/5] docs: Update apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf Co-authored-by: JianBo He --- apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf b/apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf index b3a1425f7..299e4b5cc 100644 --- a/apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf +++ b/apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf @@ -110,7 +110,7 @@ and the old file will not be used anymore. 如果从 EMQX Dashboard 或 management API 创建或修改了规则集， 那么EMQX将会生成一个新的文件并将它存放在 `data_dir` 下的 `authz` 子目录中, -并从此启用旧的文件。""" +并从此弃用旧的文件。""" } label { en: """path""" From c3ffdef872bad178e2ea30382bd524ffa4fc1c67 Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Thu, 30 Jun 2022 08:08:15 +0200 Subject: [PATCH 4/5] docs: Update apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf Co-authored-by: JianBo He --- apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf b/apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf index 299e4b5cc..c3c924230 100644 --- a/apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf +++ b/apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf @@ -108,7 +108,7 @@ and the old file will not be used anymore. 如果在启动 EMQX 节点前预先配置该路径， 那么可以将该文件置于任何 EMQX 可以访问到的位置。 -如果从 EMQX Dashboard 或 management API 创建或修改了规则集， +如果从 EMQX Dashboard 或 HTTP API 创建或修改了规则集， 那么EMQX将会生成一个新的文件并将它存放在 `data_dir` 下的 `authz` 子目录中, 并从此弃用旧的文件。""" } From eac21e5b0a8aa4f42b11f4d9b608c99d2fc54919 Mon Sep 17 00:00:00 2001 From: JianBo He Date: Fri, 1 Jul 2022 11:01:44 +0800 Subject: [PATCH 5/5] chore: make spellcheck happy --- apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf b/apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf index c3c924230..e83169978 100644 --- a/apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf +++ b/apps/emqx_authz/i18n/emqx_authz_schema_i18n.conf @@ -97,7 +97,7 @@ It is NOT allowed to configure two or more sources of the same type. Path to the file which contains the ACL rules. If the file provisioned before starting EMQX node, it can be placed anywhere as long as EMQX has read access to it. -That is, EMQX will treat it as readonly. +That is, EMQX will treat it as read only. In case the rule-set is created or updated from EMQX Dashboard or HTTP API, a new file will be created and placed in `authz` subdirectory inside EMQX's `data_dir`,