From e02eb5f93943d2d388602db34b4dc751cd16e344 Mon Sep 17 00:00:00 2001
From: Zaiming Shi <zmstone@gmail.com>
Date: Sat, 17 Apr 2021 14:40:55 +0200
Subject: [PATCH] docs(auth_http): Update config doc

---
 apps/emqx_auth_http/etc/emqx_auth_http.conf    | 3 ++-
 apps/emqx_auth_http/priv/emqx_auth_http.schema | 6 +++++-
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/apps/emqx_auth_http/etc/emqx_auth_http.conf b/apps/emqx_auth_http/etc/emqx_auth_http.conf
index 3ebf3a45d..6c3cfbe8c 100644
--- a/apps/emqx_auth_http/etc/emqx_auth_http.conf
+++ b/apps/emqx_auth_http/etc/emqx_auth_http.conf
@@ -73,6 +73,7 @@ auth.http.super_req.headers.content-type = application/x-www-form-urlencoded
 auth.http.super_req.params = clientid=%c,username=%u
 
 ## HTTP URL API path for ACL Request
+## Comment out this config to disable ACL checks
 ##
 ## Value: URL
 ##
@@ -165,4 +166,4 @@ auth.http.pool_size = 32
 ## against this value.
 ##
 ## Value: String | disable
-## auth.http.ssl.server_name_indication = disable
\ No newline at end of file
+## auth.http.ssl.server_name_indication = disable
diff --git a/apps/emqx_auth_http/priv/emqx_auth_http.schema b/apps/emqx_auth_http/priv/emqx_auth_http.schema
index e1f02ef49..b248c7dc7 100644
--- a/apps/emqx_auth_http/priv/emqx_auth_http.schema
+++ b/apps/emqx_auth_http/priv/emqx_auth_http.schema
@@ -60,6 +60,10 @@ end}.
   end
 end}.
 
+%% @doc URL for ACL checks. Example: http://127.0.0.1:80/mqtt/acl
+%% ACL checks are disabled for this plugin if this config is
+%% commented out from the config file, or when the overriding
+%% environment variable is set to empty string.
 {mapping, "auth.http.acl_req.url", "emqx_auth_http.acl_req", [
   {datatype, string}
 ]}.
@@ -124,4 +128,4 @@ end}.
 
 {mapping, "auth.http.ssl.server_name_indication", "emqx_auth_http.server_name_indication", [
   {datatype, string}
-]}.
\ No newline at end of file
+]}.