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 Nov 28, 2020
1 parent 2ad1e15 commit 99a5e77
Show file tree
Hide file tree
Showing 34 changed files with 458 additions and 377 deletions.
8 changes: 4 additions & 4 deletions modules/b2b_entities/README
View file
Expand Up @@ -450,7 +450,7 @@ Chapter 3. Contributors
3. Ovidiu Sas (@ovidiusas) 51 39 853 291
4. Bogdan-Andrei Iancu (@bogdan-iancu) 45 39 313 123
5. Razvan Crainea (@razvancrainea) 32 28 129 76
6. Liviu Chircu (@liviuchircu) 15 12 83 122
6. Liviu Chircu (@liviuchircu) 17 13 87 126
7. Vlad Paiu (@vladpaiu) 6 4 74 47
8. Stanislaw Pitucha 4 2 6 6
9. Peter Lemenkov (@lemenkov) 4 2 5 3
Expand Down Expand Up @@ -480,9 +480,9 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Vlad Patrascu (@rvlad-patrascu) May 2017 - Nov 2020
2. Razvan Crainea (@razvancrainea) Dec 2010 - Jul 2020
3. Liviu Chircu (@liviuchircu) Mar 2014 - Jul 2020
1. Liviu Chircu (@liviuchircu) Mar 2014 - Nov 2020
2. Vlad Patrascu (@rvlad-patrascu) May 2017 - Nov 2020
3. Razvan Crainea (@razvancrainea) Dec 2010 - Jul 2020
4. Bogdan-Andrei Iancu (@bogdan-iancu) Aug 2009 - Mar 2020
5. Peter Lemenkov (@lemenkov) Jun 2018 - Feb 2020
6. @DMOsipov Mar 2016 - Mar 2016
Expand Down
20 changes: 10 additions & 10 deletions modules/b2b_entities/doc/contributors.xml
View file
Expand Up @@ -61,10 +61,10 @@
<row>
<entry>6. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">15</entry>
<entry align="center">12</entry>
<entry align="center">83</entry>
<entry align="center">122</entry>
<entry align="center">17</entry>
<entry align="center">13</entry>
<entry align="center">87</entry>
<entry align="center">126</entry>
</row>
<row>
<entry>7. </entry>
Expand Down Expand Up @@ -128,18 +128,18 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">May 2017 - Nov 2020</entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Mar 2014 - Nov 2020</entry>
</row>
<row>
<entry>2. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Dec 2010 - Jul 2020</entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">May 2017 - Nov 2020</entry>
</row>
<row>
<entry>3. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Mar 2014 - Jul 2020</entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Dec 2010 - Jul 2020</entry>
</row>
<row>
<entry>4. </entry>
Expand Down
10 changes: 5 additions & 5 deletions modules/b2b_logic/README
View file
Expand Up @@ -1070,7 +1070,7 @@ Chapter 3. Contributors
3. Vlad Patrascu (@rvlad-patrascu) 103 24 4143 2753
4. Bogdan-Andrei Iancu (@bogdan-iancu) 39 33 218 238
5. Razvan Crainea (@razvancrainea) 38 28 633 203
6. Liviu Chircu (@liviuchircu) 15 12 55 100
6. Liviu Chircu (@liviuchircu) 16 13 57 102
7. Nick Altmann (@nikbyte) 14 6 461 199
8. Vlad Paiu (@vladpaiu) 7 5 35 21
9. Peter Lemenkov (@lemenkov) 4 2 2 2
Expand Down Expand Up @@ -1100,10 +1100,10 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Vlad Patrascu (@rvlad-patrascu) May 2017 - Nov 2020
2. Maksym Sobolyev (@sobomax) Oct 2020 - Oct 2020
3. Razvan Crainea (@razvancrainea) Jun 2011 - Jul 2020
4. Liviu Chircu (@liviuchircu) Mar 2014 - Jul 2020
1. Liviu Chircu (@liviuchircu) Mar 2014 - Nov 2020
2. Vlad Patrascu (@rvlad-patrascu) May 2017 - Nov 2020
3. Maksym Sobolyev (@sobomax) Oct 2020 - Oct 2020
4. Razvan Crainea (@razvancrainea) Jun 2011 - Jul 2020
5. Bogdan-Andrei Iancu (@bogdan-iancu) Aug 2009 - Mar 2020
6. Zero King (@l2dy) Mar 2020 - Mar 2020
7. Peter Lemenkov (@lemenkov) Jun 2018 - Feb 2020
Expand Down
22 changes: 11 additions & 11 deletions modules/b2b_logic/doc/contributors.xml
View file
Expand Up @@ -61,10 +61,10 @@
<row>
<entry>6. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">15</entry>
<entry align="center">12</entry>
<entry align="center">55</entry>
<entry align="center">100</entry>
<entry align="center">16</entry>
<entry align="center">13</entry>
<entry align="center">57</entry>
<entry align="center">102</entry>
</row>
<row>
<entry>7. </entry>
Expand Down Expand Up @@ -128,24 +128,24 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Mar 2014 - Nov 2020</entry>
</row>
<row>
<entry>2. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">May 2017 - Nov 2020</entry>
</row>
<row>
<entry>2. </entry>
<entry>3. </entry>
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
<entry align="center">Oct 2020 - Oct 2020</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 - Jul 2020</entry>
</row>
<row>
<entry>4. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Mar 2014 - Jul 2020</entry>
</row>
<row>
<entry>5. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
Expand Down
80 changes: 60 additions & 20 deletions modules/cachedb_redis/README
View file
Expand Up @@ -19,6 +19,7 @@ cachedb_redis Module
1.5.2. connect_timeout (integer)
1.5.3. query_timeout (integer)
1.5.4. shutdown_on_error (integer)
1.5.5. use_tls (integer)

