yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc review

This commit is contained in:
Feng 2016-03-31 21:30:16 +08:00
parent e511f6d89c
commit ac9046bdce
3 changed files with 27 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/getstarted.rst
View File

@ -55,11 +55,11 @@ Quick Start
Download and Install 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. Download binary package from: http://emqtt.io/downloads.
Installing on Mac, For example: Installing on Mac, for example:
.. code:: console .. code:: console

2
docs/source/guide.rst
View File

@ -450,7 +450,7 @@ MQTT(SSL) Listener, Default Port is 8883::
HTTP Publish API 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 HTTP API: POST http://host:8083/mqtt/publish

31
docs/source/install.rst
View File

@ -1,17 +1,21 @@
======================= .. _install:
============
Installation 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:: .. NOTE::
Linux, FreeBSD Recommended. Linux, FreeBSD Recommended.
----------------- .. _install_download:
Download Package
----------------- ----------------
Download Package
----------------
Download binary package from: http://emqtt.io/downloads 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 For example: emqttd-centos64-0.16.0-beta-20160216.zip
.. _install_on_linux:
-------------------- --------------------
Installing on Linux Installing on Linux
-------------------- --------------------
@ -47,7 +53,7 @@ Start the broker in console mode::
cd emqttd && ./bin/emqttd console cd emqttd && ./bin/emqttd console
If the broker started successfully, console will print: If the broker is started successfully, console will print:
.. code:: console .. code:: console
@ -102,6 +108,7 @@ Stop the broker::
./bin/emqttd stop ./bin/emqttd stop
.. _install_on_freebsd:
--------------------- ---------------------
Installing 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. The installing process is same to Linux.
.. _install_on_mac:
---------------------- ----------------------
Installing on Mac OS X 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. The install and boot process on Mac are same to Linux.
.. _install_on_windows:
--------------------- ---------------------
Installing on Windows Installing on Windows
--------------------- ---------------------
@ -168,6 +178,8 @@ Uninstall emqttd service::
.. WARNING:: './bin/emqttd_ctl' command line cannot work on Windows. .. WARNING:: './bin/emqttd_ctl' command line cannot work on Windows.
.. _build_from_source:
---------------------- ----------------------
Installing From Source Installing From Source
---------------------- ----------------------
@ -194,6 +206,8 @@ The binary package output in folder::
rel/emqttd rel/emqttd
.. _tcp_ports:
------------------ ------------------
TCP Ports Occupied 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 The 18083 port is used by Web Dashboard of the broker. Default login: admin, Password: public
.. _quick_setup:
----------- -----------
Quick Setup Quick Setup
----------- -----------
@ -272,6 +288,7 @@ etc/emqttd.config文件listeners段落设置最大允许连接数:
emqttd消息服务器详细设置，请参见文档: :ref:`config` emqttd消息服务器详细设置，请参见文档: :ref:`config`
.. _init_d_emqttd:
------------------- -------------------
/etc/init.d/emqttd /etc/init.d/emqttd