siproxd: add usage comments, examples to default UCI config
authorguidosarducci <guidosarducci@users.noreply.github.com>
Fri, 9 Mar 2018 07:17:30 +0000 (23:17 -0800)
committerguidosarducci <guidosarducci@users.noreply.github.com>
Sun, 18 Mar 2018 01:41:10 +0000 (18:41 -0700)
Explain default configuration options and potential firewall settings.
Provide examples of using documented siproxd configuration directives.

Signed-off-by: Tony Ambardar <itugrok@yahoo.com>
net/siproxd/files/siproxd.config

index be953eb854a2072595bad3c29e88c8485f6b2878..49b16ad86b4c731044603f45189e24185da4a11a 100644 (file)
@@ -1,3 +1,25 @@
 config siproxd general
+       # Custom options allow using OpenWRT network names, and defaults should
+       # work out-of-the-box. If your SIP devices do not REGISTER externally,
+       # you may also need to open firewall ports: tcp/udp 5060, udp 7070-7089.
        option interface_inbound lan
        option interface_outbound wan
+
+# All other documented siproxd configuration directives are supported. Use
+# a UCI 'option' for single-instance directives, and UCI 'list' entries for
+# directives that allow multiple instances, per the examples below.
+
+       # Define low-level network devices, overriding interface_in/outbound:
+#      option if_inbound eth0
+#      option if_outbound ppp0
+
+       # Enable DEBUG logging for configuration messages:
+#      option debug_level 0x00000100
+#      option silence_log 0
+
+       # Load two plugins: one that logs SIP call details to syslog, and one
+       # that strips out G.729, GSM codecs:
+#      list load_plugin 'plugin_logcall.so'
+#      list load_plugin 'plugin_codecfilter.so'
+#      list plugin_codecfilter_blacklist G729
+#      list plugin_codecfilter_blacklist GSM