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 Dec 4, 2021
1 parent e002e6b commit 17a575a
Show file tree
Hide file tree
Showing 46 changed files with 587 additions and 465 deletions.
6 changes: 3 additions & 3 deletions modules/b2b_entities/README
View file
Expand Up @@ -449,7 +449,7 @@ Chapter 3. Contributors
2. Vlad Patrascu (@rvlad-patrascu) 70 40 2205 706
3. Ovidiu Sas (@ovidiusas) 51 39 853 291
4. Bogdan-Andrei Iancu (@bogdan-iancu) 50 43 410 144
5. Razvan Crainea (@razvancrainea) 44 40 234 109
5. Razvan Crainea (@razvancrainea) 45 41 236 121
6. Liviu Chircu (@liviuchircu) 17 13 87 126
7. Vlad Paiu (@vladpaiu) 6 4 74 47
8. Nick Altmann (@nikbyte) 5 2 158 27
Expand Down Expand Up @@ -481,8 +481,8 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Vlad Patrascu (@rvlad-patrascu) May 2017 - Sep 2021
2. Razvan Crainea (@razvancrainea) Dec 2010 - Jun 2021
1. Razvan Crainea (@razvancrainea) Dec 2010 - Nov 2021
2. Vlad Patrascu (@rvlad-patrascu) May 2017 - Sep 2021
3. Nick Altmann (@nikbyte) Jan 2013 - May 2021
4. Bogdan-Andrei Iancu (@bogdan-iancu) Aug 2009 - Apr 2021
5. Maksym Sobolyev (@sobomax) Jan 2021 - Mar 2021
Expand Down
16 changes: 8 additions & 8 deletions modules/b2b_entities/doc/contributors.xml
View file
Expand Up @@ -53,10 +53,10 @@
<row>
<entry>5. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">44</entry>
<entry align="center">40</entry>
<entry align="center">234</entry>
<entry align="center">109</entry>
<entry align="center">45</entry>
<entry align="center">41</entry>
<entry align="center">236</entry>
<entry align="center">121</entry>
</row>
<row>
<entry>6. </entry>
Expand Down Expand Up @@ -128,13 +128,13 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">May 2017 - Sep 2021</entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Dec 2010 - Nov 2021</entry>
</row>
<row>
<entry>2. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Dec 2010 - Jun 2021</entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">May 2017 - Sep 2021</entry>
</row>
<row>
<entry>3. </entry>
Expand Down
57 changes: 38 additions & 19 deletions modules/cachedb_redis/README
View file
Expand Up @@ -33,6 +33,8 @@ cachedb_redis Module

3.1. Contributors

4. Frequently Asked Questions

List of Tables

2.1. Top contributors by DevScore^(1), authored commits^(2) and
Expand Down Expand Up @@ -104,25 +106,30 @@ Chapter 1. Admin Guide

1.5.1. cachedb_url (string)

The urls of the server groups that OpenSIPS will connect to in
order to use the from script cache_store,cache_fetch, etc
operations. It can be set more than one time. The prefix part
The URLs of the server groups that OpenSIPS will connect to in
order to use, from script, the cache_store(), cache_fetch(),
etc. operations. It may be set more than once. The prefix part
of the URL will be the identifier that will be used from the
script.

