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 15, 2024
1 parent 9e63d59 commit 4b67742
Show file tree
Hide file tree
Showing 4 changed files with 140 additions and 103 deletions.
84 changes: 50 additions & 34 deletions modules/httpd/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ httpd Module
1.4.3. conn_timeout(integer)
1.4.4. buf_size (integer)
1.4.5. post_buf_size (integer)
1.4.6. tls_cert_file (string)
1.4.7. tls_key_file (string)
1.4.8. tls_ciphers (string)
1.4.6. receive_buf_size (integer)
1.4.7. tls_cert_file (string)
1.4.8. tls_key_file (string)
1.4.9. tls_ciphers (string)

1.5. Exported MI Functions

Expand Down Expand Up @@ -61,9 +62,10 @@ httpd Module
1.3. Set conn_timeout parameter
1.4. Set buf_size parameter
1.5. Set post_buf_size parameter
1.6. Set tls_cert_file parameter
1.7. Set tls_key_file parameter
1.6. Set receive_buf_size parameter
1.7. Set tls_cert_file parameter
1.8. Set tls_key_file parameter
1.9. Set tls_key_file parameter

Chapter 1. Admin Guide

Expand Down Expand Up @@ -180,31 +182,44 @@ modparam("httpd", "buf_size", 524288)
modparam("httpd", "post_buf_size", 4096)
...

1.4.6. tls_cert_file (string)
1.4.6. receive_buf_size (integer)

It specifies the maximum length (in bytes) of the received HTTP
requests. For receiving large POST request, the default value
might require to be increased.

The default value is 1024.

Example 1.6. Set receive_buf_size parameter
...
modparam("httpd", "receive_buf_size", 4096)
...

1.4.7. tls_cert_file (string)

Public certificate file for httpd. It will be used as
server-side certificate for incoming TLS connections.

The default value is ""

Example 1.6. Set tls_cert_file parameter
Example 1.7. Set tls_cert_file parameter
...
modparam("httpd", "tls_cert_file", "/etc/opensips/tls/server.pem")
...

1.4.7. tls_key_file (string)
1.4.8. tls_key_file (string)

Private key of the above certificate. I must be kept in a safe
place with tight permissions!

The default value is ""

Example 1.7. Set tls_key_file parameter
Example 1.8. Set tls_key_file parameter
...
modparam("httpd", "tls_key_file", "/etc/opensips/tls/server.key")
...

1.4.8. tls_ciphers (string)
1.4.9. tls_ciphers (string)

You can specify the list of algorithms for authentication and
encryption that you allow. To obtain a list of ciphers and then
Expand All @@ -218,7 +233,7 @@ Warning
The default value is
"SECURE256:+SECURE192:-VERS-ALL:+VERS-TLS1.2"

Example 1.8. Set tls_key_file parameter
Example 1.9. Set tls_key_file parameter
...
modparam("httpd", "tls_ciphers", "SECURE256:+SECURE192:-VERS-ALL:+VERS-T
LS1.2")
Expand Down Expand Up @@ -295,13 +310,13 @@ Chapter 3. Contributors
4. Bogdan-Andrei Iancu (@bogdan-iancu) 14 12 103 54
5. Vlad Patrascu (@rvlad-patrascu) 10 7 52 89
6. Ionut Ionita (@ionutrazvanionita) 8 6 65 21
7. Maksym Sobolyev (@sobomax) 4 2 5 5
8. Alexandra Titoc 4 2 2 1
9. Fabian Gast (@fgast) 4 1 150 3
10. Stephane Alnet 3 1 39 3
7. Vlad Paiu (@vladpaiu) 4 2 68 16
8. Maksym Sobolyev (@sobomax) 4 2 5 5
9. Alexandra Titoc 4 2 2 1
10. Fabian Gast (@fgast) 4 1 150 3

All remaining contributors: Stas Kobzar, Dusan Klinec
(@ph4r05), Peter Lemenkov (@lemenkov).
All remaining contributors: Stephane Alnet, Stas Kobzar, Dusan
Klinec (@ph4r05), Peter Lemenkov (@lemenkov).

(1) DevScore = author_commits + author_lines_added /
(project_lines_added / project_commits) + author_lines_deleted
Expand All @@ -323,19 +338,19 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Alexandra Titoc Sep 2024 - Sep 2024
2. Liviu Chircu (@liviuchircu) Mar 2014 - May 2024
3. Maksym Sobolyev (@sobomax) Feb 2023 - Feb 2023
4. Razvan Crainea (@razvancrainea) Mar 2015 - Oct 2021
5. Bogdan-Andrei Iancu (@bogdan-iancu) Jan 2013 - Aug 2021
6. Fabian Gast (@fgast) Aug 2020 - Aug 2020
7. Vlad Patrascu (@rvlad-patrascu) May 2017 - Apr 2019
8. Ovidiu Sas (@ovidiusas) Jan 2012 - Jan 2019
9. Peter Lemenkov (@lemenkov) Jun 2018 - Jun 2018
10. Ionut Ionita (@ionutrazvanionita) Jan 2017 - Feb 2017

All remaining contributors: Dusan Klinec (@ph4r05), Stas
Kobzar, Stephane Alnet.
1. Vlad Paiu (@vladpaiu) Dec 2024 - Dec 2024
2. Alexandra Titoc Sep 2024 - Sep 2024
3. Liviu Chircu (@liviuchircu) Mar 2014 - May 2024
4. Maksym Sobolyev (@sobomax) Feb 2023 - Feb 2023
5. Razvan Crainea (@razvancrainea) Mar 2015 - Oct 2021
6. Bogdan-Andrei Iancu (@bogdan-iancu) Jan 2013 - Aug 2021
7. Fabian Gast (@fgast) Aug 2020 - Aug 2020
8. Vlad Patrascu (@rvlad-patrascu) May 2017 - Apr 2019
9. Ovidiu Sas (@ovidiusas) Jan 2012 - Jan 2019
10. Peter Lemenkov (@lemenkov) Jun 2018 - Jun 2018

All remaining contributors: Ionut Ionita (@ionutrazvanionita),
Dusan Klinec (@ph4r05), Stas Kobzar, Stephane Alnet.

(1) including any documentation-related commits, excluding
merge commits
Expand All @@ -344,10 +359,11 @@ Chapter 4. Documentation

4.1. Contributors

Last edited by: Liviu Chircu (@liviuchircu), Bogdan-Andrei
Iancu (@bogdan-iancu), Fabian Gast (@fgast), Razvan Crainea
(@razvancrainea), Peter Lemenkov (@lemenkov), Vlad Patrascu
(@rvlad-patrascu), Ovidiu Sas (@ovidiusas).
Last edited by: Vlad Paiu (@vladpaiu), Liviu Chircu
(@liviuchircu), Bogdan-Andrei Iancu (@bogdan-iancu), Fabian
Gast (@fgast), Razvan Crainea (@razvancrainea), Peter Lemenkov
(@lemenkov), Vlad Patrascu (@rvlad-patrascu), Ovidiu Sas
(@ovidiusas).

Documentation Copyrights:

Expand Down
52 changes: 26 additions & 26 deletions modules/httpd/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,40 +68,40 @@
</row>
<row>
<entry>7. </entry>
<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
<entry align="center">4</entry>
<entry align="center">2</entry>
<entry align="center">68</entry>
<entry align="center">16</entry>
</row>
<row>
<entry>8. </entry>
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
<entry align="center">4</entry>
<entry align="center">2</entry>
<entry align="center">5</entry>
<entry align="center">5</entry>
</row>
<row>
<entry>8. </entry>
<entry>9. </entry>
<entry>Alexandra Titoc</entry>
<entry align="center">4</entry>
<entry align="center">2</entry>
<entry align="center">2</entry>
<entry align="center">1</entry>
</row>
<row>
<entry>9. </entry>
<entry>10. </entry>
<entry>Fabian Gast (<ulink url="https://github.com/fgast">@fgast</ulink>)</entry>
<entry align="center">4</entry>
<entry align="center">1</entry>
<entry align="center">150</entry>
<entry align="center">3</entry>
</row>
<row>
<entry>10. </entry>
<entry>Stephane Alnet</entry>
<entry align="center">3</entry>
<entry align="center">1</entry>
<entry align="center">39</entry>
<entry align="center">3</entry>
</row>
</tbody>
</tgroup>
</table>
<para><emphasis role='bold'>All remaining contributors</emphasis>: Stas Kobzar, Dusan Klinec (<ulink url="https://github.com/ph4r05">@ph4r05</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>).</para>
<para><emphasis role='bold'>All remaining contributors</emphasis>: Stephane Alnet, Stas Kobzar, Dusan Klinec (<ulink url="https://github.com/ph4r05">@ph4r05</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>).</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,58 +128,58 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
<entry align="center">Dec 2024 - Dec 2024</entry>
</row>
<row>
<entry>2. </entry>
<entry>Alexandra Titoc</entry>
<entry align="center">Sep 2024 - Sep 2024</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 - May 2024</entry>
</row>
<row>
<entry>3. </entry>
<entry>4. </entry>
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
<entry align="center">Feb 2023 - Feb 2023</entry>
</row>
<row>
<entry>4. </entry>
<entry>5. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Mar 2015 - Oct 2021</entry>
</row>
<row>
<entry>5. </entry>
<entry>6. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Jan 2013 - Aug 2021</entry>
</row>
<row>
<entry>6. </entry>
<entry>7. </entry>
<entry>Fabian Gast (<ulink url="https://github.com/fgast">@fgast</ulink>)</entry>
<entry align="center">Aug 2020 - Aug 2020</entry>
</row>
<row>
<entry>7. </entry>
<entry>8. </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>8. </entry>
<entry>9. </entry>
<entry>Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>)</entry>
<entry align="center">Jan 2012 - Jan 2019</entry>
</row>
<row>
<entry>9. </entry>
<entry>10. </entry>
<entry>Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>)</entry>
<entry align="center">Jun 2018 - Jun 2018</entry>
</row>
<row>
<entry>10. </entry>
<entry>Ionut Ionita (<ulink url="https://github.com/ionutrazvanionita">@ionutrazvanionita</ulink>)</entry>
<entry align="center">Jan 2017 - Feb 2017</entry>
</row>
</tbody>
</tgroup>
</table>
<para><emphasis role='bold'>All remaining contributors</emphasis>: Dusan Klinec (<ulink url="https://github.com/ph4r05">@ph4r05</ulink>), Stas Kobzar, Stephane Alnet.</para>
<para><emphasis role='bold'>All remaining contributors</emphasis>: Ionut Ionita (<ulink url="https://github.com/ionutrazvanionita">@ionutrazvanionita</ulink>), Dusan Klinec (<ulink url="https://github.com/ph4r05">@ph4r05</ulink>), Stas Kobzar, Stephane Alnet.</para>
<para>
<emphasis>(1) including any documentation-related commits, excluding merge commits</emphasis>
</para>
Expand All @@ -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> Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Fabian Gast (<ulink url="https://github.com/fgast">@fgast</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>).</para>
<para><emphasis role='bold'>Last edited by:</emphasis> Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>), Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Fabian Gast (<ulink url="https://github.com/fgast">@fgast</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>).</para>
</section>

</chapter>
Loading

0 comments on commit 4b67742

Please sign in to comment.