Skip to content

Commit ab2f310

Browse files
committed
Fix various issues with the documentation.
1 parent 313c755 commit ab2f310

4 files changed

Lines changed: 21 additions & 5 deletions

File tree

docs/4/modules/joinflood.yml

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,33 @@ configuration:
2020
default: 1m
2121
description: |-
2222
The time period that a channel should be locked for once a join flood has been detected.
23+
- name: notifyrank
24+
type: Number
25+
required: false
26+
default: 0
27+
description: |-
28+
The lowest prefix rank that can receive a notification that a join flood has been detected.
2329
- name: splitwait
2430
type: Duration
2531
required: false
2632
default: 30s
2733
description: |-
2834
The time period to wait after a netsplit before blocking join floods.
29-
details: ""
35+
details: |+
36+
The notifyrank field should be set to one of the following values:
37+
38+
Value | Description
39+
-------- | -----------
40+
0 | All users on the channel can receive join flood messages.
41+
10000 | Users with channel prefix mode `v` (voice) and above can receive join flood messages.
42+
30000 | Users with channel prefix mode `o` (op) and above can receive join flood messages.
43+
*custom* | Users with a channel prefix mode created by [the customprefix module](/4/modules/customprefix) can receive join flood messages.
44+
3045
example: |-
3146
```xml
3247
<joinflood bootwait="30s"
3348
duration="1m"
49+
notifyrank="0"
3450
splitwait="30s">
3551
```
3652

docs/4/modules/ldapauth.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ configuration:
6464
dbid="ldap-users"
6565
host="$cn.example.com"
6666
killreason="Access denied"
67-
userfield="no"
67+
field="nickname"
6868
verbose="yes">
6969
```
7070
- name: ldapexemption

docs/4/modules/pgsql.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ configuration:
4242
required: false
4343
default: 'No'
4444
description: |-
45-
Whether to connect to the PostgreSQL server using TLS.
45+
Whether to connect to the PostgreSQL server using TLS. This is only necessary if connecting over the public internet.
4646
- name: user
4747
type: Text
4848
required: true
@@ -68,7 +68,7 @@ configuration:
6868
id="opers"
6969
host="localhost"
7070
port="5432"
71-
tls="yes"
71+
tls="no"
7272
user="ircd_opers"
7373
pass="changeme"
7474
name="inspircd">

docs/4/modules/sharebans.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ extbans:
2929
chars:
3030
- name: share
3131
char: b
32-
type: Acting
32+
type: Matching
3333
syntax: <channel>
3434
description: Checks the ban list of &lt;channel&gt; for matching entries.
3535
example:

0 commit comments

Comments
 (0)