Jelajahi Sumber

Merge pull request #761 from emqtt/emq20

Update docs: Install via docker image, https config
turtleDeng 9 tahun lalu
induk
melakukan
2c154235a7
2 mengubah file dengan 42 tambahan dan 7 penghapusan
  1. 4 5
      docs/source/config.rst
  2. 38 2
      docs/source/install.rst

+ 4 - 5
docs/source/config.rst

@@ -447,11 +447,11 @@ SSL Listener - 8883
     ## Rate Limit. Format is 'burst,rate', Unit is KB/Sec
     ## mqtt.listener.ssl.rate_limit = 100,10
 
-    ## SSL Options
+    ## Configuring SSL Options
     mqtt.listener.ssl.handshake_timeout = 15
     mqtt.listener.ssl.keyfile = etc/certs/key.pem
     mqtt.listener.ssl.certfile = etc/certs/cert.pem
-    mqtt.listener.ssl.cacertfile = etc/certs/cacert.pem
+    ## mqtt.listener.ssl.cacertfile = etc/certs/cacert.pem
     ## mqtt.listener.ssl.verify = verify_peer
     ## mqtt.listener.ssl.fail_if_no_peer_cert = true
 
@@ -474,11 +474,10 @@ HTTPS/WSS Listener - 8084
     mqtt.listener.https = 8084
     mqtt.listener.https.acceptors = 4
     mqtt.listener.https.max_clients = 64
-    mqtt.listener.https.handshake_timeout = 10
+    mqtt.listener.https.handshake_timeout = 15
     mqtt.listener.https.certfile = etc/certs/cert.pem
     mqtt.listener.https.keyfile = etc/certs/key.pem
-    mqtt.listener.https.cacertfile = etc/certs/cacert.pem
-    ## 开启双向认证
+    ## mqtt.listener.https.cacertfile = etc/certs/cacert.pem
     ## mqtt.listener.https.verify = verify_peer
     ## mqtt.listener.https.fail_if_no_peer_cert = true
 

+ 38 - 2
docs/source/install.rst

@@ -181,6 +181,40 @@ Uninstall emqttd service::
 
 .. WARNING:: './bin/emqttd_ctl' command line cannot work on Windows.
 
+.. _install_via_docker_image:
+
+------------------------
+Install via Docker Image
+------------------------
+
+Download *EMQ* 2.0 Docker Image:
+
+    http://emqtt.com/downloads/latest/docker
+
+unzip emqttd-docker image::
+
+    unzip emqttd-docker-v2.0.zip
+
+Load Docker Image::
+
+    docker load < emqttd-docker-v2.0
+
+Run the Container::
+
+    docker run -itd --net='host' --name emq20 emqttd-docker-v2.0
+
+Stop the broker::
+
+    docker stop emq20
+
+Start the broker::
+
+    docker start emq20
+
+Enter the running container::
+
+    docker exec -it emq20 /bin/bash
+
 .. _build_from_source:
 
 ----------------------
@@ -218,11 +252,13 @@ TCP Ports Used
 +-----------+-----------------------------------+
 | 1883      | MQTT Port                         |
 +-----------+-----------------------------------+
-| 8883      | MQTT Over SSL Port                |
+| 8883      | MQTT/SSL  Port                    |
 +-----------+-----------------------------------+
 | 8083      | MQTT(WebSocket), HTTP API Port    |
 +-----------+-----------------------------------+
-| 18083     | Dashboard Port                    |
+| 8084      | MQTT(WebSocket/SSL), HTTP API Port|
++-----------+-----------------------------------+
+| 18083     | Web Dashboard Port                |
 +-----------+-----------------------------------+
 
 The TCP ports used can be configured in etc/emqttd.config: