Module: sip-router Branch: master Commit: 02718defd1785fe5b94255077a9945354ee6cc19 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=02718de… Author: Peter Dunkley &lt;peter.dunkley(a)crocodile-rcs.com&gt; Committer: Peter Dunkley &lt;peter.dunkley(a)crocodile-rcs.com&gt; Date: Fri Mar 29 21:45:45 2013 +0000 modules/stun: Module documentation for STUN --- modules/stun/README | 71 +++++++++++++++++++++++++++++++++++++++ modules/stun/doc/Makefile | 4 ++ modules/stun/doc/stun.xml | 37 ++++++++++++++++++++ modules/stun/doc/stun_admin.xml | 67 ++++++++++++++++++++++++++++++++++++ 4 files changed, 179 insertions(+), 0 deletions(-) diff --git a/modules/stun/README b/modules/stun/README new file mode 100644 index 0000000..5d223fe --- /dev/null +++ b/modules/stun/README @@ -0,0 +1,71 @@ +STUN Module + +Peter Dunkley + + Crocodile RCS Ltd + + Copyright © 2012 Crocodile RCS Ltd + + Copyright © 2001-2003 FhG Fokus + __________________________________________________________________ + + Table of Contents + + 1. Admin Guide + + 1. Overview + 2. Dependencies + + 2.1. Kamailio Modules + 2.2. External Libraries or Applications + + 3. Parameters + 4. Functions + 5. MI Commands + +Chapter 1. Admin Guide + + Table of Contents + + 1. Overview + 2. Dependencies + + 2.1. Kamailio Modules + 2.2. External Libraries or Applications + + 3. Parameters + 4. Functions + 5. MI Commands + +1. Overview + + This module provides limited STUN server (RFC 5389) support for + Kamailio. + +2. Dependencies + + 2.1. Kamailio Modules + 2.2. External Libraries or Applications + +2.1. Kamailio Modules + + The following modules must be loaded before this module: + * None + +2.2. External Libraries or Applications + + The following libraries must be installed before running Kamailio with + this module loaded: + * OpenSSL. + +3. Parameters + + None + +4. Functions + + None + +5. MI Commands + + None diff --git a/modules/stun/doc/Makefile b/modules/stun/doc/Makefile new file mode 100644 index 0000000..51ff7d1 --- /dev/null +++ b/modules/stun/doc/Makefile @@ -0,0 +1,4 @@ +docs = stun.xml + +docbook_dir = ../../../docbook +include $(docbook_dir)/Makefile.module diff --git a/modules/stun/doc/stun.xml b/modules/stun/doc/stun.xml new file mode 100644 index 0000000..2cb9584 --- /dev/null +++ b/modules/stun/doc/stun.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding='ISO-8859-1'?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" +"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ + +<!-- Include general documentation entities --> +<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml"> +%docentities; + +]> + +<book xmlns:xi="http://www.w3.org/2001/XInclude"> + <bookinfo> + <title>STUN Module</title> + <productname class="trade">&kamailioname;</productname> + <authorgroup> + <author> + <firstname>Peter</firstname> + <surname>Dunkley</surname> + <affiliation><orgname>Crocodile RCS Ltd</orgname></affiliation> + <address> + &lt;email&gt;peter.dunkley(a)crocodile-rcs.com&lt;/email&gt; + </address> + </author> + </authorgroup> + <copyright> + <year>2012</year> + <holder>Crocodile RCS Ltd</holder> + </copyright> + <copyright> + <year>2001-2003</year> + <holder>FhG Fokus</holder> + </copyright> + </bookinfo> + <toc></toc> + + <xi:include href="stun_admin.xml"/> +</book> diff --git a/modules/stun/doc/stun_admin.xml b/modules/stun/doc/stun_admin.xml new file mode 100644 index 0000000..5aa9bd5 --- /dev/null +++ b/modules/stun/doc/stun_admin.xml @@ -0,0 +1,67 @@ +<?xml version="1.0" encoding='ISO-8859-1'?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" +"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ + +<!-- Include general documentation entities --> +<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml"> +%docentities; + +]> +<!-- Module User's Guide --> + +<chapter> + + <title>&adminguide;</title> + + <section> + <title>Overview</title> + <para>This module provides limited STUN server (RFC 5389) support for + &kamailio;.</para> + </section> + + <section> + <title>Dependencies</title> + <section> + <title>&kamailio; Modules</title> + <para> + The following modules must be loaded before this module: + <itemizedlist> + <listitem> + <para><emphasis>None</emphasis></para> + </listitem> + </itemizedlist> + </para> + </section> + + <section> + <title>External Libraries or Applications</title> + <para> + The following libraries must be installed before running + &kamailio; with this module loaded: + <itemizedlist> + <listitem> + <para><emphasis>OpenSSL</emphasis>.</para> + </listitem> + </itemizedlist> + </para> + </section> + </section> + + + <section> + <title>Parameters</title> + <para><emphasis>None</emphasis></para> + </section> + + <section> + <title>Functions</title> + <para><emphasis>None</emphasis></para> + </section> + + <section> + <title>MI Commands</title> + <para><emphasis>None</emphasis></para> + </section> + +</chapter> +