Skip to content

Commit

Permalink
Add max_autoconn to documentation
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
badeiomme authored and aaronmdjones committed Feb 11, 2025
1 parent 7289d45 commit 3e2cc6f
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
1 change: 1 addition & 0 deletions doc/ircd.conf.example
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ class "server" {
ping_time = 5 minutes;
connectfreq = 5 minutes;
max_number = 1;
max_autoconn = 1;
sendq = 4 megabytes;
};

Expand Down
13 changes: 10 additions & 3 deletions doc/oper-guide/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ class {} block
ping_time = duration;
connectfreq = duration;
max_number = number;
max_autoconn = number;
sendq = size;
};
Expand Down Expand Up @@ -200,9 +201,15 @@ connectfreq
minute, as autoconnects are evaluated with that granularity.

max\_number
The amount of servers to autoconnect to in this class. More
precisely, no autoconnects are done if the number of servers in this
class is greater than or equal max\_number
The amount of servers that can be connected in this class.

max\_autoconn
The amount of servers to autoconnect to. If the number of servers
in the class is or exceeds this, no more servers in the class are
autoconnected. Oper initiated connects are unaffected. This should
usually be set to either 0 or 1 (autoconnecting from hubs to
leaves may cause leaves to function as hubs by having multiple
servers connected to them).

sendq
The maximum size of the queue of data to be sent to a server before
Expand Down

0 comments on commit 3e2cc6f

Please sign in to comment.