# This is an example of the config file for InspIRCd. #
# Change the options to suit your network #
# #
-# $Id$
+# $Id$ #
# #
# ____ _ _____ _ _ ____ _ _ _ #
# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
# <server name="server.name" #
# description="Server Description" #
# networkemail="Email address shown on g/k/z/q lines" #
+# id="serverid" #
# network="MyNetwork"> #
# #
+# The server ID is optional, and if omitted or set to 0, is auto- #
+# matically calculated from the server name and description. This is #
+# similar in behaviour to the server id on ircu and charybdis ircds. #
+# You should only need to set this manually if there is a collision #
+# between two server ID's on the network. The server ID must be #
+# between 1 and 999, if it is not, it will be wrapped to this range. #
+# There is a range of server ID's which are suffixed by two letters #
+# rather than two numbers, e.g. 1AA, 2FF, 3ZZ, which are reserved #
+# for use by non-inspircd servers such as services and stats servers.#
+# #
<server name="penguin.omega.org.za"
description="Waddle World"
- network="Omega">
+ id="0"
+ network="Omega">
#-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-#
# Enter the port and address bindings here. #
# #
# bind address - specifies which address ports bind to. Leaving this #
-# field blank binds the port to all IPs available. #
+# field blank binds the port to all IP's available. #
# #
# port - The port number to bind to. You may specify a port #
# range here, e.g. "6667-6669,7000,7001". If you do #
# this, the server will count each port within your #
-# range as a seperate binding, making the above #
-# example equivalent to five seperate bind tags. #
+# range as a separate binding, making the above #
+# example equivalent to five separate bind tags. #
# A failure on one port in the range does not prevent #
# the entire range from being bound, just that one #
# port number. #
# #
# type - can be 'clients' or 'servers'. The clients type is #
-# a standard tcp based socket, the servers type is a #
+# a standard TCP based socket, the servers type is a #
# also a TCP based connection but of a different #
# format. SSL support is provided by modules, to #
# enable SSL support, please read the module section #
# setting is ignored. #
# #
# transport - If you have m_spanningtree.so loaded, along with #
-# either of the SSL modules (m_ssl_gnutls or #
+# either one of the SSL modules (m_ssl_gnutls or #
# m_ssl_openssl) or m_ziplinks.so, then you may make #
# use of this value. #
# setting it to 'openssl' or 'gnutls' or 'zip' #
# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
# #
# If you want to link servers to InspIRCd you must load the #
-# m_spanningtree module! Please see the modules list below for #
+# m_spanningtree.so module! Please see the modules list below for #
# information on how to load this module! If you do not load this #
# module, server ports will NOT be bound! #
# #
# <bind address="ip address" port="port" type="clients"> #
# <bind address="ip address" port="port" type="servers"> #
# #
-# If InspIRCd is built for IPV6, and you wish to accept IPV4 clients, #
-# then you can specify IPV4 ip addresses here to bind. You may also #
-# use the 4in6 notation, ::ffff:1.2.3.4, where 1.2.3.4 is the IPV4 #
+# If InspIRCd is built for IPv6, and you wish to accept IPv4 clients, #
+# then you can specify IPv4 ip addresses here to bind. You may also #
+# use the 4in6 notation, ::ffff:1.2.3.4, where 1.2.3.4 is the IPv4 #
# address to bind the port, but as of InspIRCd 1.1.1, this is not #
# required. #
# #
# ------------------------------------------------------------------- #
# #
-# PLEASE NOTE: If you have build InspIRCd as an ipv6 server, and you #
+# PLEASE NOTE: If you have build InspIRCd as an IPv6 server, and you #
# specify an empty bind address, the binding will be bound to ALL THE #
-# IPV6 IP ADDRESSES, and not the ipv4 addresses. If you are using an #
-# ipv6 enabled InspIRCd and want to bind to multiple IPV4 addresses #
+# IPv6 IP ADDRESSES, and not the IPv4 addresses. If you are using an #
+# IPv6 enabled InspIRCd and want to bind to multiple IPv4 addresses #
# in this way, you must specify them by hand. If you have built the #
-# server for ipv4 connections only, then specifying an empty bind #
-# address binds the port to all ipv4 IP addresses, as expected. #
+# server for IPv4 connections only, then specifying an empty bind #
+# address binds the port to all IPv4 IP addresses, as expected. #
# #
<bind address="" port="6000" type="clients">
#-#-#-#-#-#-#-#-#-#- DIE/RESTART CONFIGURATION -#-#-#-#-#-#-#-#-#-#-
# #
# You can configure the passwords here which you wish to use for #
-# the die and restart commands. Only trusted ircops who will #
+# the die and restart commands. Only trusted IRCop's who will #
# need this ability should know the die and restart password. #
# #
# Syntax is as follows: #
# #
# Syntax is as follows: #
# #
-# <connect allow="1.2.3.0/24" password="blahblah" #
-# timeout="10" timeout="blah" flood="5" #
-# threshold="8" pingfreq="120" sendq="99999" #
+# <connect name="myallow" allow="1.2.3.0/24" limit="5" #
+# password="blahblah" timeout="10" timeout="blah" #
+# flood="5" threshold="8" pingfreq="120" sendq="99999" #
# revcq="696969" localmax="3" globalmax="3" #
-# port="6660"> #
+# port="6660" maxchans="50" limit="999"> #
+# #
+# <connect name="blocked" deny="127.0.0.1" port="6667"> #
# #
-# <connect deny="127.0.0.1" port="6667"> #
+# <connect name="something" parent="myallow" pingfreq="60"> #
# #
# IP masks may be specified in CIDR format or wildcard format, #
-# for IPV4 and IPV6. You *cannot* use hostnames in the allow or #
+# for IPv4 and IPv6. You *cannot* use hostnames in the allow or #
# deny field, as the state is applied before the user's DNS has #
# been resolved. #
# #
+# You can optionally name your connect allow/deny tags. If you do #
+# this, you may reference this connect tag as the parent of another #
+# connect tag with the <connect:parent> option as shown above. If #
+# you do this, any options not explicitly specified in the tag will #
+# be copied from the parent. #
+# #
+# If the value maxchans is included, this overrides all other max #
+# channels related settings, including the separate oper maximum. #
+# You may set this to any (sane) value you wish and it applies to #
+# all users within this connect tag. #
+# #
# You may optionally include timeout="x" on any allow line, which #
# specifies the amount of time given before an unknown connection #
-# is closed if USER/NICK/PASS are not given. This value is in secs #
+# is closed if USER/NICK/PASS are not given. This value is in secs. #
+# #
+# You may optionally limit the number of clients that are matched #
+# by a single <connect> tag by specifying the maximum in the limit #
+# parameter. If set to 0, there is no limit, which is the default. #
# #
# You should also include a flood="x" line which indicates #
# the number of lines a user may place into their buffer at once #
# settings as shown in the full example below. #
# The ping frequency is specified in seconds, and the sendq size #
# in bytes. It is recommended, although not enforced, that you #
-# should never set your sendq size to less than 8k. Send Queues are #
+# should never set your sendq size to less than 8K. Send Queues are #
# dynamically allocated and can grow as needed up to the maximum #
# size specified. #
# #
# only incoming connections on the specified port will match. Port #
# tags may be used on connect allow and connect deny tags. #
# #
+# The limit value determines the maximum number of users which may #
+# be in this class. Combine this with CIDR masks for various ISP #
+# subnets to limit the number of users which may connect at any one #
+# time from a certain ISP. Omit this value to not limit the tag. #
+# #
<connect allow="196.12.*" password="secret" port="6667">
sendq="262144"
recvq="8192"
localmax="3"
- globalmax="3">
+ globalmax="3"
+ limit="5000">
<connect deny="69.254.*">
<connect deny="3ffe::0/32">
#-#-#-#-#-#-#-#-#-#-#-#- CLASS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
# #
-# Classes are a group of commands which are grouped together #
-# and given a unique name. They used to define which commands #
+# Classes are a group of commands which are grouped together and #
+# given a unique name. They're used to define which commands #
# are available to certain types of Operators. #
# #
# Syntax is as follows: #
# your server, as well as the commands they are allowed to use. #
# This works alongside with the classes specified above. #
# #
-# type name - a name for the combined class types #
+# type name - a name for the combined class types. #
# a type name cannot contain spaces, however if you #
# put an _ symbol in the name, it will be translated #
# to a space when displayed in a WHOIS. #
# classes - specified above, used for flexibility for the #
# server admin to decide on which operators get #
# what commands. Class names are case sensitive, #
-# seperate multiple class names with spaces. #
+# separate multiple class names with spaces. #
# #
# host - optional hostmask operators will receive on oper-up. #
# #
#-#-#-#-#-#-#-#-#-#-#- OPERATOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
# #
# Opers are defined here. This is a very important section. #
-# Remember to only make operators out of truthworthy people. #
+# Remember to only make operators out of trust worthy people. #
# #
-# name - oper name, This is case sensitive, so it is best to #
+# name - oper name, this is case sensitive, so it is best to #
# use lower-case. #
# #
# password - password to oper-up, also case sensitive. #
# plaintext password in this value. #
# #
# host - hosts of client allowed to oper-up. #
-# wildcards accepted, seperate multiple hosts with a #
-# space. You may also specify CIDR ip addresses. #
+# wildcards accepted, separate multiple hosts with a #
+# space. You may also specify CIDR IP addresses. #
# #
-# fingerprint - When using the m_ssl_oper_cert.so module, you may #
+# fingerprint - when using the m_ssl_oper_cert.so module, you may #
# specify a key fingerprint here. This can be obtained #
# using the /fingerprint command whilst the module is #
# loaded, or from the notice given to you when you #
# connect to the ircd using a client certificate, #
# and will lock this oper block to only the user who #
# has that specific key/certificate pair. #
-# This enhances security a great deal, however it #
+# this enhances security a great deal, however it #
# requires that opers use clients which can send ssl #
# client certificates, if this is configured for that #
# oper. Note that if the m_ssl_oper.so module is not #
# is not loaded, this configuration option has no #
# effect and will be ignored. #
# #
-# type - Defines the kind of operator. This must match a type #
+# type - defines the kind of operator. This must match a type #
# tag you defined above, and is case sensitive. #
# #
# Syntax is as follows: #
# <oper name="login" #
# password="pass" #
# host="hostmask@of.oper" #
-# fingerprint="hexsequence" #
+# fingerprint="hexsequence" #
# type="oper type"> #
# #
# Defines which servers can link to this one, and which servers this #
# server may create outbound links to. #
# #
-# name - The name is the canocial name of the server, does #
+# name - the name is the canonical name of the server, does #
# not have to resolve - but it is expected to be set #
# in the remote servers connection info. #
# #
-# ipaddr - Valid host or ip address for remote server. These #
+# ipaddr - valid host or IP address for remote server. These #
# hosts are resolved on rehash, and cached, if you #
-# specify a hostname, so if you find that your server #
+# specify a hostname; so if you find that your server #
# is still trying to connect to an old IP after you #
-# have updated your dns, try rehashing and then #
+# have updated your DNS, try rehashing and then #
# attempting the connect again. #
# #
-# port - The TCP port for the remote server. #
+# port - the TCP port for the remote server. #
# #
-# sendpass - Password to send to create an outbound connection #
+# sendpass - password to send to create an outbound connection #
# to this server. #
# #
-# recvpass - Password to receive to accept an inbound connection #
+# recvpass - password to receive to accept an inbound connection #
# from this server. #
# #
-# autoconnect - Sets the server to autoconnect. Where x is the num. #
+# autoconnect - sets the server to autoconnect. Where x is the num. #
# (optional) of seconds between attempts. e.g. 300 = 5 minutes. #
# #
-# transport - If defined, this is a transport name implemented by #
+# transport - if defined, this is a transport name implemented by #
# another module. Transports are layers on top of #
# plaintext connections, which alter them in certain #
# ways. Currently the three supported transports are #
# link to succeed. OpenSSL and GnuTLS are link- #
# compatible with each other. #
# #
-# hidden - When using m_spanningtree.so for linking. you may #
+# statshidden - when using m_spanningtree.so for linking. you may #
# set this to 'yes', and if you do, the IP address/ #
# hostname of this connection will NEVER be shown to #
-# any opers on the network. In /STATS c its address #
+# any opers on the network. In /stats c its address #
# will show as *@<hidden>, and during CONNECT and #
-# inbound connections, its IP will show as <hidden> #
+# inbound connections, it's IP will show as <hidden> #
# UNLESS the connection fails (e.g. due to a bad #
# password or servername) #
# #
-# allowmask - When this is defined, it indicates a range of IP #
+# allowmask - when this is defined, it indicates a range of IP #
# addresses to allow for this link (You may use CIDR #
# or wildcard form for this address). #
# e.g. if your server is going to connect to you from #
# into this value. If it is not defined, then only #
# the ipaddr field of the server shall be allowed. #
# #
-# failover - If you define this option, it must be the name of a #
+# failover - if you define this option, it must be the name of a #
# different link tag in your configuration. This #
# option causes the ircd to attempt a connection to #
# the failover link in the event that the connection #
# apply to autoconnected servers as well as manually #
# connected ones. #
# #
-# timeout - If this is defined, then outbound connections will #
+# timeout - if this is defined, then outbound connections will #
# time out if they are not connected within this many #
# seconds. If this is not defined, the default of ten #
# seconds is used. #
# #
-# bind - If you specify this value, then when creating an #
+# bind - if you specify this value, then when creating an #
# outbound connection to the given server, the IP you #
# place here will be bound to. This is for multi- #
# homed servers which may have multiple IP addresses. #
-# If you do not define this value, the first IP that #
+# if you do not define this value, the first IP that #
# is not empty or localhost from your <bind> tags #
# will be bound to. This is usually acceptable, #
# however if your server has multiple network cards #
# then you may have to manually specify the bind #
# value instead of leaving it to automatic binding. #
-# You can usually tell if you need to set this by #
+# you can usually tell if you need to set this by #
# looking for the error 'Could not assign requested #
# address' in your log when connecting to servers. #
# #
-# hidden - If this is set to true, yes, or 1, then the server #
+# hidden - if this is set to true, yes, or 1, then the server #
# is completely hidden from non-opers. It does not #
-# show in LINKS and it does not show in MAP. Also, #
+# show in /links and it does not show in /map. Also, #
# any servers which are child servers of this one #
# in the network will *also* be hidden. Use with #
# care! You can use this to 'mask off' sections of #
# example to hide a non-client hub, for which clients #
# do not have an IP address or resolvable hostname. #
# #
-# to u:line a server (give it extra privilages required for running #
+# to u:line a server (give it extra privileges required for running #
# services, Q, etc) you must include the <uline server> tag as shown #
# in the example below. You can have as many of these as you like. #
# #
# #
# ------------------------------------------------------------------- #
# #
-# NOTE: If you have built your server as an ipv6 server, then when a #
-# DNS lookup of a server's host occurs, AAAA records (ipv6) are #
-# priorotized over A records (ipv4). Therefore, if the server you are #
-# connecting to has both an IPV6 ip address and an IPV4 ip address in #
-# its DNS entry, the IPV6 address will *always* be selected. To #
-# change this behaviour simply specify the IPV4 IP address rather #
+# NOTE: If you have built your server as an IPv6 server, then when a #
+# DNS lookup of a server's host occurs, AAAA records (IPv6) are #
+# prioritised over A records (IPv4). Therefore, if the server you are #
+# connecting to has both an IPv6 IP address and an IPv4 IP address in #
+# its DNS entry, the IPv6 address will *always* be selected. To #
+# change this behaviour simply specify the IPv4 IP address rather #
# than the hostname of the server. #
# #
# ------------------------------------------------------------------- #
# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
# #
# If you want to link servers to InspIRCd you must load the #
-# m_spanningtree module! Please see the modules list below for #
+# m_spanningtree.so module! Please see the modules list below for #
# information on how to load this module! If you do not load this #
# module, server links will NOT work! #
# #
timeout="15"
transport="gnutls"
bind="1.2.3.4"
+ statshidden="no"
hidden="no"
sendpass="outgoing!password"
recvpass="incoming!password">
# permissions, and should be used with caution. Services servers are #
# usually u-lined in this manner. #
# #
-# The 'silent' value if set to yes indicates that this server should #
+# The 'silent' value, if set to yes, indicates that this server should#
# not generate quit and connect notices, which can cut down on noise #
# to opers on the network. #
# #
# #
# These options let you define the path to your motd and rules #
# files. If these are relative paths, they are relative to the #
-# configurtion directory. #
+# configuration directory. #
# #
<files motd="inspircd.motd.example"
# #
# This optional configuration tag lets you define the maximum number #
# of channels that both opers and users may be on at any one time. #
-# the default is 20 for user and 60 for opers if this tag is not #
+# The default is 20 for users and 60 for opers if this tag is not #
# defined. Remote users are not restricted in any manner. #
# #
#-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# #
# Define your DNS server address here. InspIRCd has its own resolver. #
-# If you do not define this value, then then InspIRCd will attempt to #
+# If you do not define this value, then InspIRCd will attempt to #
# determine your DNS server from your operating system. On POSIX #
# platforms, InspIRCd will read /etc/resolv.conf, and populate this #
# value with the first DNS server address found. On Windows platforms #
# #
# When choosing a server, be sure to choose one which will do a #
# RECURSIVE LOOKUP. InspIRCd's resolver does not currently do these #
-# recursive lookups itself, to save time and resources. The dns #
+# recursive lookups itself, to save time and resources. The DNS #
# server recommended by the InspIRCd team is bind, available from the #
# ISC website. If your DNS server does not do a recursive lookup, you #
# will be able to notice this by the fact that none of your users are #
# #
# ------------------------------------------------------------------- #
# #
-# NOTE: if you have built InspIRCd with IPV6 support, then both #
-# ipv6 and ipv4 addresses are allowed here, and also in the system #
-# resolv.conf file. Remember that an ipv4 dns server can still #
-# resolve ipv6 addresses, and vice versa. #
+# NOTE: if you have built InspIRCd with IPv6 support, then both #
+# IPv6 and IPv4 addresses are allowed here, and also in the system #
+# resolv.conf file. Remember that an IPv4 DNS server can still #
+# resolve IPv6 addresses, and vice versa. #
# #
<dns server="127.0.0.1" timeout="5">
-# An example of using an IPV6 nameserver
+# An example of using an IPv6 nameserver
#<dns server="::1" timeout="5">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# #
# Define the path to the PID file here. The PID file can be used to #
# rehash the ircd from the shell or to terminate the ircd from the #
-# shell using shell scripts, perl scripts etc, and to monitor the #
+# shell using shell scripts, perl scripts, etc... and to monitor the #
# ircd's state via cron jobs. If this is a relative path, it will be #
# relative to the configuration directory, and if it is not defined, #
# the default of 'inspircd.pid' is used. #
#-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# #
# Use these tags to customise the ban limits on a per channel basis. #
-# the tags are read from top to bottom, and any tag found which #
+# The tags are read from top to bottom, and any tag found which #
# matches the channels name applies the banlimit to that channel. #
# It is advisable to put an entry with the channel as '*' at the #
# bottom of the list. If none are specified or no maxbans tag is #
#-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
# #
-# Settings to define which features are useable on your server. #
+# Settings to define which features are usable on your server. #
# #
# prefixquit - A prefix to be placed on the start of a client's #
# quit message #
# query. This is to prevent /WHO being used as a #
# spam vector or means of flooding an ircd. The #
# default is 128, it is not recommended to raise it #
-# above 1024. Values up to 65535 are permitted. #
+# above 1024. Values up to 65535 are permitted. If #
+# this value is omitted, any size WHO is allowed by #
+# anyone. #
# #
# somaxconn - The maximum number of sockets that may be waiting #
# in the accept queue. This usually allows the ircd #
# actual server the user is on. #
# #
# flatlinks - When you are using m_spanningtree.so, and this #
-# value is set to true, yes or 1, /MAP and /LINKS #
-# will be flattened when shown to a non-oper. #
+# value is set to yes, true or 1, /MAP and /LINKS #
+# will be flattened when shown to a non-opers. #
# #
# hideulines - When you are using m_spanningtree.so, and this #
-# value is set to true, yes or 1, then U-lined #
-# servers will be hidden in /LINKS and /MAP. For non #
+# value is set to yes, true or 1, then U-lined #
+# servers will be hidden in /LINKS and /MAP for non #
# opers. Please be aware that this will also hide #
# any leaf servers of a U-lined server, e.g. jupes. #
# #
-# nouserdns - If set to 'yes', 'true' or '1', no user dns #
-# lookups will be performed for connecting users. #
-# this can save a lot of resources on very busy irc #
-# servers. #
+# nouserdns - If set to yes, true or 1, no user DNS lookups #
+# will be performed for connecting users. This can #
+# save a lot of resources on very busy IRC servers. #
# #
-# syntaxhints - If set to 'yes', 'true' or '1', when a user does #
-# not give enough parameters for a command, a syntax #
+# syntaxhints - If set to yes, true or 1, when a user does not #
+# give enough parameters for a command, a syntax #
# hint will be given (using the RPL_TEXT numeric) #
# as well as the standard ERR_NEEDMOREPARAMS. #
# #
-# announcets - If this value is defined to 'yes', 'true' or '1', #
-# then if a channel's timestamp is updated the users #
-# on the channel will be informed of the change via #
+# announcets - If this value is defined to yes, true or 1, then #
+# a channel's timestamp is updated, the users on #
+# the channel will be informed of the change via #
# a server notice to the channel with the old and #
# new TS values in the timestamp. If you think this #
# is just pointless noise, define the value to 0. #
# if set to no, then only the nickname is shown. #
# #
# announceinvites #
-# - If this option is set to yes (the default), then #
-# invites are announced to the channel when a user #
-# invites annother user. If you consider this to be #
-# unnecessary noise, explicitly set this to no. #
+# - If this option is set, then invites are announced #
+# to the channel when a user invites another user. #
+# If you consider this to be unnecessary noise, #
+# set this to 'none'. To announce to all ops, set #
+# this to 'ops' and to announce to all users set the #
+# value to 'all'. #
+# #
+# The value 'dynamic' varies between 'ops' and 'all' #
+# settings depending on if the channel is +i or not. #
+# When the channel is +i, messages go only to ops, #
+# and when the channel is not +i, messages go to #
+# everyone. In short, the messages will go to every #
+# user who has power of INVITE on the channel. This #
+# is the recommended setting. #
# #
# disablehmac - If you are linking your InspIRCd to older versions #
# then you can specify this option and set it to #
# such as BOPM which rely on them to scan users when #
# a split heals in certain configurations. #
# #
+# serverpingfreq- This value, when set, allows you to change the #
+# frequency of server to server PING messages. This #
+# can help if you are having certain network issues. #
+# #
# pingwarning - This should be set to a number between 1 and 59 if #
# defined, and if it is defined will cause the server#
# to send out a warning via snomask +l if a server #
# #
# exemptchanops - This option allows channel operators to be exempted#
# from certain channel modes. #
-# Supported modes are +SfgNc. Defaults to off. #
+# Supported modes are +SfFgNc. Defaults to off. #
# #
# defaultmodes - The default modes to be given to each channel on #
# creation. Defaults to 'nt'. There should be no + #
# or - symbols in this sequence, if you add them #
# they will be ignored. You may add parameters for #
-# parameterised modes. #
+# modes which take them. #
# #
# moronbanner - The NOTICE to show to users who are glined, zlined #
# klined or qlined when they are disconnected. This #
hidemodes="eI"
quietbursts="yes"
pingwarning="15"
+ serverpingfreq="60"
allowhalfop="yes"
defaultmodes="nt"
+ announceinvites="dynamic"
moronbanner="You're banned! Email haha@abuse.com with the ERROR line below for help."
exemptchanops="">
#-#-#-#-#-#-#-#-#-#-#-#-#-#- TIME SYNC OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#
-# Time sychronization options for m_spanningtree linking. #
+# Time synchronisation options for m_spanningtree linking. #
# #
# Because IRC is very time and clock dependent, InspIRCd provides its #
-# own methods for syncronization of time between servers as shown #
+# own methods for synchronisation of time between servers as shown #
# in the example below, for servers that don't have ntpd running. #
# #
# enable - If this value is 'yes', 'true', or '1', time #
-# synchronization is enabled on this server. This #
+# synchronisation is enabled on this server. This #
# means any servers you are linked to will #
-# automatically synchronize time, however you should #
+# automatically synchronise time, however you should #
# use ntpd instead where possible, NOT this option. #
# #
# master - If this value is set to yes, then this server will #
# command "foo bar baz qux quz" then $3- will hold #
# "baz qux quz" and $2 will contain "bar". You may #
# also use the special variables: $nick, $ident, #
-# $host and $vhost, and you may seperate multiple #
+# $host and $vhost, and you may separate multiple #
# commands with \n. If you wish to use the ACTUAL #
# characters \ and n together in a line, you must #
# use the sequence "\\n". #
#-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
#
# Optional - If you specify to use m_cgiirc, then you must specify one
-# or more cgihost tags which indicate authorized CGI:IRC servers which
+# or more cgihost tags which indicate authorised CGI:IRC servers which
# will be connecting to your network, and an optional cgiirc tag.
# For more information see: http://www.inspircd.org/wiki/CGI-IRC_Module
#
# <cgihost type="webirc" mask="somebox.mysite.com"> # Get IP from WEBIRC
# <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
# <cgihost type="passfirst" mask="www.mysite.com"> # See the docs
+#
+# IMPORTANT NOTE:
+# ---------------
+#
+# When you connect CGI:IRC clients, there are two connect classes which
+# apply to these clients. When the client initially connects, the connect
+# class which matches the cgi:irc site's host is checked. Therefore you
+# must raise the maximum local/global clients for this ip as high as you
+# want to allow cgi clients. After the client has connected and is
+# determined to be a cgi:irc client, the class which matches the client's
+# real IP is then checked. You may set this class to a lower value, so that
+# the real IP of the client can still be restricted to, for example, 3
+# sessions maximum.
+#
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# CHGIDENT module: Adds the /CHGIDENT command
#<module name="m_chgident.so">
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# CHGNAME module: Adds the /CHGNAME command
+#<module name="m_chgname.so">
+
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Cloaking module: Adds usermode +x and cloaking support.
# Relies on the module m_md5.so being loaded before m_cloaking.so in
# must define cloak keys, and optionally a cloak prefix as shown #
# below. When using cloaking, the cloak keys are MANDITORY and must #
# be included. However, if prefix is not included, it will default #
-# to your networks name from the <server> tag. #
+# to your networks name from the <server> tag. You can also include #
+# the following optional values: #
+# #
+# ipalways - Always cloak the IP address, not the hostname, #
+# which doesn't reveal the user's ISP, but #
+# results in hosts that are harder to read and #
+# ban. #
+# #
+# lowercase - Display the cloaked hostnames in lowercase #
+# characters instead of uppercase #
# #
# <cloak key1="0x2AF39F40" #
# key2="0x78E10B32" #
# key3="0x4F2D2E82" #
# key4="0x043A4C81" #
-# prefix="mynet"> #
+# prefix="mynet" #
+# ipalways="false" #
+# lowercase="false"> #
# #
# Please note that the key values will accept any number, and should #
# be large numbers. Using small numbers such as "7" or "1924" will #
# use hexdecimal numbers prefixed by "0x", as shown in this example, #
# with each key eight hex digits long. #
+#-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Close module: Allows an oper to close all unregistered connections.
+#<module name="m_close.so">
+
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Clones module: Adds an oper command /CLONES for detecting cloned
# users. Warning: This module may be resource intensive when its
# command is issued, use with care.
#<module name="m_clones.so">
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Common channels module: Adds user mode +c, which, when set, requires
+# that users must share a common channel with you to PRIVMSG or NOTICE
+# you.
+#<module name="m_commonchans.so">
+
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Conn-Join: Allows you to force users to join one or more channels
# automatically upon connecting to the server.
#<connflood seconds="30" maxconns="3" timeout="30"
# quitmsg="Throttled" bootwait="10">
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Custom title module: Adds the /TITLE command which allows for trusted
+# users to gain a custom whois line and a optional
+# vhost can be specified.
+#<module name="m_customtitle.so">
+#
+#-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
+# name - The username used to identify
+# password - The password used to identify
+# host - Allowed hostmask [optional]
+# title - Title shown in whois
+# vhost - Displayed host [optional]
+#
+#<title name="foo" password="bar" title="Official Chat Helper">
+#<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
+
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# DCCALLOW module: Adds the /DCCALLOW command
#<module name="m_dccallow.so">
# channel messages and channel notices.
#<module name="m_deaf.so">
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Delay join module: Adds the channel mode +D which delays all JOIN
+# messages from users until they speak. If they quit or part before
+# speaking, their quit or part message will not be shown to the channel
+# which helps cut down noise on large channels in a more friendly way
+# than the auditorium mode. Only channel ops may set the +D mode.
+#<module name="m_delayjoin.so">
+
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Deny Channels: Deny Channels from being used by users
#<module name="m_denychans.so">
#<hostchange mask="*@fbi.gov" action="addnick">
#<hostchange mask="*r00t@*" action="suffix">
#<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
+#<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# httpd module: Provides http server support for InspIRCd
# This is supported by mIRC, x-chat, klient, and maybe more.
#<module name="m_namesx.so">
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Nickchange flood protection module: Allows up to X nick changes in Y seconds.
+# Provides channel mode +F.
+#<module name="m_nickflood.so">
+
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Nicklock module: Let opers change a user's nick and then stop that
# user from changing their nick again.
# Securelist can be harmful to some irc search engines such as #
# netsplit.de and searchirc.com. To prevent securelist blocking these #
# sites from listing, define exception tags as shown below: #
-<securelist exception="*@*.searchirc.org">
-<securelist exception="*@*.netsplit.de">
-<securelist exception="*@echo940.server4you.de">
+<securehost exception="*@*.searchirc.org">
+<securehost exception="*@*.netsplit.de">
+<securehost exception="*@echo940.server4you.de">
# #
# Define the following variable to change how long a user must wait #
# before issuing a LIST. If not defined, defaults to 60 seconds. #
# Services support module: Adds several usermodes such as +R and +M
# this module implements the 'identified' state via user mode +r, which
# is similar to the DALnet and dreamforge systems.
+#
+# N O T E!!
+# >> This CAN NOT be used at the same time as m_services_account <<
+# N O T E!!
#<module name="m_services.so">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Services support module: Adds several usermodes such as +R and +M
# this module implements the 'identified' state via account names (AC)
# and is similar in operation to the way asuka and ircu handle services.
-# it cannot be used at the same time as m_services, above.
+#
+# N O T E!!
+# >> This CAN NOT be used at the same time as m_services <<
+# N O T E!!
#<module name="m_services_account.so">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Spy module: Adds the commands SPYLIST and SPYNAMES that let opers
# see who is in a +s channel, and list +s channels, show keys of keyed
-# channels the oper is not a member of etc. (standard 'abusive' features
-# of many other ircds, modulized here in InspIRCd).
+# channels the oper is not a member of etc. Like most standard 'abusive'
+# features of many other ircds, this is modular in InspIRCd.
#<module name="m_spy.so">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# SQL logging module: Allows you to log network-wide data for your
-# network in a fully normalized set of SQL tables. You must copy the
+# network in a fully normalised set of SQL tables. You must copy the
# source for this module from the directory src/modules/extra
#<module name="m_sqllog.so">
#
# added/removed by Services. #
#<module name="m_svshold.so">
-
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# SWHOIS module: Allows you to add arbitary lines to user WHOIS.
#<module name="m_swhois.so">
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Taxonomy module: Adds the /TAXONOMY command, used to view all
+# metadata attached to a user.
+#<module name="m_taxonomy.so">
+
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Test command module: Does nothing significant. Read: pointless.
#<module name="m_testcommand.so">
# #
# You should already know what to do here :) #
-<die value="User error. Insert new user and press any key.">
+<die value="User error. Insert new user and press any key. (you didn't edit your config properly.)">
#########################################################################
projects / user / henk / code / inspircd.git / blobdiff