config and getstarted
This commit is contained in:
Feng
parent
dcd738dcb9
commit
09ab8bc446
|
|
@ -1,14 +1,33 @@
|
||||||
|
|
||||||
.. _configuration:
|
.. _configuration:
|
||||||
|
|
||||||
======================
|
=============
|
||||||
Configuration
|
Configuration
|
||||||
======================
|
=============
|
||||||
|
|
||||||
|
emqttd消息服务器通过etc/目录下配置文件进行设置，主要配置文件包括:
|
||||||
|
|
||||||
------------
|
+-------------------+-----------------------------------+
|
||||||
|
| 配置文件 | 说明 |
|
||||||
|
+-------------------+-----------------------------------+
|
||||||
|
| etc/vm.args | Erlang 虚拟机的参数设置 |
|
||||||
|
+-------------------+-----------------------------------+
|
||||||
|
| etc/emqttd.config | emqttd消息服务器参数设置 |
|
||||||
|
+-------------------+-----------------------------------+
|
||||||
|
| etc/acl.config | ACL(访问控制规则)设置 |
|
||||||
|
+-------------------+-----------------------------------+
|
||||||
|
| etc/clients.config| 基于ClientId认证设置 |
|
||||||
|
+-------------------+-----------------------------------+
|
||||||
|
| etc/rewrite.config| Rewrite扩展模块规则配置 |
|
||||||
|
+-------------------+-----------------------------------+
|
||||||
|
| etc/ssl/* | SSL证书设置 |
|
||||||
|
+-------------------+-----------------------------------+
|
||||||
|
|
||||||
|
-----------
|
||||||
etc/vm.args
|
etc/vm.args
|
||||||
------------
|
-----------
|
||||||
|
|
||||||
|
Configure parameters of Erlang VM:
|
||||||
|
|
||||||
.. code::
|
.. code::
|
||||||
|
|
||||||
|
|
@ -65,14 +84,650 @@ etc/vm.args
|
||||||
## Tweak GC to run more often
|
## Tweak GC to run more often
|
||||||
-env ERL_FULLSWEEP_AFTER 1000
|
-env ERL_FULLSWEEP_AFTER 1000
|
||||||
|
|
||||||
------------------
|
etc/vm.args中两个最重要的参数:
|
||||||
|
|
||||||
|
+-------+----------------------------------------------------------------------------------------------+
|
||||||
|
| +P | Erlang虚拟机允许的最大进程数，一个MQTT连接会消耗2个Erlang进程，所以参数值 > 最大连接数 * 2 |
|
||||||
|
+-------+----------------------------------------------------------------------------------------------+
|
||||||
|
| +Q | Erlang虚拟机允许的最大Port数量，一个MQTT连接消耗1个Port，所以参数值 > 最大连接数 |
|
||||||
|
+-------+----------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
|
etc/vm.args设置Erlang节点名、节点间通信Cookie::
|
||||||
|
|
||||||
|
-name emqttd@127.0.0.1
|
||||||
|
|
||||||
|
## Cookie for distributed erlang
|
||||||
|
-setcookie emqttdsecretcookie
|
||||||
|
|
||||||
|
.. NOTE::
|
||||||
|
|
||||||
|
Erlang/OTP平台应用多由分布的Erlang节点(进程)组成，每个Erlang节点(进程)需指配一个节点名，用于节点间通信互访。
|
||||||
|
所有互相通信的Erlang节点(进程)间通过一个共用的Cookie进行安全认证。
|
||||||
|
|
||||||
|
-----------------
|
||||||
etc/emqttd.config
|
etc/emqttd.config
|
||||||
------------------
|
-----------------
|
||||||
|
|
||||||
|
etc/emqttd.config是消息服务器的核心配置文件。Erlang程序由多个应用(application)组成，每个应用(application)有自身的环境参数，
|
||||||
|
|
||||||
Log Level
|
启动时候通过etc/emqttd.config文件加载。
|
||||||
-------------
|
|
||||||
|
etc/emqttd.config文件采用的是Erlang数据格式，kernel, sasl, emqttd是Erlang应用(application)名称，'[]'内是应用的环境参数列表。
|
||||||
|
|
||||||
|
.. code:: erlang
|
||||||
|
|
||||||
|
[{kernel, [
|
||||||
|
{start_timer, true},
|
||||||
|
{start_pg2, true}
|
||||||
|
]},
|
||||||
|
{sasl, [
|
||||||
|
{sasl_error_logger, {file, "log/emqttd_sasl.log"}}
|
||||||
|
]},
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
{emqttd, [
|
||||||
|
...
|
||||||
|
]}
|
||||||
|
].
|
||||||
|
|
||||||
|
emqttd.config格式简要说明:
|
||||||
|
|
||||||
|
1. [ ] : 列表，逗号分隔元素
|
||||||
|
|
||||||
|
2. { } : 元组，配置元组一般两个元素{Env, Value}
|
||||||
|
|
||||||
|
3. % : 注释
|
||||||
|
|
||||||
|
Log Level and Destination
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
emqttd消息服务器日志由lager应用(application)提供，日志相关设置在lager应用段落::
|
||||||
|
|
||||||
|
{lager, [
|
||||||
|
...
|
||||||
|
]},
|
||||||
|
|
||||||
|
产品环境下默认只开启error日志，日志输出到logs/emqttd_error.log文件。'handlers'段落启用其他级别日志::
|
||||||
|
|
||||||
|
{handlers, [
|
||||||
|
{lager_console_backend, info},
|
||||||
|
|
||||||
|
{lager_file_backend, [
|
||||||
|
{formatter_config, [time, " ", pid, " [",severity,"] ", message, "\n"]},
|
||||||
|
{file, "log/emqttd_info.log"},
|
||||||
|
{level, info},
|
||||||
|
{size, 104857600},
|
||||||
|
{date, "$D0"},
|
||||||
|
{count, 30}
|
||||||
|
]},
|
||||||
|
|
||||||
|
{lager_file_backend, [
|
||||||
|
{formatter_config, [time, " ", pid, " [",severity,"] ", message, "\n"]},
|
||||||
|
{file, "log/emqttd_error.log"},
|
||||||
|
{level, error},
|
||||||
|
{size, 104857600},
|
||||||
|
{date, "$D0"},
|
||||||
|
{count, 30}
|
||||||
|
]}
|
||||||
|
]}
|
||||||
|
|
||||||
|
.. WARNING:: 过多日志打印严重影响服务器性能，产品环境下建议开启error级别日志。
|
||||||
|
|
||||||
Broker Parameters
|
Broker Parameters
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
|
emqttd消息服务器参数设置在emqttd应用段落，包括用户认证与访问控制设置，MQTT协议、会话、队列设置，扩展模块设置，TCP服务监听器设置::
|
||||||
|
|
||||||
|
{emqttd, [
|
||||||
|
%% 用户认证与访问控制设置
|
||||||
|
{access, [
|
||||||
|
...
|
||||||
|
]},
|
||||||
|
%% MQTT连接、协议、会话、队列设置
|
||||||
|
{mqtt, [
|
||||||
|
...
|
||||||
|
]},
|
||||||
|
%% 消息服务器设置
|
||||||
|
{broker, [
|
||||||
|
...
|
||||||
|
]},
|
||||||
|
%% 扩展模块设置
|
||||||
|
{modules, [
|
||||||
|
...
|
||||||
|
]},
|
||||||
|
%% 插件目录设置
|
||||||
|
{plugins, [
|
||||||
|
...
|
||||||
|
]},
|
||||||
|
|
||||||
|
%% TCP监听器设置
|
||||||
|
{listeners, [
|
||||||
|
...
|
||||||
|
]},
|
||||||
|
|
||||||
|
%% Erlang虚拟机监控设置
|
||||||
|
{sysmon, [
|
||||||
|
]}
|
||||||
|
]}
|
||||||
|
|
||||||
|
access用户认证设置
|
||||||
|
------------------
|
||||||
|
|
||||||
|
emqttd消息服务器认证由一系列认证模块(module)或插件(plugin)提供，系统默认支持用户名、ClientID、LDAP、匿名(anonymouse)认证模块::
|
||||||
|
|
||||||
|
%% Authetication. Anonymous Default
|
||||||
|
{auth, [
|
||||||
|
%% Authentication with username, password
|
||||||
|
%% Add users: ./bin/emqttd_ctl users add Username Password
|
||||||
|
%% {username, [{"test", "public"}]},
|
||||||
|
|
||||||
|
%% Authentication with clientid
|
||||||
|
% {clientid, [{password, no}, {file, "etc/clients.config"}]},
|
||||||
|
|
||||||
|
%% Authentication with LDAP
|
||||||
|
% {ldap, [
|
||||||
|
% {servers, ["localhost"]},
|
||||||
|
% {port, 389},
|
||||||
|
% {timeout, 30},
|
||||||
|
% {user_dn, "uid=$u,ou=People,dc=example,dc=com"},
|
||||||
|
% {ssl, fasle},
|
||||||
|
% {sslopts, [
|
||||||
|
% {"certfile", "ssl.crt"},
|
||||||
|
% {"keyfile", "ssl.key"}]}
|
||||||
|
% ]},
|
||||||
|
|
||||||
|
%% Allow all
|
||||||
|
{anonymous, []}
|
||||||
|
]},
|
||||||
|
|
||||||
|
系统默认采用匿名认证(anonymous)，通过删除注释可开启其他认证方式。同时开启的多个认证模块组成认证链::
|
||||||
|
|
||||||
|
---------------- ---------------- ------------
|
||||||
|
Client --> | Username认证 | -ignore-> | ClientID认证 | -ignore-> | 匿名认证 |
|
||||||
|
---------------- ---------------- ------------
|
||||||
|
| | |
|
||||||
|
\|/ \|/ \|/
|
||||||
|
allow | deny allow | deny allow | deny
|
||||||
|
|
||||||
|
.. NOTE:: emqttd消息服务器还提供了MySQL、PostgreSQL、Redis、MongoDB认证插件，
|
||||||
|
认证插件加载后认证模块失效。
|
||||||
|
|
||||||
|
|
||||||
|
用户名密码认证
|
||||||
|
..............
|
||||||
|
|
||||||
|
.. code:: erlang
|
||||||
|
|
||||||
|
{username, [{test1, "passwd1"}, {test2, "passwd2"}]},
|
||||||
|
|
||||||
|
两种方式添加用户:
|
||||||
|
|
||||||
|
1. 直接在[]中明文配置默认用户::
|
||||||
|
|
||||||
|
[{test1, "passwd1"}, {test2, "passwd2"}]
|
||||||
|
|
||||||
|
2. 通过'./bin/emqttd_ctl'管理命令行添加用户::
|
||||||
|
|
||||||
|
$ ./bin/emqttd_ctl users add <Username> <Password>
|
||||||
|
|
||||||
|
ClientID认证
|
||||||
|
............
|
||||||
|
|
||||||
|
.. code:: erlang
|
||||||
|
|
||||||
|
{clientid, [{password, no}, {file, "etc/clients.config"}]},
|
||||||
|
|
||||||
|
etc/clients.config文件中添加ClientID::
|
||||||
|
|
||||||
|
testclientid0
|
||||||
|
testclientid1 127.0.0.1
|
||||||
|
testclientid2 192.168.0.1/24
|
||||||
|
|
||||||
|
|
||||||
|
LDAP认证
|
||||||
|
........
|
||||||
|
|
||||||
|
.. code:: erlang
|
||||||
|
|
||||||
|
{ldap, [
|
||||||
|
{servers, ["localhost"]},
|
||||||
|
{port, 389},
|
||||||
|
{timeout, 30},
|
||||||
|
{user_dn, "uid=$u,ou=People,dc=example,dc=com"},
|
||||||
|
{ssl, fasle},
|
||||||
|
{sslopts, [
|
||||||
|
{"certfile", "ssl.crt"},
|
||||||
|
{"keyfile", "ssl.key"}]}
|
||||||
|
]},
|
||||||
|
|
||||||
|
|
||||||
|
匿名认证
|
||||||
|
........
|
||||||
|
|
||||||
|
默认开启。允许任意客户端登录::
|
||||||
|
|
||||||
|
{anonymous, []}
|
||||||
|
|
||||||
|
|
||||||
|
access用户访问控制(ACL)
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
emqttd消息服务器支持基于etc/acl.config文件或MySQL、PostgreSQL插件的访问控制规则。
|
||||||
|
|
||||||
|
默认开启基于etc/acl.config文件的访问控制::
|
||||||
|
|
||||||
|
%% ACL config
|
||||||
|
{acl, [
|
||||||
|
%% Internal ACL module
|
||||||
|
{internal, [{file, "etc/acl.config"}, {nomatch, allow}]}
|
||||||
|
]}
|
||||||
|
|
||||||
|
etc/acl.config访问控制规则定义::
|
||||||
|
|
||||||
|
允许|拒绝 用户|IP地址|ClientID 发布|订阅 主题列表
|
||||||
|
|
||||||
|
etc/acl.config默认访问规则设置::
|
||||||
|
|
||||||
|
{allow, {user, "dashboard"}, subscribe, ["$SYS/#"]}.
|
||||||
|
|
||||||
|
{allow, {ipaddr, "127.0.0.1"}, pubsub, ["$SYS/#", "#"]}.
|
||||||
|
|
||||||
|
{deny, all, subscribe, ["$SYS/#", {eq, "#"}]}.
|
||||||
|
|
||||||
|
{allow, all}.
|
||||||
|
|
||||||
|
.. NOTE:: 默认规则只允许本机用户订阅'$SYS/#'与'#'
|
||||||
|
|
||||||
|
emqttd消息服务器接收到MQTT客户端发布(PUBLISH)或订阅(SUBSCRIBE)请求时，会逐条匹配ACL访问控制规则，
|
||||||
|
|
||||||
|
直到匹配成功返回allow或deny。
|
||||||
|
|
||||||
|
|
||||||
|
MQTT报文(Packet)尺寸与ClientID长度限制
|
||||||
|
--------------------------------------
|
||||||
|
|
||||||
|
'packet'段落设置最大报文尺寸、最大客户端ID长度::
|
||||||
|
|
||||||
|
{packet, [
|
||||||
|
|
||||||
|
%% ClientID长度, 默认1024
|
||||||
|
{max_clientid_len, 1024},
|
||||||
|
|
||||||
|
%% 最大报文长度，默认64K
|
||||||
|
{max_packet_size, 65536}
|
||||||
|
]},
|
||||||
|
|
||||||
|
|
||||||
|
MQTT客户端(Client)连接闲置时间
|
||||||
|
------------------------------
|
||||||
|
|
||||||
|
'client'段落设置客户端最大允许闲置时间(Socket连接建立，但未发送CONNECT报文)::
|
||||||
|
|
||||||
|
{client, [
|
||||||
|
%% 单位: 秒
|
||||||
|
{idle_timeout, 10}
|
||||||
|
]},
|
||||||
|
|
||||||
|
|
||||||
|
MQTT会话(Session)参数设置
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
'session'段落设置MQTT会话参数::
|
||||||
|
|
||||||
|
{session, [
|
||||||
|
%% Max number of QoS 1 and 2 messages that can be “in flight” at one time.
|
||||||
|
%% 0 means no limit
|
||||||
|
{max_inflight, 100},
|
||||||
|
|
||||||
|
%% Retry interval for redelivering QoS1/2 messages.
|
||||||
|
{unack_retry_interval, 20},
|
||||||
|
|
||||||
|
%% Awaiting PUBREL Timeout
|
||||||
|
{await_rel_timeout, 20},
|
||||||
|
|
||||||
|
%% Max Packets that Awaiting PUBREL, 0 means no limit
|
||||||
|
{max_awaiting_rel, 0},
|
||||||
|
|
||||||
|
%% Statistics Collection Interval(seconds)
|
||||||
|
{collect_interval, 20},
|
||||||
|
|
||||||
|
%% Expired after 2 days
|
||||||
|
{expired_after, 48}
|
||||||
|
|
||||||
|
]},
|
||||||
|
|
||||||
|
会话参数详细说明:
|
||||||
|
|
||||||
|
+----------------------+----------------------------------------------------------+
|
||||||
|
| max_inflight | 飞行窗口。最大允许同时下发的Qos1/2报文数，0表示没有限制。|
|
||||||
|
| | 窗口值越大，吞吐越高；窗口值越小，消息顺序越严格 |
|
||||||
|
+----------------------+----------------------------------------------------------+
|
||||||
|
| unack_retry_interval | 下发QoS1/2消息未收到PUBACK响应的重试间隔 |
|
||||||
|
+----------------------+----------------------------------------------------------+
|
||||||
|
| await_rel_timeout | 收到QoS2消息，等待PUBREL报文超时时间 |
|
||||||
|
+----------------------+----------------------------------------------------------+
|
||||||
|
| max_awaiting_rel | 最大等待PUBREL的QoS2报文数 |
|
||||||
|
+----------------------+----------------------------------------------------------+
|
||||||
|
| collect_interval | 采集会话统计数据间隔，默认0表示关闭统计 |
|
||||||
|
+----------------------+----------------------------------------------------------+
|
||||||
|
| expired_after | 持久会话到期时间，从客户端断开算起，单位：小时 |
|
||||||
|
+----------------------+----------------------------------------------------------+
|
||||||
|
|
||||||
|
MQTT会话消息队列(MQueue)设置
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
emqttd消息服务器会话通过队列缓存Qos1/Qos2消息:
|
||||||
|
|
||||||
|
1. 持久会话(Session)的离线消息
|
||||||
|
|
||||||
|
2. 飞行窗口满而延迟下发的消息
|
||||||
|
|
||||||
|
队列参数设置::
|
||||||
|
|
||||||
|
{queue, [
|
||||||
|
%% simple | priority
|
||||||
|
{type, simple},
|
||||||
|
|
||||||
|
%% Topic Priority: 0~255, Default is 0
|
||||||
|
%% {priority, [{"topic/1", 10}, {"topic/2", 8}]},
|
||||||
|
|
||||||
|
%% Max queue length. Enqueued messages when persistent client disconnected,
|
||||||
|
%% or inflight window is full.
|
||||||
|
{max_length, infinity},
|
||||||
|
|
||||||
|
%% Low-water mark of queued messages
|
||||||
|
{low_watermark, 0.2},
|
||||||
|
|
||||||
|
%% High-water mark of queued messages
|
||||||
|
{high_watermark, 0.6},
|
||||||
|
|
||||||
|
%% Queue Qos0 messages?
|
||||||
|
{queue_qos0, true}
|
||||||
|
]}
|
||||||
|
|
||||||
|
队列参数说明:
|
||||||
|
|
||||||
|
+----------------------+---------------------------------------------------+
|
||||||
|
| type | 队列类型。simple: 简单队列，priority: 优先级队列 |
|
||||||
|
+----------------------+---------------------------------------------------+
|
||||||
|
| priority | 主题(Topic)队列优先级设置 |
|
||||||
|
+----------------------+---------------------------------------------------+
|
||||||
|
| max_length | 队列长度, infinity表示不限制 |
|
||||||
|
+----------------------+---------------------------------------------------+
|
||||||
|
| low_watermark | 解除告警水位线 |
|
||||||
|
+----------------------+---------------------------------------------------+
|
||||||
|
| high_watermark | 队列满告警水位线 |
|
||||||
|
+----------------------+---------------------------------------------------+
|
||||||
|
| queue_qos0 | 是否缓存QoS0消息 |
|
||||||
|
+----------------------+---------------------------------------------------+
|
||||||
|
|
||||||
|
broker消息服务器参数
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
'broker'段落设置消息服务器内部模块参数。
|
||||||
|
|
||||||
|
sys_interval设置系统发布$SYS消息周期::
|
||||||
|
|
||||||
|
{sys_interval, 60},
|
||||||
|
|
||||||
|
broker retained消息设置
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
retained设置MQTT retain消息处理参数::
|
||||||
|
|
||||||
|
{retained, [
|
||||||
|
%% retain消息过期时间，单位: 秒
|
||||||
|
{expired_after, 0},
|
||||||
|
|
||||||
|
%% 最大retain消息数量
|
||||||
|
{max_message_num, 100000},
|
||||||
|
|
||||||
|
%% retain消息payload最大尺寸
|
||||||
|
{max_playload_size, 65536}
|
||||||
|
]},
|
||||||
|
|
||||||
|
+-----------------+-------------------------------------+
|
||||||
|
| expired_after | Retained消息过期时间，0表示永不过期 |
|
||||||
|
+-----------------+-------------------------------------+
|
||||||
|
| max_message_num | 最大存储的Retained消息数量 |
|
||||||
|
+-----------------+-------------------------------------+
|
||||||
|
| max_packet_size | Retained消息payload最大允许尺寸 |
|
||||||
|
+-----------------+-------------------------------------+
|
||||||
|
|
||||||
|
broker pubsub路由设置
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
发布/订阅(Pub/Sub)路由模块参数::
|
||||||
|
|
||||||
|
{pubsub, [
|
||||||
|
%% PubSub Erlang进程池
|
||||||
|
{pool_size, 8},
|
||||||
|
|
||||||
|
%% 订阅存储类型，ram: 内存, disc: 磁盘, false: 不保存
|
||||||
|
{subscription, ram},
|
||||||
|
|
||||||
|
%% 路由老化时间
|
||||||
|
{route_aging, 5}
|
||||||
|
]},
|
||||||
|
|
||||||
|
broker bridge桥接参数
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
桥接参数设置::
|
||||||
|
|
||||||
|
{bridge, [
|
||||||
|
%% 最大缓存桥接消息数
|
||||||
|
{max_queue_len, 10000},
|
||||||
|
|
||||||
|
%% 桥接节点宕机检测周期，单位: 秒
|
||||||
|
{ping_down_interval, 1}
|
||||||
|
]}
|
||||||
|
|
||||||
|
|
||||||
|
modules扩展模块设置
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
emqtt消息服务器支持简单的扩展模块，用于定制服务器功能。默认支持presence、subscription、rewrite模块。
|
||||||
|
|
||||||
|
'presence'扩展模块会向$SYS主题(Topic)发布客户端上下线消息::
|
||||||
|
|
||||||
|
{presence, [{qos, 0}]},
|
||||||
|
|
||||||
|
'subscription'扩展模块支持客户端上线时，自动订阅或恢复订阅某些主题(Topic)::
|
||||||
|
|
||||||
|
%% Subscribe topics automatically when client connected
|
||||||
|
{subscription, [
|
||||||
|
%% Subscription from stored table
|
||||||
|
stored,
|
||||||
|
|
||||||
|
%% $u will be replaced with username
|
||||||
|
{"$Q/username/$u", 1},
|
||||||
|
|
||||||
|
%% $c will be replaced with clientid
|
||||||
|
{"$Q/client/$c", 1}
|
||||||
|
]}
|
||||||
|
|
||||||
|
'rewrite'扩展模块支持重写主题(Topic)路径, 重写规则定义在etc/rewrite.config文件::
|
||||||
|
|
||||||
|
%% Rewrite rules
|
||||||
|
%% {rewrite, [{file, "etc/rewrite.config"}]}
|
||||||
|
|
||||||
|
关于扩展模块详细介绍，请参考<用户指南>文档。
|
||||||
|
|
||||||
|
plugins插件目录设置
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
.. code:: erlang
|
||||||
|
|
||||||
|
{plugins, [
|
||||||
|
%% Plugin App Library Dir
|
||||||
|
{plugins_dir, "./plugins"},
|
||||||
|
|
||||||
|
%% File to store loaded plugin names.
|
||||||
|
{loaded_file, "./data/loaded_plugins"}
|
||||||
|
]},
|
||||||
|
|
||||||
|
|
||||||
|
listeners监听器设置
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
emqttd消息服务器开启的MQTT协议、HTTP协议服务端，可通过listener设置TCP服务端口、最大允许连接数等参数。
|
||||||
|
|
||||||
|
emqttd消息服务器默认开启的TCP服务端口包括:
|
||||||
|
|
||||||
|
+-----------+-----------------------------------+
|
||||||
|
| 1883 | MQTT协议端口 |
|
||||||
|
+-----------+-----------------------------------+
|
||||||
|
| 8883 | MQTT(SSL)端口 |
|
||||||
|
+-----------+-----------------------------------+
|
||||||
|
| 8083 | MQTT(WebSocket), HTTP API端口 |
|
||||||
|
+-----------+-----------------------------------+
|
||||||
|
|
||||||
|
.. code:: erlang
|
||||||
|
|
||||||
|
{listeners, [
|
||||||
|
|
||||||
|
{mqtt, 1883, [
|
||||||
|
%% Size of acceptor pool
|
||||||
|
{acceptors, 16},
|
||||||
|
|
||||||
|
%% Maximum number of concurrent clients
|
||||||
|
{max_clients, 8192},
|
||||||
|
|
||||||
|
%% Socket Access Control
|
||||||
|
{access, [{allow, all}]},
|
||||||
|
|
||||||
|
%% Connection Options
|
||||||
|
{connopts, [
|
||||||
|
%% Rate Limit. Format is 'burst, rate', Unit is KB/Sec
|
||||||
|
%% {rate_limit, "100,10"} %% 100K burst, 10K rate
|
||||||
|
]},
|
||||||
|
|
||||||
|
%% Socket Options
|
||||||
|
{sockopts, [
|
||||||
|
%Set buffer if hight thoughtput
|
||||||
|
%{recbuf, 4096},
|
||||||
|
%{sndbuf, 4096},
|
||||||
|
%{buffer, 4096},
|
||||||
|
%{nodelay, true},
|
||||||
|
{backlog, 1024}
|
||||||
|
]}
|
||||||
|
]},
|
||||||
|
|
||||||
|
{mqtts, 8883, [
|
||||||
|
%% Size of acceptor pool
|
||||||
|
{acceptors, 4},
|
||||||
|
|
||||||
|
%% Maximum number of concurrent clients
|
||||||
|
{max_clients, 512},
|
||||||
|
|
||||||
|
%% Socket Access Control
|
||||||
|
{access, [{allow, all}]},
|
||||||
|
|
||||||
|
%% SSL certificate and key files
|
||||||
|
{ssl, [{certfile, "etc/ssl/ssl.crt"},
|
||||||
|
{keyfile, "etc/ssl/ssl.key"}]},
|
||||||
|
|
||||||
|
%% Socket Options
|
||||||
|
{sockopts, [
|
||||||
|
{backlog, 1024}
|
||||||
|
%{buffer, 4096},
|
||||||
|
]}
|
||||||
|
]},
|
||||||
|
%% WebSocket over HTTPS Listener
|
||||||
|
%% {https, 8083, [
|
||||||
|
%% %% Size of acceptor pool
|
||||||
|
%% {acceptors, 4},
|
||||||
|
%% %% Maximum number of concurrent clients
|
||||||
|
%% {max_clients, 512},
|
||||||
|
%% %% Socket Access Control
|
||||||
|
%% {access, [{allow, all}]},
|
||||||
|
%% %% SSL certificate and key files
|
||||||
|
%% {ssl, [{certfile, "etc/ssl/ssl.crt"},
|
||||||
|
%% {keyfile, "etc/ssl/ssl.key"}]},
|
||||||
|
%% %% Socket Options
|
||||||
|
%% {sockopts, [
|
||||||
|
%% %{buffer, 4096},
|
||||||
|
%% {backlog, 1024}
|
||||||
|
%% ]}
|
||||||
|
%%]},
|
||||||
|
|
||||||
|
%% HTTP and WebSocket Listener
|
||||||
|
{http, 8083, [
|
||||||
|
%% Size of acceptor pool
|
||||||
|
{acceptors, 4},
|
||||||
|
%% Maximum number of concurrent clients
|
||||||
|
{max_clients, 64},
|
||||||
|
%% Socket Access Control
|
||||||
|
{access, [{allow, all}]},
|
||||||
|
%% Socket Options
|
||||||
|
{sockopts, [
|
||||||
|
{backlog, 1024}
|
||||||
|
%{buffer, 4096},
|
||||||
|
]}
|
||||||
|
]}
|
||||||
|
]},
|
||||||
|
|
||||||
|
listener参数说明:
|
||||||
|
|
||||||
|
+-------------+-----------------------------------------------------------+
|
||||||
|
| acceptors | TCP Acceptor池 |
|
||||||
|
+-------------+-----------------------------------------------------------+
|
||||||
|
| max_clients | 最大允许TCP连接数 |
|
||||||
|
+-------------+-----------------------------------------------------------+
|
||||||
|
| access | 允许访问的IP地址段设置，例如: [{allow, "192.168.1.0/24"}] |
|
||||||
|
+-------------+-----------------------------------------------------------+
|
||||||
|
| connopts | 连接限速配置，例如限速10KB/秒: {rate_limit, "100,10"} |
|
||||||
|
+-------------+-----------------------------------------------------------+
|
||||||
|
| sockopts | Socket参数设置 |
|
||||||
|
+-------------+-----------------------------------------------------------+
|
||||||
|
|
||||||
|
.. _config_acl:
|
||||||
|
|
||||||
|
--------------
|
||||||
|
etc/acl.config
|
||||||
|
--------------
|
||||||
|
|
||||||
|
emqttd消息服务器默认访问控制规则配置在etc/acl.config文件。
|
||||||
|
|
||||||
|
访问控制规则采用Erlang元组格式，访问控制模块逐条匹配规则::
|
||||||
|
|
||||||
|
--------- --------- ---------
|
||||||
|
Client -> | Rule1 | --nomatch--> | Rule2 | --nomatch--> | Rule3 | --> Default
|
||||||
|
--------- --------- ---------
|
||||||
|
| | |
|
||||||
|
match match match
|
||||||
|
\|/ \|/ \|/
|
||||||
|
allow | deny allow | deny allow | deny
|
||||||
|
|
||||||
|
etc/acl.config文件默认规则设置::
|
||||||
|
|
||||||
|
%% 允许'dashboard'用户订阅 '$SYS/#'
|
||||||
|
{allow, {user, "dashboard"}, subscribe, ["$SYS/#"]}.
|
||||||
|
|
||||||
|
%% 允许本机用户发布订阅全部主题
|
||||||
|
{allow, {ipaddr, "127.0.0.1"}, pubsub, ["$SYS/#", "#"]}.
|
||||||
|
|
||||||
|
%% 拒绝用户订阅'$SYS#'与'#'主题
|
||||||
|
{deny, all, subscribe, ["$SYS/#", {eq, "#"}]}.
|
||||||
|
|
||||||
|
%% 上述规则无匹配，允许
|
||||||
|
{allow, all}.
|
||||||
|
|
||||||
|
.. _config_rewrite:
|
||||||
|
|
||||||
|
------------------
|
||||||
|
etc/rewrite.config
|
||||||
|
------------------
|
||||||
|
|
||||||
|
Rewrite扩展模块的规则配置文件，示例配置::
|
||||||
|
|
||||||
|
{topic, "x/#", [
|
||||||
|
{rewrite, "^x/y/(.+)$", "z/y/$1"},
|
||||||
|
{rewrite, "^x/(.+)$", "y/$1"}
|
||||||
|
]}.
|
||||||
|
|
||||||
|
{topic, "y/+/z/#", [
|
||||||
|
{rewrite, "^y/(.+)/z/(.+)$", "y/z/$2"}
|
||||||
|
]}.
|
||||||
|
|
|
||||||
|
|
@ -9,19 +9,45 @@ Get Started
|
||||||
Overview
|
Overview
|
||||||
--------
|
--------
|
||||||
|
|
||||||
emqttd is a massively scalable and clusterable MQTT V3.1/V3.1.1 broker written in Erlang/OTP.
|
emqttd(Erlang MQTT Broker) is an open source MQTT broker written in Erlang/OTP. Erlang/OTP is a concurrent, fault-tolerant, soft-realtime and distributed programming platform. MQTT is anextremely lightweight publish/subscribe messaging protocol powering IoT, M2M applications.
|
||||||
|
|
||||||
emqttd is aimed to provide a solid, enterprise grade, extensible open-source MQTT broker for IoT, M2M and Mobile applications that need to support ten millions of concurrent MQTT clients.
|
The emqttd project is aimed to implement a scalable, distributed, extensible open-source MQTT broker for IoT, M2M and Mobile applications that hope to handle ten millions of concurrent MQTT clients.
|
||||||
|
|
||||||
|
The emqttd broker is:
|
||||||
|
|
||||||
|
* Full MQTT V3.1/3.1.1 Protocol Specifications Support
|
||||||
|
* Easy to Install - Quick Install on Linux, FreeBSD, Mac and Windows
|
||||||
|
* Massively scalable - Scaling to 1 million connections on a single server
|
||||||
|
* Easy to extend - Hooks and plugins to customize or extend the broker
|
||||||
|
* Pluggable Authentication - LDAP, MySQL, PostgreSQL, Redis Authentication Plugins
|
||||||
|
|
||||||
* Easy to install
|
|
||||||
* Massively scalable
|
|
||||||
* Easy to extend
|
|
||||||
* Solid stable
|
|
||||||
|
|
||||||
--------
|
--------
|
||||||
Features
|
Features
|
||||||
--------
|
--------
|
||||||
|
|
||||||
|
* Full MQTT V3.1/V3.1.1 protocol specification support
|
||||||
|
* QoS0, QoS1, QoS2 Publish and Subscribe
|
||||||
|
* Session Management and Offline Messages
|
||||||
|
* Retained Message
|
||||||
|
* Last Will Message
|
||||||
|
* TCP/SSL Connection
|
||||||
|
* MQTT Over Websocket(SSL)
|
||||||
|
* HTTP Publish API
|
||||||
|
* STOMP protocol
|
||||||
|
* STOMP over SockJS
|
||||||
|
* $SYS/# Topics
|
||||||
|
* Client Authentication with clientId, ipaddress
|
||||||
|
* Client Authentication with username, password
|
||||||
|
* Client ACL control with ipaddress, clientid, username
|
||||||
|
* LDAP, Redis, MySQL, PostgreSQL authentication
|
||||||
|
* Cluster brokers on several servers.
|
||||||
|
* Bridge brokers locally or remotely
|
||||||
|
* mosquitto, RSMB bridge
|
||||||
|
* Extensible architecture with Hooks, Modules and Plugins
|
||||||
|
* Passed eclipse paho interoperability tests
|
||||||
|
|
||||||
|
|
||||||
-----------
|
-----------
|
||||||
Quick Start
|
Quick Start
|
||||||
-----------
|
-----------
|
||||||
|
|
@ -29,7 +55,7 @@ Quick Start
|
||||||
Download and Install
|
Download and Install
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
Download binary packeges for Linux, Mac, FreeBSD and Windows from http://emqtt.io/downloads.
|
Download binary package for Linux, Mac, FreeBSD and Windows platform from http://emqtt.io/downloads.
|
||||||
|
|
||||||
.. code:: console
|
.. code:: console
|
||||||
|
|
||||||
|
|
@ -44,8 +70,10 @@ Download binary packeges for Linux, Mac, FreeBSD and Windows from http://emqtt.i
|
||||||
# Stop emqttd
|
# Stop emqttd
|
||||||
./bin/emqttd stop
|
./bin/emqttd stop
|
||||||
|
|
||||||
Build from Source
|
Installing from Source
|
||||||
-----------------
|
-----------------------
|
||||||
|
|
||||||
|
.. NOTE:: emqttd requires Erlang R17+ to build.
|
||||||
|
|
||||||
.. code:: console
|
.. code:: console
|
||||||
|
|
||||||
|
|
@ -60,71 +88,108 @@ Web Dashboard
|
||||||
.. image:: ./_static/images/dashboard.png
|
.. image:: ./_static/images/dashboard.png
|
||||||
|
|
||||||
|
|
||||||
--------------------
|
-------------------
|
||||||
Features List
|
|
||||||
--------------------
|
|
||||||
|
|
||||||
* Full MQTT V3.1/V3.1.1 protocol specification support
|
|
||||||
* QoS0, QoS1, QoS2 Publish and Subscribe
|
|
||||||
* Session Management and Offline Messages
|
|
||||||
* Retained Messages Support
|
|
||||||
* Last Will Message Support
|
|
||||||
* TCP/SSL Connection Support
|
|
||||||
* MQTT Over Websocket(SSL) Support
|
|
||||||
* HTTP Publish API Support
|
|
||||||
* [$SYS/brokers/#](https://github.com/emqtt/emqtt/wiki/$SYS-Topics-of-Broker) Support
|
|
||||||
* Client Authentication with clientId, ipaddress
|
|
||||||
* Client Authentication with username, password.
|
|
||||||
* Client ACL control with ipaddress, clientid, username.
|
|
||||||
* Cluster brokers on several servers.
|
|
||||||
* [Bridge](https://github.com/emqtt/emqttd/wiki/Bridge) brokers locally or remotely
|
|
||||||
* 500K+ concurrent clients connections per server
|
|
||||||
* Extensible architecture with Hooks, Modules and Plugins
|
|
||||||
* Passed eclipse paho interoperability tests
|
|
||||||
|
|
||||||
--------------------
|
|
||||||
Modules and Plugins
|
Modules and Plugins
|
||||||
--------------------
|
-------------------
|
||||||
|
|
||||||
|
The emqttd broker could be extended by modules and plugins.
|
||||||
|
|
||||||
Modules
|
Modules
|
||||||
--------
|
-------
|
||||||
|
|
||||||
* [emqttd_auth_clientid](https://github.com/emqtt/emqttd/wiki/Authentication) - Authentication with ClientIds
|
+-------------------------+-----------------------------------+
|
||||||
* [emqttd_auth_username](https://github.com/emqtt/emqttd/wiki/Authentication) - Authentication with Username and Password
|
| emqttd_auth_clientid | ClientId认证 |
|
||||||
* [emqttd_auth_ldap](https://github.com/emqtt/emqttd/wiki/Authentication) - Authentication with LDAP
|
+-------------------------+-----------------------------------+
|
||||||
* [emqttd_mod_presence](https://github.com/emqtt/emqttd/wiki/Presence) - Publish presence message to $SYS topics when client connected or disconnected
|
| emqttd_auth_username | 用户名密码认证 |
|
||||||
* emqttd_mod_autosub - Subscribe topics when client connected
|
+-------------------------+-----------------------------------+
|
||||||
* [emqttd_mod_rewrite](https://github.com/emqtt/emqttd/wiki/Rewrite) - Topics rewrite like HTTP rewrite module
|
| emqttd_auth_ldap | LDAP认证 |
|
||||||
|
+-------------------------+-----------------------------------+
|
||||||
|
| emqttd_mod_presence | 客户端上下线状态消息发布 |
|
||||||
|
+-------------------------+-----------------------------------+
|
||||||
|
| emqttd_mod_subscription | 客户端上线自动主题订阅 |
|
||||||
|
+-------------------------+-----------------------------------+
|
||||||
|
| emqttd_mod_rewrite | 重写客户端订阅主题(Topic) |
|
||||||
|
+-------------------------+-----------------------------------+
|
||||||
|
|
||||||
|
扩展模块通过'etc/emqttd.config'配置文件的auth, modules段落启用。
|
||||||
|
|
||||||
|
例如启用用户名密码认证::
|
||||||
|
|
||||||
|
{access, [
|
||||||
|
%% Authetication. Anonymous Default
|
||||||
|
{auth, [
|
||||||
|
%% Authentication with username, password
|
||||||
|
{username, []},
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
启用客户端状态发布模块::
|
||||||
|
|
||||||
|
{modules, [
|
||||||
|
%% Client presence management module.
|
||||||
|
%% Publish messages when client connected or disconnected
|
||||||
|
{presence, [{qos, 0}]}
|
||||||
|
|
||||||
Plugins
|
Plugins
|
||||||
--------
|
--------
|
||||||
|
|
||||||
* [emqttd_plugin_template](https://github.com/emqtt/emqttd_plugin_template) - Plugin template and demo
|
+-------------------------+-----------------------------------+
|
||||||
* [emqttd_dashboard](https://github.com/emqtt/emqttd_dashboard) - Web Dashboard
|
| emqttd_plugin_template | 插件模版与演示代码 |
|
||||||
* [emqttd_plugin_mysql](https://github.com/emqtt/emqttd_plugin_mysql) - Authentication with MySQL
|
+-------------------------+-----------------------------------+
|
||||||
* [emqttd_plugin_pgsql](https://github.com/emqtt/emqttd_plugin_pgsql) - Authentication with PostgreSQL
|
| emqttd_dashboard | Web管理控制台，默认加载 |
|
||||||
* [emqttd_plugin_kafka](https://github.com/emqtt/emqtt_kafka) - Publish MQTT Messages to Kafka
|
+-------------------------+-----------------------------------+
|
||||||
* [emqttd_plugin_redis](https://github.com/emqtt/emqttd_plugin_redis) - Redis Plugin
|
| emqttd_plugin_mysql | MySQL认证插件 |
|
||||||
* [emqttd_plugin_mongo](https://github.com/emqtt/emqttd_plugin_mongo) - MongoDB Plugin
|
+-------------------------+-----------------------------------+
|
||||||
* [emqttd_stomp](https://github.com/emqtt/emqttd_stomp) - Stomp Protocol Plugin
|
| emqttd_plugin_pgsql | PostgreSQL认证插件 |
|
||||||
* [emqttd_sockjs](https://github.com/emqtt/emqttd_sockjs) - SockJS(Stomp) Plugin
|
+-------------------------+-----------------------------------+
|
||||||
* [emqttd_recon](https://github.com/emqtt/emqttd_recon) - Recon Plugin
|
| emqttd_plugin_redis | Redis认证插件 |
|
||||||
|
+-------------------------+-----------------------------------+
|
||||||
|
| emqttd_plugin_mongo | MongoDB认证插件 |
|
||||||
|
+-------------------------+-----------------------------------+
|
||||||
|
| emqttd_stomp | Stomp协议插件 |
|
||||||
|
+-------------------------+-----------------------------------+
|
||||||
|
| emqttd_sockjs | SockJS插件 |
|
||||||
|
+-------------------------+-----------------------------------+
|
||||||
|
| emqttd_recon | Recon优化调测插件 |
|
||||||
|
+-------------------------+-----------------------------------+
|
||||||
|
|
||||||
|
扩展插件通过'bin/emqttd_ctl'管理命令行，加载启动运行。
|
||||||
|
|
||||||
|
例如启用PostgreSQL认证插件::
|
||||||
|
|
||||||
|
./bin/emqttd_ctl plugins load emqttd_plugin_pgsql
|
||||||
|
|
||||||
----------------------------------
|
----------------------------------
|
||||||
One million Connections
|
One million Connections
|
||||||
----------------------------------
|
----------------------------------
|
||||||
|
|
||||||
|
.. NOTE::
|
||||||
|
|
||||||
|
emqttd消息服务器默认设置，允许最大客户端连接是512，因为大部分操作系统'ulimit -n'限制为1024。
|
||||||
|
|
||||||
|
emqttd消息服务器当前版本，连接压力测试到130万线，8核心/32G内存的CentOS云服务器。
|
||||||
|
|
||||||
|
操作系统内核参数、TCP协议栈参数、Erlang虚拟机参数、emqttd最大允许连接数设置简述如下：
|
||||||
|
|
||||||
Linux Kernel Parameters
|
Linux Kernel Parameters
|
||||||
-----------------------
|
-----------------------
|
||||||
|
|
||||||
|
# 2M - 系统所有进程可打开的文件数量::
|
||||||
|
|
||||||
.. code::
|
.. code::
|
||||||
|
|
||||||
sysctl -w fs.file-max=2097152
|
sysctl -w fs.file-max=2097152
|
||||||
sysctl -w fs.nr_open=2097152
|
sysctl -w fs.nr_open=2097152
|
||||||
|
|
||||||
|
# 1M - 系统允许当前进程打开的文件数量::
|
||||||
|
|
||||||
|
ulimit -n 1048576
|
||||||
|
|
||||||
TCP Stack Parameters
|
TCP Stack Parameters
|
||||||
-----------------------
|
-----------------------
|
||||||
|
|
||||||
|
# backlog - Socket监听队列长度::
|
||||||
|
|
||||||
.. code::
|
.. code::
|
||||||
|
|
||||||
sysctl -w net.core.somaxconn=65536
|
sysctl -w net.core.somaxconn=65536
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue