From ac9046bdce1aa8363491e1ae7444cc302bb8d8c7 Mon Sep 17 00:00:00 2001 From: Feng Date: Thu, 31 Mar 2016 21:30:16 +0800 Subject: [PATCH] doc review --- docs/source/getstarted.rst | 4 ++-- docs/source/guide.rst | 2 +- docs/source/install.rst | 31 ++++++++++++++++++++++++------- 3 files changed, 27 insertions(+), 10 deletions(-) diff --git a/docs/source/getstarted.rst b/docs/source/getstarted.rst index a9c9c5e5c..37e608d8b 100644 --- a/docs/source/getstarted.rst +++ b/docs/source/getstarted.rst @@ -55,11 +55,11 @@ Quick Start Download and Install -------------------- -The emqttd broker is cross-platform, could be deployed on Linux, Mac, FreeBSD, Windows and Raspberry Pi. +The emqttd broker is cross-platform, which could be deployed on Linux, FreeBSD, Mac, Windows and even Raspberry Pi. Download binary package from: http://emqtt.io/downloads. -Installing on Mac, For example: +Installing on Mac, for example: .. code:: console diff --git a/docs/source/guide.rst b/docs/source/guide.rst index c988d5abb..bc7963f1e 100644 --- a/docs/source/guide.rst +++ b/docs/source/guide.rst @@ -450,7 +450,7 @@ MQTT(SSL) Listener, Default Port is 8883:: HTTP Publish API ---------------- -The emqttd broker provides a HTTP API to help application servers to publish messages to MQTT clients. +The emqttd broker provides a HTTP API to help application servers publish messages to MQTT clients. HTTP API: POST http://host:8083/mqtt/publish diff --git a/docs/source/install.rst b/docs/source/install.rst index 9e09ee1f4..962d37d41 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -1,17 +1,21 @@ -======================= +.. _install: + +============ Installation -======================= +============ -emqttd broker is cross-platform, could deploy on Linux, FreeBSD, Mac OS X and Windows. +The emqttd broker is cross-platform, which could be deployed on Linux, FreeBSD, Mac, Windows and even Raspberry Pi. .. NOTE:: Linux, FreeBSD Recommended. ------------------ -Download Package ------------------ +.. _install_download: + +---------------- +Download Package +---------------- Download binary package from: http://emqtt.io/downloads @@ -31,6 +35,8 @@ The package name consists of platform, version and release time. For example: emqttd-centos64-0.16.0-beta-20160216.zip +.. _install_on_linux: + -------------------- Installing on Linux -------------------- @@ -47,7 +53,7 @@ Start the broker in console mode:: cd emqttd && ./bin/emqttd console -If the broker started successfully, console will print: +If the broker is started successfully, console will print: .. code:: console @@ -102,6 +108,7 @@ Stop the broker:: ./bin/emqttd stop +.. _install_on_freebsd: --------------------- Installing on FreeBSD @@ -111,6 +118,7 @@ Download FreeBSD Package from: http://emqtt.io/downloads/freebsd The installing process is same to Linux. +.. _install_on_mac: ---------------------- Installing on Mac OS X @@ -134,6 +142,8 @@ Configure 'lager' log level in 'etc/emqttd.config', all MQTT messages recevied/s The install and boot process on Mac are same to Linux. +.. _install_on_windows: + --------------------- Installing on Windows --------------------- @@ -168,6 +178,8 @@ Uninstall emqttd service:: .. WARNING:: './bin/emqttd_ctl' command line cannot work on Windows. +.. _build_from_source: + ---------------------- Installing From Source ---------------------- @@ -194,6 +206,8 @@ The binary package output in folder:: rel/emqttd +.. _tcp_ports: + ------------------ TCP Ports Occupied ------------------ @@ -228,6 +242,8 @@ The TCP ports could be configured in etc/emqttd.config: The 18083 port is used by Web Dashboard of the broker. Default login: admin, Password: public +.. _quick_setup: + ----------- Quick Setup ----------- @@ -272,6 +288,7 @@ etc/emqttd.config文件listeners段落设置最大允许连接数: emqttd消息服务器详细设置，请参见文档: :ref:`config` +.. _init_d_emqttd: ------------------- /etc/init.d/emqttd