Example 1.1. Set cachedb_url parameter
...
modparam("cachedb_redis", "cachedb_url","redis:group1://localhost:6379/"
)
modparam("cachedb_redis", "cachedb_url","redis:cluster1://random_url:888
8/")
# single-instance URLs (Redis Server or Redis Cluster)
modparam("cachedb_redis", "cachedb_url", "redis:group1://localhost:6379/
")
modparam("cachedb_redis", "cachedb_url", "redis:cluster1://random_url:88
88/")

# multi-instance URL (will perform circular failover on each query)
modparam("cachedb_redis", "cachedb_url",
"redis:ha://localhost,host_a:6380,host_b:6381,host_c/")
...

Example 1.2. Use Redis servers
...
cache_store("redis:group1","key","$ru value");
cache_fetch("redis:cluster1","key",$avp(10));
cache_remove("redis:cluster1","key");
cache_store("redis:group1", "key", "$ru value");
cache_fetch("redis:cluster1", "key", $avp(10));
cache_remove("redis:cluster1", "key");
...

1.5.2. connect_timeout (integer)
Expand Down Expand Up @@ -251,10 +258,10 @@ Chapter 2. Contributors
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Vlad Paiu (@vladpaiu) 30 17 1428 43
2. Razvan Crainea (@razvancrainea) 16 13 130 35
3. Liviu Chircu (@liviuchircu) 13 11 107 56
4. Bogdan-Andrei Iancu (@bogdan-iancu) 7 5 7 5
5. Vlad Patrascu (@rvlad-patrascu) 6 3 235 18
2. Liviu Chircu (@liviuchircu) 22 14 442 214
3. Razvan Crainea (@razvancrainea) 16 13 130 35
4. Vlad Patrascu (@rvlad-patrascu) 8 4 246 22
5. Bogdan-Andrei Iancu (@bogdan-iancu) 7 5 7 5
6. jalung 4 1 144 61
7. Dan Pascu (@danpascu) 3 1 15 15
8. Ezequiel Lovelle 3 1 11 4
Expand Down Expand Up @@ -284,8 +291,8 @@ Chapter 2. Contributors

Table 2.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Vlad Patrascu (@rvlad-patrascu) May 2017 - Jun 2021
2. Liviu Chircu (@liviuchircu) Mar 2014 - Feb 2021
1. Vlad Patrascu (@rvlad-patrascu) May 2017 - Dec 2021
2. Liviu Chircu (@liviuchircu) Mar 2014 - Nov 2021
3. Bogdan-Andrei Iancu (@bogdan-iancu) Oct 2014 - Mar 2020
4. Razvan Crainea (@razvancrainea) Feb 2012 - Sep 2019
5. Dan Pascu (@danpascu) May 2019 - May 2019
Expand All @@ -305,9 +312,21 @@ Chapter 3. Documentation

3.1. Contributors

Last edited by: Vlad Patrascu (@rvlad-patrascu), Peter Lemenkov
(@lemenkov), Liviu Chircu (@liviuchircu), Julián Moreno Patiño,
Razvan Crainea (@razvancrainea), Vlad Paiu (@vladpaiu).
Last edited by: Liviu Chircu (@liviuchircu), Vlad Patrascu
(@rvlad-patrascu), Peter Lemenkov (@lemenkov), Julián Moreno
Patiño, Razvan Crainea (@razvancrainea), Vlad Paiu (@vladpaiu).

Chapter 4. Frequently Asked Questions

4.1.

My OpenSIPS is occasionally crashing in libhiredis, what to do?

Make sure you've upgraded the Redis "libhiredis" client library
to at least version 0.14.1. There was at least one significant
vulnerability reported in library versions prior to that one
(CVE-2020-7105), so upgrading to latest stable may very well
fix the crash!

Documentation Copyrights:

Expand Down
36 changes: 18 additions & 18 deletions modules/cachedb_redis/doc/contributors.xml
View file
Expand Up @@ -28,36 +28,36 @@
</row>
<row>
<entry>2. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">22</entry>
<entry align="center">14</entry>
<entry align="center">442</entry>
<entry align="center">214</entry>
</row>
<row>
<entry>3. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">16</entry>
<entry align="center">13</entry>
<entry align="center">130</entry>
<entry align="center">35</entry>
</row>
<row>
<entry>3. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">13</entry>
<entry align="center">11</entry>
<entry align="center">107</entry>
<entry align="center">56</entry>
<entry>4. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">8</entry>
<entry align="center">4</entry>
<entry align="center">246</entry>
<entry align="center">22</entry>
</row>
<row>
<entry>4. </entry>
<entry>5. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">7</entry>
<entry align="center">5</entry>
<entry align="center">7</entry>
<entry align="center">5</entry>
</row>
<row>
<entry>5. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">6</entry>
<entry align="center">3</entry>
<entry align="center">235</entry>
<entry align="center">18</entry>
</row>
<row>
<entry>6. </entry>
<entry>jalung</entry>
Expand Down Expand Up @@ -129,12 +129,12 @@
<row>
<entry>1. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">May 2017 - Jun 2021</entry>
<entry align="center">May 2017 - Dec 2021</entry>
</row>
<row>
<entry>2. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Mar 2014 - Feb 2021</entry>
<entry align="center">Mar 2014 - Nov 2021</entry>
</row>
<row>
<entry>3. </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>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Julián Moreno Patiño, Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</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>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Julián Moreno Patiño, Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>).</para>
</section>

</chapter>
12 changes: 6 additions & 6 deletions modules/db_text/README
View file
Expand Up @@ -438,7 +438,7 @@ Chapter 3. Contributors
4. Razvan Crainea (@razvancrainea) 19 16 120 95
5. Liviu Chircu (@liviuchircu) 18 15 68 104
6. Jan Janak (@janakj) 11 7 124 106
7. Vlad Patrascu (@rvlad-patrascu) 7 5 76 49
7. Vlad Patrascu (@rvlad-patrascu) 8 6 94 49
8. Ovidiu Sas (@ovidiusas) 7 5 61 8
9. Sergey Khripchenko (@shripchenko) 5 2 185 2
10. Jiri Kuthan (@jiriatipteldotorg) 4 2 8 6
Expand Down Expand Up @@ -468,11 +468,11 @@ 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. Razvan Crainea (@razvancrainea) Oct 2011 - Jul 2020
3. Bogdan-Andrei Iancu (@bogdan-iancu) Nov 2003 - Apr 2020
4. Ovidiu Sas (@ovidiusas) Dec 2012 - May 2019
5. Vlad Patrascu (@rvlad-patrascu) May 2017 - Apr 2019
1. Vlad Patrascu (@rvlad-patrascu) May 2017 - Dec 2021
2. Liviu Chircu (@liviuchircu) Mar 2014 - Jul 2020
3. Razvan Crainea (@razvancrainea) Oct 2011 - Jul 2020
4. Bogdan-Andrei Iancu (@bogdan-iancu) Nov 2003 - Apr 2020
5. Ovidiu Sas (@ovidiusas) Dec 2012 - May 2019
6. Peter Lemenkov (@lemenkov) Jun 2018 - Jun 2018
7. Dusan Klinec (@ph4r05) Dec 2015 - Dec 2015
8. Sergey Khripchenko (@shripchenko) Aug 2015 - Aug 2015
Expand Down
22 changes: 11 additions & 11 deletions modules/db_text/doc/contributors.xml
View file
Expand Up @@ -69,9 +69,9 @@
<row>
<entry>7. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">7</entry>
<entry align="center">5</entry>
<entry align="center">76</entry>
<entry align="center">8</entry>
<entry align="center">6</entry>
<entry align="center">94</entry>
<entry align="center">49</entry>
</row>
<row>
Expand Down Expand Up @@ -128,29 +128,29 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">May 2017 - Dec 2021</entry>
</row>
<row>
<entry>2. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Mar 2014 - Jul 2020</entry>
</row>
<row>
<entry>2. </entry>
<entry>3. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Oct 2011 - Jul 2020</entry>
</row>
<row>
<entry>3. </entry>
<entry>4. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Nov 2003 - Apr 2020</entry>
</row>
<row>
<entry>4. </entry>
<entry>5. </entry>
<entry>Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>)</entry>
<entry align="center">Dec 2012 - May 2019</entry>
</row>
<row>
<entry>5. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">May 2017 - Apr 2019</entry>
</row>
<row>
<entry>6. </entry>
<entry>Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>)</entry>
Expand Down
14 changes: 7 additions & 7 deletions modules/dialog/README
View file
Expand Up @@ -2489,7 +2489,7 @@ Chapter 4. Contributors
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Bogdan-Andrei Iancu (@bogdan-iancu) 437 276 12828 3411
2. Razvan Crainea (@razvancrainea) 258 194 4878 1462
2. Razvan Crainea (@razvancrainea) 260 195 4883 1485
3. Vlad Paiu (@vladpaiu) 253 144 7205 3026
4. Vlad Patrascu (@rvlad-patrascu) 174 90 3715 3196
5. Liviu Chircu (@liviuchircu) 156 113 2808 1167
Expand Down Expand Up @@ -2533,12 +2533,12 @@ Chapter 4. Contributors

