aboutsummaryrefslogtreecommitdiffstats
path: root/doc/example.ini
diff options
context:
space:
mode:
authorMatthias P. Braendli <matthias.braendli@mpb.li>2017-12-30 10:24:36 +0100
committerMatthias P. Braendli <matthias.braendli@mpb.li>2017-12-30 10:24:36 +0100
commit1dadf3b7856940911724d02613085d57535da474 (patch)
treef62544c7b2354a1ed684abce0920cebed057a66d /doc/example.ini
parentc56f572c1026a774bcec768821e64ac31354ceff (diff)
downloaddabmod-1dadf3b7856940911724d02613085d57535da474.tar.gz
dabmod-1dadf3b7856940911724d02613085d57535da474.tar.bz2
dabmod-1dadf3b7856940911724d02613085d57535da474.zip
Document RC in a separate file
Diffstat (limited to 'doc/example.ini')
-rw-r--r--doc/example.ini30
1 files changed, 2 insertions, 28 deletions
diff --git a/doc/example.ini b/doc/example.ini
index b3faffd..d04c1a7 100644
--- a/doc/example.ini
+++ b/doc/example.ini
@@ -1,39 +1,13 @@
; Sample configuration file for ODR-DabMod
[remotecontrol]
+; The RC feature is described in detail in doc/README-RC.md
+
; enable the telnet remote control on localhost:2121
-; Since this is totally unsecure telnet, the software
-; will only listen on the local loopback interface.
-; To get secure remote access, use SSH port forwarding
telnet=1
telnetport=2121
; Enable zmq remote control.
-; The zmq remote control is intended for machine-to-machine
-; integration. It may run in parallel with Telnet.
-;
-; Protocol:
-; ODR-DabMod binds a zmq rep socket so clients must connect
-; using either req or dealer socket.
-; [] denotes message part as zmq multi-part message are used for delimitation.
-; All message parts are utf-8 encoded strings and match the Telnet command set.
-; Messages to be sent as literal strings are denoted with "" below.
-;
-; The following commands are supported:
-; REQ: ["ping"]
-; REP: ["ok"]
-;
-; REQ: ["list"]
-; REP: ["ok"][module name][module name]...
-;
-; REQ: ["show"][module name]
-; REP: ["ok"][parameter: value][parameter: value]...
-;
-; REQ: ["get"][module name][parameter]
-; REP: [value] _OR_ ["fail"][error description]
-;
-; REQ: ["set"][module name][parameter][value]
-; REP: ["ok"] _OR_ ["fail"][error description]
zmqctrl=1
zmqctrlendpoint=tcp://127.0.0.1:9400