Merge pull request #160 from emqx/master

Version 3.2.7

Author: turtleDeng

source/changes.rst

@@ -5,6 +5,36 @@
 Changes
 =======
 
+.. _release_3.2.7:
+
+--------------
+Version 3.2.7
+--------------
+
+*Release Date: 2019-12-03*
+
+EMQ X 3.2.7 is now available. This version resupports to configure the default ``username`` and ``clientid`` through the configuration file.
+
+emqx-auth-username (plugin)
+----------------------------
+
+Enhancements:
+
+- Resupport to configure the default ``username`` through the configuration file
+
+  Github PR:
+  `emqx/emqx-auth-username#127 <https://github.com/emqx/emqx-auth-username/pull/127>`_
+
+emqx-auth-clientid (plugin)
+----------------------------
+
+Enhancements:
+
+- Resupport to configure the default ``clientid`` through the configuration file
+
+  Github PR:
+  `emqx/emqx-auth-clientid#123 <https://github.com/emqx/emqx-auth-clientid/pull/123>`_
+
 .. _release_3.2.6:
 
 --------------

source/install.rst

@@ -96,6 +96,14 @@ Install via Repository
 
                 $ sudo service emqx start
 
+6.  Configuration file path
+
+    + Configuration file path: ``/etc/emqx``
+
+    + Log file path: ``/var/log/emqx``
+
+    + Data file path: ``/var/lib/emqx`
+
 Install via rpm
 >>>>>>>>>>>>>>>>
 
@@ -132,6 +140,14 @@ Install via rpm
 
                 $ sudo service emqx start
 
+4.  Configuration file path
+
+    + Configuration file path: ``/etc/emqx``
+
+    + Log file path: ``/var/log/emqx``
+
+    + Data file path: ``/var/lib/emqx`
+
 Install via zip Package
 >>>>>>>>>>>>>>>>>>>>>>>>
 
@@ -261,6 +277,14 @@ Install via Repository
 
                 $ sudo service emqx start
 
+8.  Configuration file path
+
+    + Configuration file path: ``/etc/emqx``
+
+    + Log file path: ``/var/log/emqx``
+
+    + Data file path: ``/var/lib/emqx`
+
 Install via deb Package
 >>>>>>>>>>>>>>>>>>>>>>>>
 
@@ -297,6 +321,14 @@ Install via deb Package
 
                 $ sudo service emqx start
 
+4.  Configuration file path
+
+    + Configuration file path: ``/etc/emqx``
+
+    + Log file path: ``/var/log/emqx``
+
+    + Data file path: ``/var/lib/emqx`
+
 Install via zip Package
 >>>>>>>>>>>>>>>>>>>>>>>>
 
@@ -424,6 +456,14 @@ Install via Repository
 
                 $ sudo service emqx start
 
+8.  Configuration file path
+
+    + Configuration file path: ``/etc/emqx``
+
+    + Log file path: ``/var/log/emqx``
+
+    + Data file path: ``/var/lib/emqx`
+
 Install via deb Package
 >>>>>>>>>>>>>>>>>>>>>>>>
 
@@ -460,6 +500,14 @@ Install via deb Package
 
                 $ sudo service emqx start
 
+4.  Configuration file path
+
+    + Configuration file path: ``/etc/emqx``
+
+    + Log file path: ``/var/log/emqx``
+
+    + Data file path: ``/var/lib/emqx`
+
 Install via zip Package
 >>>>>>>>>>>>>>>>>>>>>>>>
 
@@ -623,6 +671,14 @@ Install via Repository
 
                 $ sudo service emqx start
 
+6.  Configuration file path
+
+    + Configuration file path: ``/etc/emqx``
+
+    + Log file path: ``/var/log/emqx``
+
+    + Data file path: ``/var/lib/emqx`
+
 Install via rpm Package
 >>>>>>>>>>>>>>>>>>>>>>>>
 
@@ -659,6 +715,14 @@ Install via rpm Package
 
                 $ sudo service emqx start
 
+4.  Configuration file path
+
+    + Configuration file path: ``/etc/emqx``
+
+    + Log file path: ``/var/log/emqx``
+
+    + Data file path: ``/var/lib/emqx`
+
 Install via zip Package
 >>>>>>>>>>>>>>>>>>>>>>>>
 

source/plugins.rst

@@ -186,15 +186,23 @@ ClientID authentication plugin
 
 `emqx_auth_clientid`_ currently only supports connection authentication, it authenticates the client through ``clientid`` and ``password``. When the password is stored, it can be encrypted according the configuration.
 
-.. important:: From EMQ release X 3.1 on, only the REST API/CLI clientid is manageable by REST API/CLI only, adding clientid in the configuration file is no longer supported.
-
 ClientID Authentication Configuration
 ::::::::::::::::::::::::::::::::::::::
 
 etc/plugins/emqx_auth_clientid.conf:
 
 .. code:: properties
 
+    ## Default usernames Examples
+    ##auth.client.1.clientid = id
+    ##auth.client.1.password = passwd
+    ##auth.client.2.clientid = dev:devid
+    ##auth.client.2.password = passwd2
+    ##auth.client.3.clientid = app:appid
+    ##auth.client.3.password = passwd3
+    ##auth.client.4.clientid = client~!@#$%^&*()_+
+    ##auth.client.4.password = passwd~!@#$%^&*()_+
+
     ## Password encryption method
     ## Enumeration value: plain | md5 | sha | sha256
     auth.client.password_hash = sha256
@@ -204,15 +212,21 @@ Username Authentication Plugin
 
 `emqx_auth_username`_ currently only supports connection authentication, it authenticates the client through ``username`` and ``password``. When the password is stored, it can be encrypted according the configuration.
 
-.. important:: From EMQ release X 3.1 on, only the REST API/CLI username is manageable by REST API/CLI only, adding username in the configuration file is no longer supported.
-
 Username Authentication Configuration
 ::::::::::::::::::::::::::::::::::::::
 
 etc/plugins/emqx_auth_username.conf:
 
 .. code:: properties
 
+    ## Default usernames Examples:
+    ##auth.user.1.username = admin
+    ##auth.user.1.password = public
+    ##auth.user.2.username = [email protected]
+    ##auth.user.2.password = public
+    ##auth.user.3.username = name~!@#$%^&*()_+
+    ##auth.user.3.password = pwsswd~!@#$%^&*()_+
+
     ## Password encryption method
     ## Enumeration value: plain | md5 | sha | sha256
     auth.user.password_hash = sha256