Table 4.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Vlad Paiu (@vladpaiu) Oct 2010 - Nov 2021
2. Bogdan-Andrei Iancu (@bogdan-iancu) Apr 2006 - Nov 2021
3. Vlad Patrascu (@rvlad-patrascu) Jul 2016 - Sep 2021
4. Ovidiu Sas (@ovidiusas) Feb 2008 - Sep 2021
5. Liviu Chircu (@liviuchircu) Aug 2012 - Sep 2021
6. Razvan Crainea (@razvancrainea) Aug 2010 - Jul 2021
1. Razvan Crainea (@razvancrainea) Aug 2010 - Nov 2021
2. Vlad Paiu (@vladpaiu) Oct 2010 - Nov 2021
3. Bogdan-Andrei Iancu (@bogdan-iancu) Apr 2006 - Nov 2021
4. Vlad Patrascu (@rvlad-patrascu) Jul 2016 - Sep 2021
5. Ovidiu Sas (@ovidiusas) Feb 2008 - Sep 2021
6. Liviu Chircu (@liviuchircu) Aug 2012 - Sep 2021
7. Nick Altmann (@nikbyte) Oct 2013 - May 2021
8. Walter Doekes (@wdoekes) Apr 2010 - Apr 2021
9. Maksym Sobolyev (@sobomax) Nov 2020 - Jan 2021
Expand Down
26 changes: 13 additions & 13 deletions modules/dialog/doc/contributors.xml
View file
Expand Up @@ -29,10 +29,10 @@
<row>
<entry>2. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">258</entry>
<entry align="center">194</entry>
<entry align="center">4878</entry>
<entry align="center">1462</entry>
<entry align="center">260</entry>
<entry align="center">195</entry>
<entry align="center">4883</entry>
<entry align="center">1485</entry>
</row>
<row>
<entry>3. </entry>
Expand Down Expand Up @@ -128,34 +128,34 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Aug 2010 - Nov 2021</entry>
</row>
<row>
<entry>2. </entry>
<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
<entry align="center">Oct 2010 - Nov 2021</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">Apr 2006 - Nov 2021</entry>
</row>
<row>
<entry>3. </entry>
<entry>4. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">Jul 2016 - Sep 2021</entry>
</row>
<row>
<entry>4. </entry>
<entry>5. </entry>
<entry>Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>)</entry>
<entry align="center">Feb 2008 - Sep 2021</entry>
</row>
<row>
<entry>5. </entry>
<entry>6. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Aug 2012 - Sep 2021</entry>
</row>
<row>
<entry>6. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Aug 2010 - Jul 2021</entry>
</row>
<row>
<entry>7. </entry>
<entry>Nick Altmann (<ulink url="https://github.com/nikbyte">@nikbyte</ulink>)</entry>
Expand Down

0 comments on commit 17a575a

Please sign in to comment.