Skip to content

Commit

Permalink
Rebuild documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@opensips-github
opensips-github committed Jan 23, 2021
1 parent d800f05 commit cdbacb9
Show file tree
Hide file tree
Showing 16 changed files with 189 additions and 139 deletions.
6 changes: 3 additions & 3 deletions modules/b2b_logic/README
View file
Expand Up @@ -683,7 +683,7 @@ Chapter 3. Contributors
Name DevScore Commits Lines ++ Lines --
1. Anca Vamanu 209 98 9008 2213
2. Ovidiu Sas (@ovidiusas) 145 101 2915 1129
3. Bogdan-Andrei Iancu (@bogdan-iancu) 38 32 216 194
3. Bogdan-Andrei Iancu (@bogdan-iancu) 39 33 231 204
4. Razvan Crainea (@razvancrainea) 29 20 519 173
5. Liviu Chircu (@liviuchircu) 14 11 54 99
6. Nick Altmann (@nikbyte) 14 6 461 199
Expand Down Expand Up @@ -714,8 +714,8 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Liviu Chircu (@liviuchircu) Mar 2014 - Jul 2020
2. Bogdan-Andrei Iancu (@bogdan-iancu) Aug 2009 - Jun 2020
1. Bogdan-Andrei Iancu (@bogdan-iancu) Aug 2009 - Jan 2021
2. Liviu Chircu (@liviuchircu) Mar 2014 - Jul 2020
3. Zero King (@l2dy) Mar 2020 - Mar 2020
4. Peter Lemenkov (@lemenkov) Feb 2020 - Feb 2020
5. Razvan Crainea (@razvancrainea) Jun 2011 - Sep 2019
Expand Down
16 changes: 8 additions & 8 deletions modules/b2b_logic/doc/contributors.xml
View file
Expand Up @@ -37,10 +37,10 @@
<row>
<entry>3. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">38</entry>
<entry align="center">32</entry>
<entry align="center">216</entry>
<entry align="center">194</entry>
<entry align="center">39</entry>
<entry align="center">33</entry>
<entry align="center">231</entry>
<entry align="center">204</entry>
</row>
<row>
<entry>4. </entry>
Expand Down Expand Up @@ -128,13 +128,13 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Mar 2014 - Jul 2020</entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Aug 2009 - Jan 2021</entry>
</row>
<row>
<entry>2. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Aug 2009 - Jun 2020</entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Mar 2014 - Jul 2020</entry>
</row>
<row>
<entry>3. </entry>
Expand Down
6 changes: 3 additions & 3 deletions modules/dialog/README
View file
Expand Up @@ -2076,7 +2076,7 @@ Chapter 4. Contributors
Name DevScore Commits Lines ++ Lines --
1. Bogdan-Andrei Iancu (@bogdan-iancu) 396 250 11749 2953
2. Vlad Paiu (@vladpaiu) 236 134 6171 2950
3. Razvan Crainea (@razvancrainea) 173 134 3219 714
3. Razvan Crainea (@razvancrainea) 174 135 3242 725
4. Liviu Chircu (@liviuchircu) 138 97 2718 1044
5. Vlad Patrascu (@rvlad-patrascu) 115 69 2448 1414
6. Ovidiu Sas (@ovidiusas) 28 22 486 110
Expand Down Expand Up @@ -2118,8 +2118,8 @@ Chapter 4. Contributors

Table 4.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Bogdan-Andrei Iancu (@bogdan-iancu) Apr 2006 - Jan 2021
2. Razvan Crainea (@razvancrainea) Aug 2010 - Jan 2021
1. Razvan Crainea (@razvancrainea) Aug 2010 - Jan 2021
2. Bogdan-Andrei Iancu (@bogdan-iancu) Apr 2006 - Jan 2021
3. Ovidiu Sas (@ovidiusas) Feb 2008 - Sep 2020
4. Liviu Chircu (@liviuchircu) Aug 2012 - Aug 2020
5. Vlad Patrascu (@rvlad-patrascu) Jul 2016 - Jul 2020
Expand Down
16 changes: 8 additions & 8 deletions modules/dialog/doc/contributors.xml
View file
Expand Up @@ -37,10 +37,10 @@
<row>
<entry>3. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">173</entry>
<entry align="center">134</entry>
<entry align="center">3219</entry>
<entry align="center">714</entry>
<entry align="center">174</entry>
<entry align="center">135</entry>
<entry align="center">3242</entry>
<entry align="center">725</entry>
</row>
<row>
<entry>4. </entry>
Expand Down Expand Up @@ -128,13 +128,13 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Apr 2006 - Jan 2021</entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Aug 2010 - Jan 2021</entry>
</row>
<row>
<entry>2. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Aug 2010 - Jan 2021</entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Apr 2006 - Jan 2021</entry>
</row>
<row>
<entry>3. </entry>
Expand Down
2 changes: 1 addition & 1 deletion modules/proto_bin/README
View file
Expand Up @@ -190,7 +190,7 @@ Chapter 2. Contributors
1. Razvan Crainea (@razvancrainea) 16 14 36 19
2. Ionel Cerghit (@ionel-cerghit) 14 3 1196 38
3. Liviu Chircu (@liviuchircu) 7 5 31 43
4. Bogdan-Andrei Iancu (@bogdan-iancu) 6 4 17 2
4. Bogdan-Andrei Iancu (@bogdan-iancu) 7 5 19 4
5. Eseanu Marius Cristian (@eseanucristian) 4 2 1 5
6. Vlad Patrascu (@rvlad-patrascu) 2 1 1 0

