Skip to content

Commit 3e2cc6f

Browse files
badeiommeaaronmdjones
authored andcommitted
Add max_autoconn to documentation
7c7065b introduced class::max_autoconn configuration parameter. However, this parameter was never added to config.rst and the example config. This commits adds them there as well.
1 parent 7289d45 commit 3e2cc6f

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

Diff for: doc/ircd.conf.example

+1
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,7 @@ class "server" {
138138
ping_time = 5 minutes;
139139
connectfreq = 5 minutes;
140140
max_number = 1;
141+
max_autoconn = 1;
141142
sendq = 4 megabytes;
142143
};
143144

Diff for: doc/oper-guide/config.rst

+10-3
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,7 @@ class {} block
138138
ping_time = duration;
139139
connectfreq = duration;
140140
max_number = number;
141+
max_autoconn = number;
141142
sendq = size;
142143
};
143144
@@ -200,9 +201,15 @@ connectfreq
200201
minute, as autoconnects are evaluated with that granularity.
201202

202203
max\_number
203-
The amount of servers to autoconnect to in this class. More
204-
precisely, no autoconnects are done if the number of servers in this
205-
class is greater than or equal max\_number
204+
The amount of servers that can be connected in this class.
205+
206+
max\_autoconn
207+
The amount of servers to autoconnect to. If the number of servers
208+
in the class is or exceeds this, no more servers in the class are
209+
autoconnected. Oper initiated connects are unaffected. This should
210+
usually be set to either 0 or 1 (autoconnecting from hubs to
211+
leaves may cause leaves to function as hubs by having multiple
212+
servers connected to them).
206213

207214
sendq
208215
The maximum size of the queue of data to be sent to a server before

0 commit comments

Comments
 (0)