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 13, 2024
1 parent 072abeb commit a9bc810
Show file tree
Hide file tree
Showing 6 changed files with 66 additions and 58 deletions.
36 changes: 22 additions & 14 deletions modules/nathelper/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ nathelper Module
1.21. fix_nated_sdp usage
1.22. add_rcv_paramer usage
1.23. fix_nated_register usage
1.24. nh_enable_ping usage
1.24. nat_uac_test usage
1.25. nh_enable_ping usage

Chapter 1. Admin Guide

Expand Down Expand Up @@ -557,12 +558,13 @@ fix_nated_register();

1.5.5. nat_uac_test(flags)

Tries to guess if client's request originated behind a nat. The
parameter determines what heuristics is used.
Determines whether the received SIP message originated behind a
NAT, using one or more pre-defined checks.

Meaning of the flags (string) parameter is as follows:
The flags (string) parameter denotes a comma-separated list of
checks to be performed, as follows:
* private-contact - (old 1 flag) Contact header field is
searched for occurrence of RFC1918 / RFC6598 addresses.
searched for occurrence of RFC1918 / RFC6598 addresses
* diff-ip-src-via - (old 2 flag) the "received" test is used:
address in Via is compared against source IP address of
signaling
Expand All @@ -577,14 +579,20 @@ fix_nated_register();
* diff-port-src-contact - (old 64 flag) Port in Contact is
compared against source port of signaling
* carrier-grade-nat - (old 128 flag) also include RFC 6333
addresses in the checks for ct, via and sdp flags.
addresses in the checks for Contact, Via and SDP

A CSV of the above flags can be provided, the test returns true
if any of the tests identified a NAT.
Returns true if any of the tests passed.

This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
FAILURE_ROUTE, BRANCH_ROUTE.

Example 1.24. nat_uac_test usage
...
# check for private Contact or SDP media IP addresses
if (nat_uac_test("private-contact,private-sdp"))
xlog("SIP message is NAT'ed (Call-ID: $ci)\n");
...

1.6. Exported MI Functions

1.6.1. nh_enable_ping
Expand All @@ -597,7 +605,7 @@ fix_nated_register();
parameter value greater than 0 or disables natping if
parameter value is 0.

Example 1.24. nh_enable_ping usage
Example 1.25. nh_enable_ping usage
...
$ opensips-cli -x mi nh_enable_ping
Status:: 1
Expand Down Expand Up @@ -651,7 +659,7 @@ Chapter 3. Contributors
Name DevScore Commits Lines ++ Lines --
1. Bogdan-Andrei Iancu (@bogdan-iancu) 153 121 2044 866
2. Maksym Sobolyev (@sobomax) 152 44 3552 4786
3. Liviu Chircu (@liviuchircu) 46 37 420 298
3. Liviu Chircu (@liviuchircu) 48 38 438 307
4. Ionut Ionita (@ionutrazvanionita) 40 15 1598 627
5. Razvan Crainea (@razvancrainea) 33 27 158 240
6. Daniel-Constantin Mierla (@miconda) 22 17 142 124
Expand Down Expand Up @@ -691,7 +699,7 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Liviu Chircu (@liviuchircu) Jan 2013 - Oct 2023
1. Liviu Chircu (@liviuchircu) Jan 2013 - Jan 2024
2. Vlad Paiu (@vladpaiu) Aug 2010 - Jul 2023
3. Vlad Patrascu (@rvlad-patrascu) May 2017 - Apr 2023
4. Maksym Sobolyev (@sobomax) May 2003 - Feb 2023
Expand Down Expand Up @@ -720,9 +728,9 @@ Chapter 4. Documentation

4.1. Contributors

