Skip to content

Commit

Permalink
Added structure for wss docs.
Browse files Browse the repository at this point in the history
(work in progress)
  • Loading branch information
bogdan-iancu committed Jan 20, 2016
1 parent 8d23d9b commit cc75a4c
Show file tree
Hide file tree
Showing 4 changed files with 213 additions and 0 deletions.
66 changes: 66 additions & 0 deletions modules/proto_wss/README
@@ -0,0 +1,66 @@
proto_wss Module

OpenSIPS Project

Edited by

Razvan Crainea

Copyright © 2016 OpenSIPS Project
__________________________________________________________

Table of Contents

1. Admin Guide

1.1. Overview
1.2. Dependencies

1.2.1. OpenSIPS Modules
1.2.2. Dependencies of external libraries

1.3. Exported Parameters

2. Frequently Asked Questions

Chapter 1. Admin Guide

1.1. Overview

TODO

1.2. Dependencies

1.2.1. OpenSIPS Modules

The following modules must be loaded before this module:
* tls_mgm.

1.2.2. Dependencies of external libraries

OpenSIPS TLS v1.0 support requires the following packages:
* openssl or libssl >= 0.9.6
* openssl-dev or libssl-dev

OpenSIPS TLS v1.1/1.2 support requires the following packages:
* openssl or libssl >= 1.0.1e
* openssl-dev or libssl-dev

1.3. Exported Parameters

TODO

Chapter 2. Frequently Asked Questions

2.1.

Can OpenSIPS act as a WebSocket client?

Yes, starting with OpenSIPS 2.2, it can act as a WebSocket
client.

2.2.

Does OpenSIPS support WebSocket message fragmentation?

No, WebSocket fragmentation mechanims is not supported.
45 changes: 45 additions & 0 deletions modules/proto_wss/doc/proto_wss.xml
@@ -0,0 +1,45 @@
<?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" [


<!ENTITY admin SYSTEM "proto_wss_admin.xml">
<!ENTITY faq SYSTEM "proto_wss_faq.xml">

<!-- Include general documentation entities -->
<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
%docentities;

]>

<book>
<bookinfo>
<title>proto_wss Module</title>
<productname class="trade">&osipsname;</productname>
<authorgroup>
<author>
<firstname>&osips;</firstname>
<surname>Project</surname>
<address>
<email>support@opensips.org</email>
</address>
</author>
<editor>
<firstname>Razvan</firstname>
<surname>Crainea</surname>
<address>
<email>razvan@opensips.org</email>
</address>
</editor>
</authorgroup>
<copyright>
<year>2016</year>
<holder>&osips; Project</holder>
</copyright>
</bookinfo>
<toc></toc>

&admin;
&faq;

</book>
69 changes: 69 additions & 0 deletions modules/proto_wss/doc/proto_wss_admin.xml
@@ -0,0 +1,69 @@
<!-- Module User's Guide -->

<chapter>

<title>&adminguide;</title>

<section>
<title>Overview</title>
<para>
TODO
</para>
</section>

<section>
<title>Dependencies</title>
<section>
<title>&osips; Modules</title>
<para>
The following modules must be loaded before this module:
<itemizedlist>
<listitem>
<para>
<emphasis>tls_mgm</emphasis>.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Dependencies of external libraries</title>
<para>
&osips; TLS v1.0 support requires the following packages:
<itemizedlist>
<listitem>
<para><emphasis>openssl</emphasis> or
<emphasis>libssl</emphasis> >= 0.9.6
</para>
</listitem>
<listitem>
<para><emphasis>openssl-dev</emphasis> or
<emphasis>libssl-dev</emphasis>
</para>
</listitem>
</itemizedlist>
</para>
<para>
&osips; TLS v1.1/1.2 support requires the following packages:
<itemizedlist>
<listitem>
<para><emphasis>openssl</emphasis> or
<emphasis>libssl</emphasis> >= 1.0.1e
</para>
</listitem>
<listitem>
<para><emphasis>openssl-dev</emphasis> or
<emphasis>libssl-dev</emphasis>
</para>
</listitem>
</itemizedlist>
</para>
</section>
</section>

<section>
<title>Exported Parameters</title>
TODO
</section>

</chapter>
33 changes: 33 additions & 0 deletions modules/proto_wss/doc/proto_wss_faq.xml
@@ -0,0 +1,33 @@
<!-- Module FAQ -->

<chapter>

<title>&faqguide;</title>
<qandaset defaultlabel="number">

<qandaentry>
<question>
<para>Can &osips; act as a WebSocket client?
</para>
</question>
<answer>
<para>
Yes, starting with &osips; 2.2, it can act as a WebSocket client.
</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para>Does &osips; support WebSocket message fragmentation?
</para>
</question>
<answer>
<para>
No, WebSocket fragmentation mechanims is not supported.
</para>
</answer>
</qandaentry>

</qandaset>
</chapter>

0 comments on commit cc75a4c

Please sign in to comment.