MINIFICPP-1120 - clarify C2.md
Signed-off-by: Arpad Boda <aboda@apache.org>
This closes #711
diff --git a/C2.md b/C2.md
index c1b411e..b907926 100644
--- a/C2.md
+++ b/C2.md
@@ -45,12 +45,12 @@
For more more insight into the API used within the C2 agent, please visit:
https://cwiki.apache.org/confluence/display/MINIFI/C2+Design+Proposal
-Release 0.6.0: Please note that all c2 properties now exist as nifi.c2.* . If your configuration properties
-files contain the former naming convention of c2.*, we will continue to support that as
+Release 0.6.0: Please note that all c2 properties now exist as `nifi.c2.*`. If your configuration properties
+files contain the former naming convention of `c2.*`, we will continue to support that as
an alternate key, but you are encouraged to switch your configuration options as soon as possible.
- in minifi.properties
+ #in minifi.properties
# Disable/Enable C2
nifi.c2.enable=true
@@ -59,10 +59,10 @@
nifi.c2.root.classes=DeviceInfoNode,AgentInformation,FlowInformation
# specify C2 protocol -- default is CoapProtocol if not specified
- nifi.c2.agent.protocol.class=CoapProtocol
+ #nifi.c2.agent.protocol.class=CoapProtocol
# may also use MQTT or REST
# nifi.c2.agent.protocol.class=MQTTC2Protocol
- # nifi.c2.agent.protocol.class=RESTSender
+ nifi.c2.agent.protocol.class=RESTSender
# control c2 heartbeat interval in millisecocnds
nifi.c2.agent.heartbeat.period=250
@@ -71,18 +71,18 @@
nifi.c2.agent.heartbeat.reporter.class=RESTReciver
# specify the rest URIs if using RESTSender
- nifi.c2.rest.url=http://localhost:10080/minifi-c2-api/c2-protocol/heartbeat
- nifi.c2.rest.url.ack=http://localhost:10080/minifi-c2-api/c2-protocol/acknowledge
- nifi.c2.flow.base.url=http://localhost:10080/minifi-c2-api/c2-protocol/
+ nifi.c2.rest.url=http://<your-c2-server>/<c2-api-path>/c2-protocol/heartbeat
+ nifi.c2.rest.url.ack=http://<your-c2-server>/<c2-api-path>/c2-protocol/acknowledge
+ nifi.c2.flow.base.url=http://<your-c2-server>/<c2-api-path>/c2-protocol/
- # c2 agent identifier
+ # c2 agent identifier -- must be defined to run agent
nifi.c2.agent.identifier=<your identifier>
# c2 agent class -- must be defined to run agent
nifi.c2.agent.class=<your agent class>
# configure SSL Context service for REST Protocol
- nifi.c2.rest.ssl.context.service
+ #nifi.c2.rest.ssl.context.service
### Metrics