Last edited by: Vlad Patrascu (@rvlad-patrascu), Nick Altmann
(@nikbyte), Jasper Hafkenscheid (@hafkensite), Liviu Chircu
(@liviuchircu), Razvan Crainea (@razvancrainea), Bogdan-Andrei
Last edited by: Liviu Chircu (@liviuchircu), Vlad Patrascu
(@rvlad-patrascu), Nick Altmann (@nikbyte), Jasper Hafkenscheid
(@hafkensite), Razvan Crainea (@razvancrainea), Bogdan-Andrei
Iancu (@bogdan-iancu), Peter Lemenkov (@lemenkov), Ovidiu Sas
(@ovidiusas), Ionut Ionita (@ionutrazvanionita), Walter Doekes
(@wdoekes), Christophe Sollet (@csollet), Vlad Paiu
Expand Down
12 changes: 6 additions & 6 deletions modules/nathelper/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@
<row>
<entry>3. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">46</entry>
<entry align="center">37</entry>
<entry align="center">420</entry>
<entry align="center">298</entry>
<entry align="center">48</entry>
<entry align="center">38</entry>
<entry align="center">438</entry>
<entry align="center">307</entry>
</row>
<row>
<entry>4. </entry>
Expand Down Expand Up @@ -129,7 +129,7 @@
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Jan 2013 - Oct 2023</entry>
<entry align="center">Jan 2013 - Jan 2024</entry>
</row>
<row>
<entry>2. </entry>
Expand Down Expand Up @@ -190,7 +190,7 @@
<title>Documentation</title>
<section id="documentation_contributors" xreflabel="documentation_contributors">
<title>Contributors</title>
<para><emphasis role='bold'>Last edited by:</emphasis> Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Nick Altmann (<ulink url="https://github.com/nikbyte">@nikbyte</ulink>), Jasper Hafkenscheid (<ulink url="https://github.com/hafkensite">@hafkensite</ulink>), Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>), Ionut Ionita (<ulink url="https://github.com/ionutrazvanionita">@ionutrazvanionita</ulink>), Walter Doekes (<ulink url="https://github.com/wdoekes">@wdoekes</ulink>), Christophe Sollet (<ulink url="https://github.com/csollet">@csollet</ulink>), Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>), Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>), Anca Vamanu, Andrei Dragus, Sergio Gutierrez, Klaus Darilion, Daniel-Constantin Mierla (<ulink url="https://github.com/miconda">@miconda</ulink>), Konstantin Bokarius, Edson Gellert Schubert, Carsten Bock, Ancuta Onofrei, Marcus Hunger, Jeremie Le Hen, Bayan Towfiq, Elena-Ramona Modroiu, Jan Janak (<ulink url="https://github.com/janakj">@janakj</ulink>), Jiri Kuthan (<ulink url="https://github.com/jiriatipteldotorg">@jiriatipteldotorg</ulink>).</para>
<para><emphasis role='bold'>Last edited by:</emphasis> Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Nick Altmann (<ulink url="https://github.com/nikbyte">@nikbyte</ulink>), Jasper Hafkenscheid (<ulink url="https://github.com/hafkensite">@hafkensite</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>), Ionut Ionita (<ulink url="https://github.com/ionutrazvanionita">@ionutrazvanionita</ulink>), Walter Doekes (<ulink url="https://github.com/wdoekes">@wdoekes</ulink>), Christophe Sollet (<ulink url="https://github.com/csollet">@csollet</ulink>), Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>), Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>), Anca Vamanu, Andrei Dragus, Sergio Gutierrez, Klaus Darilion, Daniel-Constantin Mierla (<ulink url="https://github.com/miconda">@miconda</ulink>), Konstantin Bokarius, Edson Gellert Schubert, Carsten Bock, Ancuta Onofrei, Marcus Hunger, Jeremie Le Hen, Bayan Towfiq, Elena-Ramona Modroiu, Jan Janak (<ulink url="https://github.com/janakj">@janakj</ulink>), Jiri Kuthan (<ulink url="https://github.com/jiriatipteldotorg">@jiriatipteldotorg</ulink>).</para>
</section>

</chapter>
8 changes: 4 additions & 4 deletions modules/presence_dfks/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ Chapter 2. Contributors
Name DevScore Commits Lines ++ Lines --
1. Vlad Patrascu (@rvlad-patrascu) 23 7 1641 92
2. Maksym Sobolyev (@sobomax) 7 5 15 20
3. Bogdan-Andrei Iancu (@bogdan-iancu) 4 2 29 24
3. Bogdan-Andrei Iancu (@bogdan-iancu) 5 3 30 25
4. Liviu Chircu (@liviuchircu) 4 2 2 2
5. Razvan Crainea (@razvancrainea) 3 1 67 21

Expand All @@ -241,7 +241,7 @@ Chapter 2. Contributors

Table 2.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Bogdan-Andrei Iancu (@bogdan-iancu) Dec 2020 - May 2023
1. Bogdan-Andrei Iancu (@bogdan-iancu) Dec 2020 - Jan 2024
2. Maksym Sobolyev (@sobomax) Jan 2021 - Feb 2023
3. Liviu Chircu (@liviuchircu) Nov 2020 - Jan 2021
4. Vlad Patrascu (@rvlad-patrascu) Dec 2019 - Sep 2020
Expand All @@ -254,8 +254,8 @@ Chapter 3. Documentation

3.1. Contributors

Last edited by: Vlad Patrascu (@rvlad-patrascu), Razvan Crainea
(@razvancrainea).
Last edited by: Bogdan-Andrei Iancu (@bogdan-iancu), Vlad
Patrascu (@rvlad-patrascu), Razvan Crainea (@razvancrainea).

Documentation Copyrights:

Expand Down
12 changes: 6 additions & 6 deletions modules/presence_dfks/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
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">4</entry>
<entry align="center">2</entry>
<entry align="center">29</entry>
<entry align="center">24</entry>
<entry align="center">5</entry>
<entry align="center">3</entry>
<entry align="center">30</entry>
<entry align="center">25</entry>
</row>
<row>
<entry>4. </entry>
Expand Down Expand Up @@ -89,7 +89,7 @@
<row>
<entry>1. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Dec 2020 - May 2023</entry>
<entry align="center">Dec 2020 - Jan 2024</entry>
</row>
<row>
<entry>2. </entry>
Expand Down Expand Up @@ -125,7 +125,7 @@
<title>Documentation</title>
<section id="documentation_contributors" xreflabel="documentation_contributors">
<title>Contributors</title>
<para><emphasis role='bold'>Last edited by:</emphasis> Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>).</para>
<para><emphasis role='bold'>Last edited by:</emphasis> Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>).</para>
</section>