1.6. Exported Functions
1.7. Raw Query Syntax
Expand Down Expand Up @@ -46,7 +47,8 @@ cachedb_redis Module
1.3. Set connect_timeout parameter
1.4. Set connect_timeout parameter
1.5. Set the shutdown_on_error parameter
1.6. Redis Raw Query Examples
1.6. Set the use_tls parameter
1.7. Redis Raw Query Examples

Chapter 1. Admin Guide

Expand Down Expand Up @@ -80,7 +82,9 @@ Chapter 1. Admin Guide

1.4.1. OpenSIPS Modules

None.
The following modules must be loaded before this module:
* If a use_tls is defined, the tls_mgm module will need to be
loaded as well.

1.4.2. External Libraries or Applications

Expand All @@ -93,6 +97,8 @@ Chapter 1. Admin Guide
repos, hiredis can be downloaded from:
https://github.com/antirez/hiredis . Download the archive,
extract sources, run make,sudo make install.
If TLS connections are enabled via the use_tls modparam,
hiredis needs to be compiled with TLS support.

1.5. Exported Parameters

Expand Down Expand Up @@ -160,6 +166,40 @@ modparam("cachedb_redis", "query_timeout",1000)
modparam("cachedb_redis", "shutdown_on_error", 1)
...

1.5.5. use_tls (integer)

Setting this parameter will allow you to use TLS for Redis
connections. In order to enable TLS for a specific connection,
you can use the "tls_domain=dom_name" URL parameter in the
cachedb_url of this module (or other modules that use the
CacheDB interface). This should be placed at the end of the URL
after the '?' character.

When using this parameter, you must also ensure that tls_mgm is
loaded and properly configured. Refer to the the module for
additional info regarding TLS client domains.

Note that TLS is supported by Redis starting with version 6.0.
Also, it is an optional feature enabled at compile time and
might not be included in the standard Redis packages available
for your OS.

Default value is 0 (not enabled)