Expand Down
6 changes: 3 additions & 3 deletions modules/proto_bin/doc/contributors.xml
View file
Expand Up @@ -45,10 +45,10 @@
<row>
<entry>4. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">6</entry>
<entry align="center">7</entry>
<entry align="center">5</entry>
<entry align="center">19</entry>
<entry align="center">4</entry>
<entry align="center">17</entry>
<entry align="center">2</entry>
</row>
<row>
<entry>5. </entry>
Expand Down
8 changes: 4 additions & 4 deletions modules/proto_hep/README
View file
Expand Up @@ -355,7 +355,7 @@ Chapter 3. Contributors
Name DevScore Commits Lines ++ Lines --
1. Ionut Ionita (@ionutrazvanionita) 148 66 8047 998
2. Razvan Crainea (@razvancrainea) 24 22 61 37
3. Bogdan-Andrei Iancu (@bogdan-iancu) 16 14 64 26
3. Bogdan-Andrei Iancu (@bogdan-iancu) 17 15 66 28
4. Liviu Chircu (@liviuchircu) 11 9 40 50
5. Walter Doekes (@wdoekes) 3 1 1 1
6. Vlad Patrascu (@rvlad-patrascu) 2 1 1 0
Expand All @@ -381,9 +381,9 @@ Chapter 3. Contributors
Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Razvan Crainea (@razvancrainea) Nov 2015 - Jul 2020
2. Bogdan-Andrei Iancu (@bogdan-iancu) Jan 2017 - Jun 2020
3. Walter Doekes (@wdoekes) May 2020 - May 2020
4. Liviu Chircu (@liviuchircu) Mar 2016 - Mar 2020
2. Walter Doekes (@wdoekes) May 2020 - May 2020
3. Liviu Chircu (@liviuchircu) Mar 2016 - Mar 2020
4. Bogdan-Andrei Iancu (@bogdan-iancu) Jan 2017 - May 2019
5. Vlad Patrascu (@rvlad-patrascu) May 2017 - May 2017
6. Ionut Ionita (@ionutrazvanionita) Oct 2015 - Apr 2017

Expand Down
20 changes: 10 additions & 10 deletions modules/proto_hep/doc/contributors.xml
View file
Expand Up @@ -37,10 +37,10 @@
<row>
<entry>3. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">16</entry>
<entry align="center">14</entry>
<entry align="center">64</entry>
<entry align="center">26</entry>
<entry align="center">17</entry>
<entry align="center">15</entry>
<entry align="center">66</entry>
<entry align="center">28</entry>
</row>
<row>
<entry>4. </entry>
Expand Down Expand Up @@ -101,19 +101,19 @@
</row>
<row>
<entry>2. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Jan 2017 - Jun 2020</entry>
</row>
<row>
<entry>3. </entry>
<entry>Walter Doekes (<ulink url="https://github.com/wdoekes">@wdoekes</ulink>)</entry>
<entry align="center">May 2020 - May 2020</entry>
</row>
<row>
<entry>4. </entry>
<entry>3. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Mar 2016 - Mar 2020</entry>
</row>
<row>
<entry>4. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Jan 2017 - May 2019</entry>
</row>
<row>
<entry>5. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
Expand Down
69 changes: 47 additions & 22 deletions modules/proto_tls/README
View file
Expand Up @@ -20,9 +20,10 @@ proto_tls module
1.5.3. tls_crlf_pingpong (integer)
1.5.4. tls_crlf_drop (integer)
1.5.5. tls_max_msg_chunks (integer)
1.5.6. trace_destination (string)
1.5.7. trace_on (int)
1.5.8. trace_filter_route (string)
1.5.6. cert_check_on_conn_reusage (integer)
1.5.7. trace_destination (string)
1.5.8. trace_on (int)
1.5.9. trace_filter_route (string)

1.6. Exported MI Functions

Expand Down Expand Up @@ -52,9 +53,10 @@ proto_tls module
1.3. Set tls_crlf_pingpong parameter
1.4. Set tls_crlf_drop parameter
1.5. Set tls_max_msg_chunks parameter
1.6. Set trace_destination parameter
1.7. Set trace_on parameter
1.8. Set trace_filter_route parameter
1.6. Set cert_check_on_conn_reusage parameter
1.7. Set trace_destination parameter
1.8. Set trace_on parameter
1.9. Set trace_filter_route parameter

Chapter 1. Admin Guide

Expand Down Expand Up @@ -271,7 +273,30 @@ modparam("proto_tls", "tls_crlf_drop", 1)
modparam("proto_tls", "tls_max_msg_chunks", 8)
...

