summaryrefslogtreecommitdiffstats
path: root/contrib/imczmq/README
blob: 369a82a1ea810f2a75e66c3cc4a6c76d6e0ad5ca (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
CZMQ Input Plugin

REQUIREMENTS:

* libsodium ( https://github.com/jedisct1/libsodium )
* zeromq v4.x build with libsodium support ( http://zeromq.org/ )
* czmq 3.x ( http://czmq.zeromq.org/ )

-------------------------------------------------------------------------------
module(
	load="imczmq"
	servercertpath="/etc/curve.d/server"
	clientcertpath="/etc/curve.d/"
	authtype="CURVESERVER"
	authenticator="on"
)

input(
	type="imczmq"
	endpoints="@tcp://*:24555"
	socktype="PULL"
)
-------------------------------------------------------------------------------

Explanation of Options:

Module
------
servercertpath: path to server cert if using CURVE
clientcertpath: path to client cert(s) if using CURVE
authtype: CURVESERVER, CURVECLIENT (omit for no auth)
authenticator: whether to start an authenticator thread

Action
------
type: type of action (imczmq for this plugin)
endpoints: comma delimited list of zeromq endpoints (see zeromq documentation)
socktype: zeromq socket type (currently supports PULL, SUB, ROUTER, DISH, SERVER)
authtype: CURVECLIENT or CURVESERVER