Example 1.6. Set the use_tls parameter
...
modparam("tls_mgm", "client_domain", "redis")
modparam("tls_mgm", "certificate", "[redis]/etc/pki/tls/certs/redis.pem"
)
modparam("tls_mgm", "private_key", "[redis]/etc/pki/tls/private/redis.ke
y")
modparam("tls_mgm", "ca_list", "[redis]/etc/pki/tls/certs/ca.pem")
...
modparam("cachedb_redis", "use_tls", 1)
modparam("cachedb_redis", "cachedb_url","redis://localhost:6379/?tls_dom
ain=redis")
...

1.6. Exported Functions

The module does not export functions to be used in
Expand All @@ -173,7 +213,7 @@ modparam("cachedb_redis", "shutdown_on_error", 1)

Here are a couple examples of running some Redis queries :

Example 1.6. Redis Raw Query Examples
Example 1.7. Redis Raw Query Examples
...
$var(my_hash) = "my_hash_name";
$var(my_key) = "my_key_name";
Expand Down Expand Up @@ -214,15 +254,15 @@ Chapter 2. Contributors
2. Razvan Crainea (@razvancrainea) 16 13 130 35
3. Liviu Chircu (@liviuchircu) 12 10 106 55
4. Bogdan-Andrei Iancu (@bogdan-iancu) 7 5 7 5
5. jalung 4 1 144 61
6. Dan Pascu (@danpascu) 3 1 15 15
7. Ezequiel Lovelle 3 1 11 4
8. Julián Moreno Patiño 3 1 1 1
9. Peter Lemenkov (@lemenkov) 3 1 1 1
10. Jarrod Baumann (@jarrodb) 2 1 12 0
5. Vlad Patrascu (@rvlad-patrascu) 5 2 210 14
6. jalung 4 1 144 61
7. Dan Pascu (@danpascu) 3 1 15 15
8. Ezequiel Lovelle 3 1 11 4
9. Julián Moreno Patiño 3 1 1 1
10. Peter Lemenkov (@lemenkov) 3 1 1 1

All remaining contributors: Kristian Høgh, Vlad Patrascu
(@rvlad-patrascu).
All remaining contributors: Jarrod Baumann (@jarrodb), Kristian
Høgh.

(1) DevScore = author_commits + author_lines_added /
(project_lines_added / project_commits) + author_lines_deleted
Expand All @@ -244,12 +284,12 @@ Chapter 2. Contributors

Table 2.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Bogdan-Andrei Iancu (@bogdan-iancu) Oct 2014 - Mar 2020
2. Liviu Chircu (@liviuchircu) Mar 2014 - Jan 2020
3. Razvan Crainea (@razvancrainea) Feb 2012 - Sep 2019
4. Dan Pascu (@danpascu) May 2019 - May 2019
5. Peter Lemenkov (@lemenkov) Jun 2018 - Jun 2018
6. Vlad Patrascu (@rvlad-patrascu) May 2017 - May 2017
1. Vlad Patrascu (@rvlad-patrascu) May 2017 - Nov 2020
2. Bogdan-Andrei Iancu (@bogdan-iancu) Oct 2014 - Mar 2020
3. Liviu Chircu (@liviuchircu) Mar 2014 - Jan 2020
4. Razvan Crainea (@razvancrainea) Feb 2012 - Sep 2019
5. Dan Pascu (@danpascu) May 2019 - May 2019
6. Peter Lemenkov (@lemenkov) Jun 2018 - Jun 2018
7. Kristian Høgh Apr 2016 - Apr 2016
8. Julián Moreno Patiño Feb 2016 - Feb 2016
9. Jarrod Baumann (@jarrodb) May 2015 - May 2015
Expand All @@ -265,9 +305,9 @@ Chapter 3. Documentation

3.1. Contributors

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

Documentation Copyrights:

Expand Down
46 changes: 23 additions & 23 deletions modules/cachedb_redis/doc/contributors.xml
View file
Expand Up @@ -52,56 +52,56 @@
</row>
<row>
<entry>5. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">5</entry>
<entry align="center">2</entry>
<entry align="center">210</entry>
<entry align="center">14</entry>
</row>
<row>
<entry>6. </entry>
<entry>jalung</entry>
<entry align="center">4</entry>
<entry align="center">1</entry>
<entry align="center">144</entry>
<entry align="center">61</entry>
</row>
<row>
<entry>6. </entry>
<entry>7. </entry>
<entry>Dan Pascu (<ulink url="https://github.com/danpascu">@danpascu</ulink>)</entry>
<entry align="center">3</entry>
<entry align="center">1</entry>
<entry align="center">15</entry>
<entry align="center">15</entry>
</row>
<row>
<entry>7. </entry>
<entry>8. </entry>
<entry>Ezequiel Lovelle</entry>
<entry align="center">3</entry>
<entry align="center">1</entry>
<entry align="center">11</entry>
<entry align="center">4</entry>
</row>
<row>
<entry>8. </entry>
<entry>9. </entry>
<entry>Julián Moreno Patiño</entry>
<entry align="center">3</entry>
<entry align="center">1</entry>
<entry align="center">1</entry>
<entry align="center">1</entry>
</row>
<row>
<entry>9. </entry>
<entry>10. </entry>
<entry>Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>)</entry>
<entry align="center">3</entry>
<entry align="center">1</entry>
<entry align="center">1</entry>
<entry align="center">1</entry>
</row>
<row>
<entry>10. </entry>
<entry>Jarrod Baumann (<ulink url="https://github.com/jarrodb">@jarrodb</ulink>)</entry>
<entry align="center">2</entry>
<entry align="center">1</entry>
<entry align="center">12</entry>
<entry align="center">0</entry>
</row>
</tbody>
</tgroup>
</table>
<para><emphasis role='bold'>All remaining contributors</emphasis>: Kristian Høgh, Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>).</para>
<para><emphasis role='bold'>All remaining contributors</emphasis>: Jarrod Baumann (<ulink url="https://github.com/jarrodb">@jarrodb</ulink>), Kristian Høgh.</para>
<para>
<emphasis>(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)</emphasis>
</para>
Expand All @@ -128,34 +128,34 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">May 2017 - Nov 2020</entry>
</row>
<row>
<entry>2. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Oct 2014 - Mar 2020</entry>
</row>
<row>
<entry>2. </entry>
<entry>3. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Mar 2014 - Jan 2020</entry>
</row>
<row>
<entry>3. </entry>
<entry>4. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Feb 2012 - Sep 2019</entry>
</row>
<row>
<entry>4. </entry>
<entry>5. </entry>
<entry>Dan Pascu (<ulink url="https://github.com/danpascu">@danpascu</ulink>)</entry>
<entry align="center">May 2019 - May 2019</entry>
</row>
<row>
<entry>5. </entry>
<entry>6. </entry>
<entry>Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>)</entry>
<entry align="center">Jun 2018 - Jun 2018</entry>
</row>
<row>
<entry>6. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">May 2017 - May 2017</entry>
</row>
<row>
<entry>7. </entry>
<entry>Kristian Høgh</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> 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> 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>
</section>

</chapter>

0 comments on commit 99a5e77

Please sign in to comment.