1.5.6. trace_destination (string)
1.5.6. cert_check_on_conn_reusage (integer)

This parameter turns on or off the extra checking/matching of
the TLS domain (SSL certificate) when comes to reusing an
existing TLS connection. Without this extra check, only IP and
port of the connections will be check (in order to re-use an
existing connection). With this extra check, the connection to
be reused must have the same SSL certificate as the one set for
the current signaling operation.

This checking is done only when comes to send SIP traffic via
TLS and it is applied only against connections that were
created / initiated by OpenSIPS (as TLS client). Any accepte
connection (as TLS server) will automatically match (the extra
test will be skipped).

Default value is 0 (disabled).

Example 1.6. Set cert_check_on_conn_reusage parameter
...
modparam("proto_tls", "cert_check_on_conn_reusage", 1)
...

1.5.7. trace_destination (string)

Trace destination as defined in the tracing module. Currently
the only tracing module is proto_hep. Network events such as
Expand All @@ -286,28 +311,28 @@ modparam("proto_tls", "tls_max_msg_chunks", 8)

Default value is none(not defined).

Example 1.6. Set trace_destination parameter
Example 1.7. Set trace_destination parameter
...
modparam("proto_hep", "trace_destination", "[hep_dest]10.0.0.2;transport
=tcp;version=3")

modparam("proto_tls", "trace_destination", "hep_dest")
...

1.5.7. trace_on (int)
1.5.8. trace_on (int)

This controls whether tracing for tls is on or not. You still
need to define Section 1.5.6, “trace_destination (string)”in
need to define Section 1.5.7, “trace_destination (string)”in
order to work, but this value will be controlled using mi
function tls_trace.
Default value is 0(tracing inactive).

Example 1.7. Set trace_on parameter
Example 1.8. Set trace_on parameter
...
modparam("proto_tls", "trace_on", 1)
...

1.5.8. trace_filter_route (string)
1.5.9. trace_filter_route (string)

Define the name of a route in which you can filter which
connections will be trace and which connections won't be. In
Expand All @@ -316,7 +341,7 @@ modparam("proto_tls", "trace_on", 1)
disable tracing for a specific connection the last call in this
route must be drop, any other exit mode resulting in tracing
the current connection ( of course you still have to define a
Section 1.5.6, “trace_destination (string)” and trace must be
Section 1.5.7, “trace_destination (string)” and trace must be
on at the time this connection is opened.

IMPORTANT Filtering on ip addresses and ports can be made using
Expand All @@ -332,7 +357,7 @@ modparam("proto_tls", "trace_on", 1)
the mi command tls_trace this route won't be called.
Default value is none(no route is set).

Example 1.8. Set trace_filter_route parameter
Example 1.9. Set trace_filter_route parameter
...
modparam("proto_tls", "trace_filter_route", "tls_filter")
...
Expand Down Expand Up @@ -455,14 +480,14 @@ Chapter 3. Contributors
Table 3.1. Top contributors by DevScore^(1), authored
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Bogdan-Andrei Iancu (@bogdan-iancu) 51 24 1489 802
1. Bogdan-Andrei Iancu (@bogdan-iancu) 53 25 1536 804
2. Eseanu Marius Cristian (@eseanucristian) 45 5 55 2133
3. Razvan Crainea (@razvancrainea) 40 23 571 635
4. Ionut Ionita (@ionutrazvanionita) 35 14 1232 576
5. Liviu Chircu (@liviuchircu) 9 6 27 102
6. Bogdan Chifor 5 2 141 1
7. Vlad Paiu (@vladpaiu) 4 2 84 3
8. Vlad Patrascu (@rvlad-patrascu) 4 2 6 25
6. Vlad Patrascu (@rvlad-patrascu) 5 3 7 26
7. Bogdan Chifor 5 2 141 1
8. Vlad Paiu (@vladpaiu) 4 2 84 3
9. Julián Moreno Patiño 3 1 1 1
10. Zero King (@l2dy) 3 1 1 1

Expand All @@ -488,10 +513,10 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Razvan Crainea (@razvancrainea) Feb 2015 - Jul 2020
2. Zero King (@l2dy) Mar 2020 - Mar 2020
3. Bogdan-Andrei Iancu (@bogdan-iancu) Feb 2015 - May 2019
4. Vlad Patrascu (@rvlad-patrascu) May 2017 - Aug 2018
1. Vlad Patrascu (@rvlad-patrascu) May 2017 - Nov 2020
2. Razvan Crainea (@razvancrainea) Feb 2015 - Jul 2020
3. Zero King (@l2dy) Mar 2020 - Mar 2020
4. Bogdan-Andrei Iancu (@bogdan-iancu) Feb 2015 - May 2019
5. Liviu Chircu (@liviuchircu) Mar 2015 - Jun 2018
6. Maksym Sobolyev (@sobomax) Jul 2017 - Jul 2017
7. Ionut Ionita (@ionutrazvanionita) Mar 2015 - Apr 2017
Expand Down

0 comments on commit cdbacb9

Please sign in to comment.