</chapter>
22 changes: 11 additions & 11 deletions modules/tracer/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -500,7 +500,7 @@ Chapter 2. Contributors
2. Ionut Ionita (@ionutrazvanionita) 105 52 2676 1887
3. Razvan Crainea (@razvancrainea) 70 49 1642 421
4. Daniel-Constantin Mierla (@miconda) 49 26 2215 191
5. Liviu Chircu (@liviuchircu) 24 21 85 76
5. Liviu Chircu (@liviuchircu) 25 22 87 78
6. Vlad Paiu (@vladpaiu) 24 10 402 568
7. Vlad Patrascu (@rvlad-patrascu) 17 8 286 335
8. Henning Westerholt (@henningw) 11 6 146 155
Expand Down Expand Up @@ -535,16 +535,16 @@ Chapter 2. Contributors

Table 2.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Vlad Paiu (@vladpaiu) Jun 2011 - Dec 2023
2. Bogdan-Andrei Iancu (@bogdan-iancu) Jul 2006 - Jul 2023
3. Razvan Crainea (@razvancrainea) Jun 2011 - Jun 2023
4. Vlad Patrascu (@rvlad-patrascu) May 2017 - May 2023
5. okhowang Mar 2023 - Mar 2023
6. Maksym Sobolyev (@sobomax) Feb 2023 - Feb 2023
7. Peter Lemenkov (@lemenkov) Jun 2018 - Sep 2022
8. Nick Altmann (@nikbyte) Feb 2022 - Feb 2022
9. Walter Doekes (@wdoekes) Apr 2019 - Apr 2021
10. Liviu Chircu (@liviuchircu) Jan 2013 - Mar 2021
1. Liviu Chircu (@liviuchircu) Jan 2013 - Jan 2024
2. Vlad Paiu (@vladpaiu) Jun 2011 - Dec 2023
3. Bogdan-Andrei Iancu (@bogdan-iancu) Jul 2006 - Jul 2023
4. Razvan Crainea (@razvancrainea) Jun 2011 - Jun 2023
5. Vlad Patrascu (@rvlad-patrascu) May 2017 - May 2023
6. okhowang Mar 2023 - Mar 2023
7. Maksym Sobolyev (@sobomax) Feb 2023 - Feb 2023
8. Peter Lemenkov (@lemenkov) Jun 2018 - Sep 2022
9. Nick Altmann (@nikbyte) Feb 2022 - Feb 2022
10. Walter Doekes (@wdoekes) Apr 2019 - Apr 2021

All remaining contributors: Ovidiu Sas (@ovidiusas), Zero King
(@l2dy), Dan Pascu (@danpascu), Eric Tamme (@etamme), Ionut
Expand Down
34 changes: 17 additions & 17 deletions modules/tracer/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@
<row>
<entry>5. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">24</entry>
<entry align="center">21</entry>
<entry align="center">85</entry>
<entry align="center">76</entry>
<entry align="center">25</entry>
<entry align="center">22</entry>
<entry align="center">87</entry>
<entry align="center">78</entry>
</row>
<row>
<entry>6. </entry>
Expand Down Expand Up @@ -128,54 +128,54 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Jan 2013 - Jan 2024</entry>
</row>
<row>
<entry>2. </entry>
<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
<entry align="center">Jun 2011 - Dec 2023</entry>
</row>
<row>
<entry>2. </entry>
<entry>3. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Jul 2006 - Jul 2023</entry>
</row>
<row>
<entry>3. </entry>
<entry>4. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Jun 2011 - Jun 2023</entry>
</row>
<row>
<entry>4. </entry>
<entry>5. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">May 2017 - May 2023</entry>
</row>
<row>
<entry>5. </entry>
<entry>6. </entry>
<entry>okhowang</entry>
<entry align="center">Mar 2023 - Mar 2023</entry>
</row>
<row>
<entry>6. </entry>
<entry>7. </entry>
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
<entry align="center">Feb 2023 - Feb 2023</entry>
</row>
<row>
<entry>7. </entry>
<entry>8. </entry>
<entry>Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>)</entry>
<entry align="center">Jun 2018 - Sep 2022</entry>
</row>
<row>
<entry>8. </entry>
<entry>9. </entry>
<entry>Nick Altmann (<ulink url="https://github.com/nikbyte">@nikbyte</ulink>)</entry>
<entry align="center">Feb 2022 - Feb 2022</entry>
</row>
<row>
<entry>9. </entry>
<entry>10. </entry>
<entry>Walter Doekes (<ulink url="https://github.com/wdoekes">@wdoekes</ulink>)</entry>
<entry align="center">Apr 2019 - Apr 2021</entry>
</row>
<row>
<entry>10. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Jan 2013 - Mar 2021</entry>
</row>
</tbody>
</tgroup>
</table>
Expand Down

0 comments on commit a9bc810

Please sign in to comment.