summaryrefslogtreecommitdiff
path: root/configs
diff options
context:
space:
mode:
authorMatt Jordan <mjordan@digium.com>2017-03-14 09:55:06 -0500
committerJoshua Colp <jcolp@digium.com>2017-03-14 09:52:49 -0600
commitd31aa48d096727c3753a4cb6ea0e87f9b9c8350c (patch)
tree697677ef0973dd792b2660fefdabd72182bff6bd /configs
parent8af0a0f55d540626d7f2e87fcc5bfe231723be88 (diff)
configs/samples/hep.conf.sample: Clarify how the HEP stack works
This patch updates the documenation in hep.conf.sample to better specify how the various HEP modules interact. ASTERISK-26717 #close Change-Id: I337fb742a89e3ec5edc7fc7a7a0295218d841124
Diffstat (limited to 'configs')
-rw-r--r--configs/samples/hep.conf.sample10
1 files changed, 9 insertions, 1 deletions
diff --git a/configs/samples/hep.conf.sample b/configs/samples/hep.conf.sample
index e1cd52ebb..3d1e74139 100644
--- a/configs/samples/hep.conf.sample
+++ b/configs/samples/hep.conf.sample
@@ -2,6 +2,15 @@
; res_hep Module configuration for Asterisk
;
+;
+; Note that this configuration file is consumed by res_hep, which is responsible
+; for the HEPv3 protocol manipulation and managing the connection to the Homer
+; capture server. Additional modules provide specific messages to be sent to
+; the Homer server:
+; - res_hep_pjsip: Send SIP messages transmitted/received by the PJSIP stack
+; - res_hep_rtcp: Send RTCP information (all channels)
+;
+
; All settings are currently set in the general section.
[general]
enabled = no ; Enable/disable forwarding of packets to a
@@ -17,4 +26,3 @@ uuid_type = call-id ; Specify the preferred source for the Homer
; correlation UUID. Valid options are:
; - 'call-id' for the PJSIP SIP Call-ID
; - 'channel' for the Asterisk channel name
-