Skip to content

Commit

Permalink
Several fixes to the module settings documentation.
Browse files Browse the repository at this point in the history
* dnsbl: Fix default value of duration setting
* ircv3_sts: Fix default value of duration & add explanation
* openssl: Remove tlsv1 & add tlsv13 settings
* permchannels: Fix default value of listmodes & maxbackoff settings
* setname: Fix default value of notifyopers setting
* shun: Remove affectopers setting
* watch: Fix default value of maxwatch setting
* xline_db: Fix default value of maxbackoff setting

Co-authored-by: Sadie Powell <[email protected]>
  • Loading branch information
ralish and SadieCat authored Oct 23, 2024
1 parent 33e449c commit 54b676a
Show file tree
Hide file tree
Showing 9 changed files with 24 additions and 25 deletions.
5 changes: 4 additions & 1 deletion docs/3/modules/ircv3_sts.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ configuration:
- name: duration
type: Duration
required: false
default: 60d
default: 5m *(since 3.6.0)*<br>60d *(3.0.0 to 3.5.0)*
description: |-
The time period that the STS policy should last for.
- name: port
Expand Down Expand Up @@ -67,3 +67,6 @@ client_caps:
- name: '[sts](https://ircv3.net/specs/extensions/sts.html)'
description: |-
Defines a mechanism for clients to upgrade plaintext IRC connections to TLS (SSL).
special_notes: |-
The default duration of 5 minutes is a safety precaution aimed at initial implementation and testing of an STS policy. Once you're comfortable with the configuration the duration should be raised to a month or more for effective enforcement.
2 changes: 1 addition & 1 deletion docs/4/modules/dnsbl.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ configuration:
- name: duration
type: Duration
required: false
default: 1m
default: 1h
description: |-
If action is set to gline, kline, or zline then the duration for an X-line to last for.
- name: host
Expand Down
5 changes: 4 additions & 1 deletion docs/4/modules/ircv3_sts.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ configuration:
- name: duration
type: Duration
required: false
default: 60d
default: 5m
description: |-
The time period that the STS policy should last for.
- name: port
Expand Down Expand Up @@ -66,3 +66,6 @@ client_caps:
- name: '[sts](https://ircv3.net/specs/extensions/sts.html)'
description: |-
Defines a mechanism for clients to upgrade plaintext IRC connections to TLS (SSL).
special_notes: |-
The default duration of 5 minutes is a safety precaution aimed at initial implementation and testing of an STS policy. Once you're comfortable with the configuration the duration should be raised to a month or more for effective enforcement.
4 changes: 2 additions & 2 deletions docs/4/modules/permchannels.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ configuration:
- name: listmodes
type: Boolean
required: false
default: 'No'
default: 'Yes'
description: |-
Whether to save list modes to the permchannels configuration file.
- name: operonly
Expand All @@ -41,7 +41,7 @@ configuration:
- name: maxbackoff
type: Duration
required: false
default: 0s
default: 120 * `<permchanneldb:backoff>`
description: |-
The maximum write period that should be allowed even if incremental backoff is enabled.
- name: writeversion
Expand Down
2 changes: 1 addition & 1 deletion docs/4/modules/setname.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ configuration:
- name: notifyopers
type: Boolean
required: false
default: 'Yes'
default: Inverse of `opersonly`
description: |-
Whether to notify server operators when a user changes their real name.
- name: operonly
Expand Down
9 changes: 1 addition & 8 deletions docs/4/modules/shun.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,6 @@ configuration:
description: |-
The `<shun>` tag defines settings about how the shun module should behave. This tag can only be defined once.
attributes:
- name: affectopers
type: Boolean
required: false
default: 'No'
description: |-
Whether server operators are affected by shuns.
- name: allowconnect
type: Boolean
required: false
Expand Down Expand Up @@ -47,8 +41,7 @@ configuration:
details: ""
example: |-
```xml
<shun affectopers="no"
allowconnect="yes"
<shun allowconnect="yes"
allowtags="no"
cleanedcommands="AWAY PART QUIT"
enabledcommands="ADMIN PING PONG QUIT"
Expand Down
16 changes: 8 additions & 8 deletions docs/4/modules/ssl_openssl.yml
Original file line number Diff line number Diff line change
Expand Up @@ -175,12 +175,6 @@ configuration:
default: 0
description: |-
Raw integer value of options to set on the server context. Don't change this unless you know what you are doing.
- name: tlsv1
type: Boolean
required: false
default: 'No'
description: |-
Whether the insecure TLSv1.0 protocol is enabled.
- name: tlsv11
type: Boolean
required: false
Expand All @@ -193,6 +187,12 @@ configuration:
default: 'Yes'
description: |-
Whether the TLSv1.2 protocol is enabled.
- name: tlsv13
type: Boolean
required: false
default: 'Yes'
description: |-
Whether the TLSv1.3 protocol is enabled.
details: |-
The crlmode field should be set to one of the following values:
Expand All @@ -218,9 +218,9 @@ configuration:
keyfile="key.pem"
renegotiation="no"
requestclientcert="yes"
tlsv1="no"
tlsv11="no"
tlsv12="yes">
tlsv12="yes"
tlsv13="yes">
```
special_notes: |-
Expand Down
4 changes: 2 additions & 2 deletions docs/4/modules/watch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ configuration:
- name: maxwatch
type: Number
required: false
default: 32
default: 30
description: |-
The maximum number of entries on a user's watch list.
details: ""
example: |-
```xml
<watch maxwatch="32">
<watch maxwatch="30">
```
commands:
Expand Down
2 changes: 1 addition & 1 deletion docs/4/modules/xline_db.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ configuration:
- name: maxbackoff
type: Duration
required: false
default: 0s
default: 120 * `<xlinedb:backoff>`
description: |-
The maximum write period that should be allowed even if incremental backoff is enabled.
details: ""
Expand Down

0 comments on commit 54b676a

Please sign in to comment.