########################################################################
-# #
-# --------------------------- #
-# InspIRCd Configuration File #
-# --------------------------- #
-# #
+# #
+# ___ ___ ____ ____ _ #
+# |_ _|_ __ ___ _ __|_ _| _ \ / ___|__| | #
+# | || '_ \/ __| '_ \| || |_) | | / _` | #
+# | || | | \__ \ |_) | || _ <| |__| (_| | #
+# |___|_| |_|___/ .__/___|_| \_\\____\__,_| #
+# |_| #
+# ____ __ _ _ _ #
+# / ___|___ _ __ / _(_) __ _ _ _ _ __ __ _| |_(_) ___ _ __ #
+# | | / _ \| '_ \| |_| |/ _` | | | | '__/ _` | __| |/ _ \| '_ \ #
+# | |__| (_) | | | | _| | (_| | |_| | | | (_| | |_| | (_) | | | | #
+# \____\___/|_| |_|_| |_|\__, |\__,_|_| \__,_|\__|_|\___/|_| |_| #
+# |___/ #
+# #
##################################||####################################
- #||#
+ #||#
##################################||####################################
-# #
+# #
# This is an example of the config file for InspIRCd. #
# Change the options to suit your network #
-# #
-# Last updated on : 06/06/2005 #
-# Written by : CC (cc@backchat.co.za) #
-# Updated by : katsklaw (katsklaw@gmail.com) #
+# #
+# $Id$
+# #
+# ____ _ _____ _ _ ____ _ _ _ #
+# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
+# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
+# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
+# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
+# #
+# Lines prefixed with READ THIS BIT, as shown above, are IMPORTANT #
+# lines, and you REALLY SHOULD READ THEM. Yes, THIS MEANS YOU. Even #
+# if you've configured InspIRCd before, these probably indicate #
+# something new or different to this version and you SHOULD READ IT. #
+# #
+########################################################################
+# #
+# Unalphabeticalise the modules list at your own risk #
+# #
########################################################################
+#-#-#-#-#-#-#-#-#-# INCLUDE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#-#
+# #
+# This optional tag allows you to include another config file #
+# allowing you to keep your configuration tidy. The configuration #
+# file you include will be treated as part of the configuration file #
+# which includes it, in simple terms the inclusion is transparent. #
+# #
+# All paths to config files are relative to the directory of the main #
+# config file inspircd.conf, unless the filename starts with a forward#
+# slash (/) in which case it is treated as an absolute path. #
+# #
+# You may also include an executable file, in which case if you do so #
+# the output of the executable on the standard output will be added #
+# to your config at the point of the include tag. #
+# #
+# Syntax is as follows: #
+#<include file="file.conf"> #
+#<include executable="/path/to/executable parameters"> #
+# #
+# Executable Include Example: #
+#<include executable="/usr/bin/wget -q -O - http://mynet.net/inspircd.conf">
+# #
#-#-#-#-#-#-#-#-#-#-#-#- SERVER DESCRIPTION -#-#-#-#-#-#-#-#-#-#-#-#-
-# #
+# #
# Here is where you enter the information about your server. #
-# #
-# Syntax is as follows: #
-# <server name="server.name" #
-# description="Server Description" #
-# network="MyNetwork"> #
-# #
+# #
+
+<server
+ # name: Hostname of your server. Does not need to resolve, but
+ # does need to be correct syntax (something.somethingelse.tld).
+ name="penguin.omega.org.za"
-<server name="penguin.omega.org.za"
+ # description: Server description. Spaces are allowed.
description="Waddle World"
+
+ # id: The SID to use for this server. This should not be uncommented
+ # unless there is a SID conflict. This must be three characters long.
+ # The first character must be a digit [0-9], the remaining two chars
+ # may be letters [A-Z] or digits.
+ #id="97K"
+
+ # network: Network name given on connect to clients.
+ # Should be the same on all servers on the network and
+ # not contain spaces.
network="Omega">
#-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-#
-# #
-# Describes the Server Administrator's real name, nick #
-# and email address. #
-# #
-# Syntax is as follows: #
-# <admin name="real name" #
-# nick="nick name" #
-# email="email@address.com"> #
-# #
+# #
+# Describes the Server Administrator's real name (optionally), #
+# nick, and email address. #
+# #
+
+<admin
+ # name: Real Name
+ name="Johnny English"
-<admin name="Johnny English"
- nick="MI5"
- email="MI5@the.best.secret.agent">
+ # nick: Nickname (preferably what you use on the network)
+ nick="MI5"
+
+ # email: email address. Does not have to be valid
+ # but should be for the users to be able to contact you.
+ email="MI5@the.best.secret.agent">
#-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
-# #
-# Enter the port and address bindings here. #
-# #
-# bind address - specifies which the address which ports bind #
-# port - opens an unused port #
-# type - can be 'clients' or 'servers'. The clients type is #
-# a standard tcp based socket, the servers type is a #
-# also a TCP based connection but of a different #
-# format. #
-# default - if the port type is 'servers' then this can be #
-# specified. If set to 'yes', it indicates that this #
-# port is the default route for all /connect commands.#
-# if you do not bind your default route to an #
-# external ip, or all ip's, you may have connection #
-# problems. #
-# #
-# Leaving address empty binds to all available interfaces #
-# #
-# Syntax is as follows: #
# #
-# <bind address="ip number" port="port" type="clients"> #
-# <bind address="ip number" port="port" type="servers"> #
-# <bind address="ip number" port="port" type="servers" default="yes"> #
-# #
+# Enter the port and address bindings here. #
+# #
+# #
+# ____ _ _____ _ _ ____ _ _ _ #
+# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
+# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
+# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
+# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
+# #
+# If you want to link servers to InspIRCd you must load the #
+# 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! #
+# #
+# PLEASE NOTE: If you have build InspIRCd with IPv6 support, you MUST #
+# specify a bind address if you want the IRCd to bind to a IPv4 IP. #
+
+<bind
+ # address: IP address to bind to if the box that you are hosting
+ # on has more than one IP, else the ircd will try to bind to all
+ # IP's on the box if this is not defined.
+ address=""
+
+ # port: Port for users or servers to be able to connect to.
+ # you can select multiple ports by separating them
+ # with a - character like the example below.
+ port="6697"
+
+ # type: Type of bind block this is. It can either be clients or
+ # servers. Whichever you select will be the only type able to connect
+ # to this bind section.
+ type="clients"
+
+ # ssl: If you want this bind section to use SSL, define either
+ # gnutls or openssl here. The appropriate SSL modules must be loaded
+ # for ssl to work. If you do not want this bind section to support ssl,
+ # just remove or comment out this option.
+ ssl="gnutls"
+ >
+
+<bind address="" port="6660-6669" type="clients">
+
+# When linking servers, the openssl and gnutls transports are largely
+# link-compatible and can be used alongside each other
+# on each end of the link without any significant issues.
+# Transports can only be used on server blocks.
+# Supported Transports are: "zip", "openssl" and "gnutls".
+# You must load m_ziplinks module for zip, m_ssl_openssl for openssl
+# or m_ssl_gnutls for gnutls.
-<bind address="" port="6660" type="clients">
-<bind address="" port="7000" type="servers" default="yes">
-<bind address="" port="7001" type="servers">
+<bind address="" port="7000,7001" type="servers">
+<bind address="1.2.3.4" port="7005" type="servers" transport="openssl">
#-#-#-#-#-#-#-#-#-#- 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: #
-# <power diepass="die password" restartpass="restart password" #
-# pause="secs before dying"> #
-# #
-<power diepass="diepass" restartpass="restartpass" pause="2">
+<power
+ # hash: what hash these passwords are hashed with. requires the module
+ # for selected hash (m_md5.so, m_sha256.so or m_ripemd160.so) be
+ # loaded and the password hashing module (m_password_hash.so)
+ # loaded. Options here are: "md5", "sha256" and "ripemd160".
+ # Optional, but recommended. Create hashed password with:
+ # /mkpasswd <hash> <password>
+ #hash="sha256"
+ # diepass: Password for opers to use if they need to shutdown (die)
+ # a server.
+ diepass=""
-#-#-#-#-#-#-#-#-#-# INCLUDE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#-#
-# #
-# This optional tag allows you to include another config file #
-# allowing you to keep your configuration tidy. The configuration #
-# file you include will be treated as part of the configuration file #
-# which includes it, in simple terms the inclusion is transparent. #
-# #
-# All paths to config files are relative to the directory of the main #
-# config file inspircd.conf, unless the filename starts with a forward#
-# slash (/) in which case it is treated as an absolute path. #
-# #
-# Syntax is as follows: #
-# <include file="file.conf"> #
-# #
+ # restartpass: Password for opers to use if they need to restart
+ # a server.
+ restartpass="">
-#-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-
-# #
+
+#-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
+# #
# This is where you can configure which connections are allowed #
-# and denied access onto your server. #
-# The password is optional. #
-# You may have as many of these as you require. #
-# To allow/deny all connections use a * #
-# #
-# Syntax is as follows: #
-# <connect allow="ip or host"> #
-# <connect allow="ip or host" password="blahblah"> #
-# <connect allow="ip or host" password="blah" timeout="10"> #
-# <connect allow="ip or host" timeout="blah" flood="5"> #
-# <connect allow="ip or host" threshold="8" pingfreq="120"> #
-# <connect allow="ip or host" sendq="99999" revcq="696969"> #
-# <connect deny="ip or host"> #
-# #
-# 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 #
-# #
-# You may also optionally include a flood="x" line which indicates #
-# the number of lines a user may place into their buffer at once #
-# before they are disconnected for excess flood. The default is to #
-# DISABLE this feature. A recommended value is 10. A counter is #
-# maintained for each user which is reset every 'threshold' seconds #
-# and specifying this threshold value with threshold="X" indicates #
-# how often the counter is reset. For example, with flood="5" and #
-# threshold="8", the user may not send more than 5 lines in 8 secs. #
-# #
-# You may optionally specify the sendq size and ping frequency of #
-# each connect:allow line using the pingfreq="X" and sendq="X" #
-# 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 #
-# dynamically allocated and can grow as needed up to the maximum #
-# size specified. #
-# #
-# The optional recvq value is the maximum size which users in this #
-# group may grow their receive queue to. This is recommended to be #
-# kept pretty low compared to the sendq, as users will always #
-# recieve more than they send in normal circumstances. The default #
-# if not specified is 4096. #
-# #
-# IMPORTANT NOTE, CALL THE CONFUSION POLICE! #
-# The sendq is the data waiting to be sent TO THE USER. #
-# The recvq is the data being received FROM THE USER. #
-# The names sendq and recvq are from the SERVER'S PERSPECTIVE not #
-# that of the user... Just to clear up any confusion or complaints #
-# that these are backwards :p #
-# #
-
-<connect allow="196.12.*" password="secret">
-<connect allow="*" timeout="60" flood="10" threshold="60" pingfreq="120" sendq="262144" recvq="4096">
-
-<connect deny="69.254.*">
-
-
-#-#-#-#-#-#-#-#-#-#-#-#- CLASS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
-# #
-# Classes are a group of commands which are grouped together #
-# and given a unique name. They used to define which commands #
-# are available to certain types of Operators. #
-# #
-# Syntax is as follow: #
-# <class name="name" commands="oper commands"> #
-# #
+# and denied access onto your server. The password is optional. #
+# You may have as many of these as you require. To allow/deny all #
+# connections, use a '*' or 0.0.0.0/0. #
+# #
+# -- It is important to note that connect tags are read from the -- #
+# TOP DOWN. This means that you should have more specific deny #
+# and allow tags at the top, progressively more general, followed #
+# by a <connect allow="*" (should you wish to have one). #
+# #
+# #
+<connect
+ # deny: Will not let people connect if they have specified host/IP.
+ deny="69.254.*">
-<class name="Shutdown" commands="DIE RESTART REHASH">
-<class name="ServerLink" commands="CONNECT SQUIT">
-<class name="BanControl" commands="KILL GLINE KLINE ZLINE QLINE SHUN">
-<class name="OperChat" commands="WALLOPS CHATOPS">
-<class name="HostCloak" commands="SETHOST SETIDENT SETNAME">
+<connect deny="3ffe::0/32">
+
+<connect
+ # name: Name to use for this connect block. Mainly used for
+ # connect class inheriting.
+ name="secret"
+ # parent: This setting is to specify if this connect class
+ # inherits settings from any other. Put the other class's name
+ # in here to use its settings as a template - for example, if
+ # you only want to adjust sendq and a password
+ parent="main"
-#-#-#-#-#-#-#-#-#-#-#-#- OPERATOR COMPOSITION -#-#-#-#-#-#-#-#-#-#-#
-# #
-# This is where you specify which types of operators you have on #
-# 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 #
-# classes - specified above, used for flexibility for the #
-# server admin to decide on which operators get #
-# what commands #
-# host - hostmask operators will recieve on oper-up. #
-#(optional) #
-# #
-# Syntax is as follows: #
-# <type name="name" classes="class name" host="oper hostmask"> #
-# #
+ # allow: What IP addresses/hosts to allow for this block.
+ allow="196.12.*"
-<type name="NetAdmin" classes="OperChat BanControl HostCloak Shutdown ServerLink" host="netadmin.omega.org.za">
-<type name="GlobalOp" classes="OperChat BanControl HostCloak ServerLink" host="ircop.omega.org.za">
-<type name="LocalOp" classes="OperChat BanControl HostCloak" host="local.omega.org.za">
-<type name="Helper" classes="HostCloak" host="helper.omega.org.za">
+ # hash: what hash this password is hashed with. requires the module
+ # for selected hash (m_md5.so, m_sha256.so or m_ripemd160.so) be
+ # loaded and the password hashing module (m_password_hash.so)
+ # loaded. Options here are: "md5", "sha256" and "ripemd160".
+ # Optional, but recommended. Create hashed password with:
+ # /mkpasswd <hash> <password>
+ #hash="sha256"
+ # password: Password to use for this block/user(s)
+ password="secret"
-#-#-#-#-#-#-#-#-#-#-#- OPERATOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
-# #
-# Opers are defined here. This is a very important section. #
-# Remember to only make operators out of truthworthy people. #
-# #
-# name - oper name, best to use lower-case #
-# password - password to oper-up, #
-# encryption not supported by inspircd. However, there #
-# are modules that allow for oper password encryption. #
-# #
-# host - host of client allowed to oper-up, more hostmasks #
-# seperated by spaces, wildcards accepted #
-# type - specified above, defines the kind of operator #
-# #
-# Syntax is as follows: #
-# <oper name="login" #
-# password="pass" #
-# host="hostmask@of.oper" #
-# type="oper type"> #
-# #
+ # maxchans: Maximum number of channels a user in this class
+ # be in at one time. This overrides every other maxchans setting.
+ #maxchans="30"
+
+ # timeout: How long (in seconds) the server will wait before
+ # disconnecting a user if they do not do anything on connect.
+ # (Note, this is a client-side thing, if the client does not
+ # send /nick, /user or /pass)
+ timeout="10"
+
+ # localmax: Maximum local connections per IP (or CIDR mask, see below).
+ localmax="3"
+
+ # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
+ globalmax="3"
+
+ # useident: Defines if users in this class MUST respond to a ident query or not.
+ useident="no"
+
+ # limit: How many users are allowed in this class
+ limit="5000"
+
+ # modes: Usermodes that are set on users in this block on connect.
+ # Enabling this option requires that the m_conn_umodes module be loaded.
+ # This entry is highly recommended to use for/with IP Cloaking/masking.
+ # For the example to work, this also requires that the m_cloaking
+ # module be loaded as well.
+ modes="+x"
+
+ # port: What port this user is allowed to connect on. (optional)
+ # The port MUST be set to listen in the bind blocks above.
+ port="6667">
+
+<connect
+ # name: Name to use for this connect block. Mainly used for
+ # connect class inheriting.
+ name="main"
+
+ # allow: What IP addresses/hosts to allow for this block.
+ allow="*"
+
+ # maxchans: Maximum number of channels a user in this class
+ # be in at one time. This overrides every other maxchans setting.
+ #maxchans="30"
+
+ # timeout: How long (in seconds) the server will wait before
+ # disconnecting a user if they do not do anything on connect.
+ # (Note, this is a client-side thing, if the client does not
+ # send /nick, /user or /pass)
+ timeout="10"
+
+ # pingfreq: How often (in seconds) the server tries to ping connecting clients.
+ pingfreq="120"
+
+ # hardsendq: maximum amount of data allowed in a client's send queue
+ # before they are dropped. Keep this value higher than the length of
+ # your network's /LIST or /WHO output, or you will have lots of
+ # disconnects from sendq overruns!
+ hardsendq="1048576"
+
+ # softsendq: amount of data in a client's send queue before the server
+ # begins delaying their commands
+ softsendq="8192"
+
+ # recvq: amount of data allowed in a client's queue before they are dropped.
+ recvq="8192"
-<oper name="katsklaw"
- password="s3cret"
- host="*@*"
- type="NetAdmin">
+ # localmax: Maximum local connections per IP.
+ localmax="3"
+
+ # globalmax: Maximum global (network-wide) connections per IP.
+ globalmax="3"
+ # useident: Defines if users in this class must respond to a ident query or not.
+ useident="no"
+
+ # limit: How many users are allowed in this class
+ limit="5000"
+
+ # modes: Usermodes that are set on users in this block on connect.
+ # Enabling this option requires that the m_conn_umodes module be loaded.
+ # This entry is highly recommended to use for/with IP Cloaking/masking.
+ # For the example to work, this also requires that the m_cloaking
+ # module be loaded as well.
+ modes="+x">
-#-#-#-#-#-#-#-#-#-#-#- SERVER LINK CONFIGURATION -#-#-#-#-#-#-#-#-#-#
-# #
-# 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, it does#
-# not have to resolve - but it is expected to be sent #
-# in the remote servers connection info. #
-# #
-# ipaddr - Valid host or ip address for remote server. * #
+
+#-#-#-#-#-#-#-#-#-#-#-#- CIDR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
# #
-# port - Valid listening UDP port for remote server. #
-# #
-# sendpass - Password to send to create an outbound connection #
-# to this server. #
-# #
-# recvpass - Password to receive to accept an inbound connection #
-# from this server. #
-# #
-# autoconnect - Sets the server to autoconnect. x is the number #
-# (optional) of seconds between attempts. 300 = 5 minutes #
-# #
-# encryptionkey - The encryption key to use to encrypt this link. #
-# (optional) Applicable when using m_spanningtree.so, the key #
-# must be EXACTLY 16, 24 or 32 characters long and #
-# must match on both ends of the link. Each link may #
-# have its own key so long as both ends of the link #
-# use the same key string. #
-# #
-# to u:line a server (give it extra privilages 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. #
-# #
-# WARNING: Unlike other ircds, u:lining a server allows ALL users on #
-# that server to operoverride modes. This should only be used for #
-# services and protected oper servers! #
-# #
-# IMPORTANT NOTE: When specifying the ip address and/or host, the #
-# server software will prioritize RESOLVED hostnames above ip #
-# addresses, so for example if your target server resolves to a.b.com #
-# you MUST put a.b.com into your link block, and NOT the IP address #
-# of a.b.com. The system uses reverse resolution. #
+# CIDR configuration allows detection of clones and applying of #
+# throttle limits across a CIDR range. (A CIDR range is a group of #
+# IPs, for example, the CIDR range 192.168.1.0-192.168.1.255 may be #
+# represented as 192.168.1.0/24). This means that abuse across an ISP #
+# is detected and curtailed much easier. Here is a good chart that #
+# shows how many IPs the different CIDRs correspond to: #
+# http://en.wikipedia.org/wiki/CIDR#Prefix_aggregation #
# #
-<link name="hub.penguin.org"
- ipaddr="penguin.box.com"
- port="7000"
- autoconnect="300"
- sendpass="outgoing!password"
- recvpass="incoming!password"
- encryptionkey="0123456789123456">
+<cidr
+ # ipv4clone: specifies how many bits of an IP address should be
+ # looked at for clones. The default only looks for clones on a
+ # single IP address of a user. You do not want to set this
+ # extremely low. (Values are 0-32).
+ ipv4clone="32"
-<link name="services.antarctic.com"
- ipaddr="localhost"
- port="7000"
- sendpass="penguins"
- recvpass="polarbears">
+ # ipv6clone: specifies how many bits of an IP address should be
+ # looked at for clones. The default only looks for clones on a
+ # single IP address of a user. You do not want to set this
+ # extremely low. (Values are 0-128).
+ ipv6clone="128">
-<uline server="services.antarctic.com">
+# This file has all the information about oper classes, types and o:lines.
+# You *MUST* edit it.
+<include file="opers.conf.example">
+# This file has all the information about server links and ulined servers.
+# You *MUST* edit it if you intend to link servers.
+<include file="links.conf.example">
#-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
-# #
-# These options let you define the path to your motd and rules #
-# files. #
-# #
+# #
-<files motd="/home/cc/inspircd/conf/inspire.motd"
- rules="/home/cc/inspircd/conf/inspire.rules">
+<files
+ # motd: Path to your motd file. Path is relative to the conf directory.
+ motd="inspircd.motd.example"
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# #
-# Define your DNS server address here. InspIRCd has its own resolver #
-# and you must define this otherwise nobody's host will resolve. The #
-# timeout value is in seconds. #
+ # rules: Path to your rules file. Path is relative to the conf directory.
+ # This is optional and is displayed when a user does /rules on the network.
+ rules="inspircd.rules.example">
+
+#-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# #
-<dns server="127.0.0.1" timeout="5">
+<channels
+ # users: Maximum number of channels a user can be in at once.
+ users="20"
+
+ # opers: Maximum number of channels a oper can be in at once.
+ opers="60">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# If these values are not defined, InspIRCd uses the default DNS resolver
+# of your system.
+
+<dns
+ # server: DNS server to use to attempt to resolve IP's to hostnames.
+ # in most cases, you won't need to change this, as inspircd will
+ # automatically detect the nameserver depending on /etc/resolv.conf
+ # (or, on windows, your set nameservers in the registry.)
+ # Note that this must be an IP address and not a hostname, because
+ # there is no resolver to resolve the name until this is defined!
+ #
+ # server="127.0.0.1"
+
+ # timeout: seconds to wait to try to resolve DNS/hostname.
+ timeout="5">
+
+# 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 #
-# ircd's state via cron jobs. #
+# 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. #
# #
-<pid file="/path/to/inspircd.pid">
+
#<pid file="/path/to/inspircd.pid">
#-#-#-#-#-#-#-#-#-#-#-#-#- 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 #
<banlist chan="#morons" limit="128">
<banlist chan="*" limit="69">
-#-#-#-#-#-#-#-#-#-#-#- DISABLED COMMANDS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
+#-#-#-#-#-#-#-#-#-#-#- DISABLED FEATURES -#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# #
+# This tag is optional, and specifies one or more features which are #
+# not available to non-operators. #
# #
-# This tag is optional, and specifies one or more commands which are #
-# not available to non-operators. For example you may wish to disable #
-# NICK and prevent non-opers from changing their nicknames. #
+# For example you may wish to disable NICK and prevent non-opers from #
+# changing their nicknames. #
# Note that any disabled commands take effect only after the user has #
# 'registered' (e.g. after the initial USER/NICK/PASS on connection) #
# so for example disabling NICK will not cripple your network. #
+# #
+# You can also define if you want to disable any channelmodes #
+# or usermodes from your users. #
# #
-# <disabled commands="TOPIC MODE"> #
+# `fakenonexistant' will make the ircd pretend that nonexistant #
+# commands simply don't exist to non-opers ("no such command"). #
# #
+#<disabled commands="TOPIC MODE" usermodes="" chanmodes="" fakenonexistant="yes">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-#
#-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
-# #
-# Settings to define which features are useable on your server. #
-# #
-# prefixquit - a prefix for a client's quit message #
-# loglevel - specifies what detail of messages to log in the #
-# log file. You may select from debug, verbose, #
-# default, sparse and none. #
-# allowhalfop - allows the +h channel mode #
-# noservices - If noservices is true, yes, or 1, then the first #
-# user into a channel gets founder status. This is #
-# only useful on networks running the m_chanprotect #
-# module without services. #
-# netbuffersize - size of the buffer used to receive data from #
-# clients. The ircd may only read() this amount #
-# of text in one go at any time. (OPTIONAL) #
-# maxwho - The maximum number of results returned by a /WHO #
-# 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. #
-# somaxconn - The maximum number of sockets that may be waiting #
-# in the accept queue. This usually allows the ircd #
-# to soak up more connections in a shorter space of #
-# time when increased but please be aware there is a #
-# system defined maximum value to this, the same way #
-# there is a system defined maximum number of file #
-# descriptors. Some systems may only allow this to #
-# be up to 5 (ugh) while others such as FreeBSD will #
-# default to a much nicer 128. #
-# moduledir - This optional value indicates a runtime change of #
-# the location where modules are to be found. This #
-# does not add a supplementary directory. There can #
-# only be one module path. #
-# softlimit - This optional feature allows a defined softlimit. #
-# if defined sets a soft maxconnections value, has #
-# to be less than the ./configure maxclients #
-# #
-
-<options prefixquit="Quit: "
- loglevel="default"
- netbuffersize="10240"
- maxwho="128"
- noservices="0"
- somaxconn="128"
- softlimit="128"
- allowhalfop="yes">
-
-
-
-#-#-#-#-#-#-#-#-#-#-#-#-#- MODULE OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
-# #
-# These tags define which modules will be loaded on startup by your #
-# server. Add modules without any paths. When you make your ircd #
-# using the 'make' command, all compiled modules will be moved into #
-# the folder you specified when you ran ./configure. The module tag #
-# automatically looks for modules in this location. #
-# If you attempt to load a module outside of this location, either #
-# in the config, or via /LOADMODULE, you will receive an error. #
-# #
-# By default, ALL modules are commented out. You must uncomment them #
-# or add lines to your config to load modules. Please refer to #
-# http://www.inspircd.org/wiki/Modules_List for a list of modules and#
-# each modules link for any additional conf tags they require. #
-# #
-# WINDOWS USERS PLEASE NOTE: You can still load these modules! They #
-# are incorporated into the executable and can be loaded and removed #
-# similarly to if they were in a ramdisk. #
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Foobar module - does nothing
-#<module name="m_foobar.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Chanprotect module: gives +q and +a channel modes
-#<module name="m_chanprotect.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Globops module: gives /GLOBOPS and usermode +g
-#<module name="m_globops.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Noinvite module: Gives channel mode +V
-#<module name="m_noinvite.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Oper MD5 module: Allows MD5 hashed oper passwords
-#<module name="m_opermd5.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Restricted channels module: Allows only opers to create channels
-#<module name="m_restrictchans.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Deny Channels: Deny Channels from being used by users
-#<module name="m_denychans.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Services support module: Adds several usermodes such as +R and +M
-#<module name="m_services.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Userip module: Adds the /USERIP command
-#<module name="m_userip.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Alias module: Allows you to define server-side command aliases
-#<module name="m_alias.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# CHGHOST module: Adds the /CHGHOST command
-#<module name="m_chghost.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# HELPOP module: Provides the /HELPOP command
-#<module name="m_helpop.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# No kicks module: Adds the +Q channel mode
-#<module name="m_nokicks.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Oper MOTD module: Provides support for seperate message of the day
-# on oper-up
-#<module name="m_opermotd.so">
+# #
+# Settings to define which features are usable on your server. #
+# #
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Restrict message module: Allows users to only message opers
-#<module name="m_restrictmsg.so">
+<options
+ # prefixquit: What (if anything) a users' quit message
+ # should be prefixed with.
+ prefixquit="Quit: "
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Sethost module: Adds the /SETHOST command
-#<module name="m_sethost.so">
+ # suffixquit: What (if anything) a users' quit message
+ # should be suffixed with.
+ suffixquit=""
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Antibottler module: Labels bottler leech bots
-#<module name="m_antibottler.so">
+ # prefixpart: What (if anything) a users' part message
+ # should be prefixed with.
+ prefixpart="\""
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Watch module: Adds the WATCH command, which is used by clients to
-# maintain notify lists.
-#<module name="m_watch.so">
+ # suffixpart: What (if anything) a users' part message
+ # should be suffixed with.
+ suffixpart="\""
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Cloaking module: Adds usermode +x and cloaking support
-#<module name="m_cloaking.so">
+ # fixedquit: Set all users' quit messages to this value.
+ #fixedquit=""
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Hostchange module: Allows a different style of cloaking
-#<module name="m_hostchange.so">
+ # fixedpart: Set all users' part messages in all channels
+ # to this value.
+ #fixedpart=""
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# No nicks module: Adds the +N channel mode
-#<module name="m_nonicks.so">
+ # syntaxhints: If enabled, if a user fails to send the correct parameters
+ # for a command, the ircd will give back some help text of what
+ # the correct parameters are.
+ syntaxhints="no"
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Override module: Adds support for oper override
-#<module name="m_override.so">
+ # cyclehosts: If enabled, when a user gets a host set, it will cycle
+ # them in all their channels. If not, it will simply change their host
+ # without cycling them.
+ cyclehosts="yes"
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# SAJOIN module: Adds the /SAJOIN command
-#<module name="m_sajoin.so">
+ # ircumsgprefix: Use undernet-style message prefixing for NOTICE and
+ # PRIVMSG. If enabled, it will add users' prefix to the line, if not,
+ # it will just message the user normally.
+ ircumsgprefix="no"
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Set Idle module: Adds a command for opers to change their
-# idle time (mainly a toy)
-#<module name="m_setidle.so">
+ # announcets: If set to yes, when the TimeStamp on a channel changes, all users
+ # in channel will be sent a NOTICE about it.
+ announcets="yes"
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Block colour module: Adds the +c channel mode
-#<module name="m_blockcolor.so">
+ # allowmismatched: Setting this option to yes will allow servers to link even
+ # if they don't have the same VF_OPTCOMMON modules loaded. Setting this to
+ # yes may introduce some desyncs and weirdness.
+ allowmismatched="no"
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Conn-Lusers: Shows the LUSERS output on connect
-#<module name="m_conn_lusers.so">
+ # hostintopic: If enabled, channels will show the host of the topicsetter
+ # in the topic. If set to no, it will only show the nick of the topicsetter.
+ hostintopic="yes"
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Ident: Provides RFC 1413 ident lookup support
-#<module name="m_ident.so">
+ # pingwarning: If a server does not respond to a ping within x seconds,
+ # it will send a notice to opers with snomask +l informing that the server
+ # is about to ping timeout.
+ pingwarning="15"
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# No Notice module: adds the channel mode +T
-#<module name="m_nonotice.so">
+ # serverpingfreq: How often pings are sent between servers (in seconds).
+ serverpingfreq="60"
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Parking module: Adds parking support and /PARK and /UNPARK
-#<module name="m_park.so">
+ # allowhalfop: Allows the use of +h channelmode (halfops).
+ allowhalfop="yes"
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# SAMODE module: Adds the oper /SAMODE command
-#<module name="m_samode.so">
+ # defaultmodes: What modes are set on a empty channel when a user
+ # joins it and it is unregistered. This is similar to Asuka's
+ # autochanmodes.
+ defaultmodes="nt"
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# SETNAME module: Adds the /SETNAME command
-#<module name="m_setname.so">
+ # moronbanner: This is the text that is sent to a user when they are
+ # banned from the server.
+ moronbanner="You're banned! Email haha@abuse.com with the ERROR line below for help."
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Botmode module: Adds the user mode +B
-#<module name="m_botmode.so">
+ # exemptchanops: Defines what channel modes channel operators are
+ # exempt from. Supported modes are +TCGfcSFBgN. Defaults to off.
+ exemptchanops=""
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Filter module: Provides glob-based message filtering
-#<module name="m_filter.so">
+ # invitebypassmodes: This allows /invite to bypass other channel modes.
+ # (Such as +k, +j, +l, etc)
+ invitebypassmodes="yes">
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Knock module: adds the /KNOCK command and +K channel mode
-#<module name="m_knock.so">
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Oper channels mode: Adds the +O channel mode
-#<module name="m_operchans.so">
+#-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
+# #
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Random Quote module: provides a random quote on connect
-#<module name="m_randquote.so">
+<performance
+ # netbuffersize: Size of the buffer used to recieve data from clients.
+ # The ircd may only read this amount of text in 1 go at any time.
+ netbuffersize="10240"
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# SANICK module: Allows opers to change user's nicks
-#<module name="m_sanick.so">
+ # maxwho: Maximum number of results to show in a /who query.
+ maxwho="4096"
+
+ # somaxconn: The maximum number of connections that may be waiting
+ # in the accept queue. This is *NOT* the total maximum number of
+ # connections per server. Some systems may only allow this to be up
+ # to 5, while others (such as linux and *BSD) default to 128.
+ somaxconn="128"
+
+ # softlimit: This optional feature allows a defined softlimit for
+ # connections. If defined, it sets a soft max connections value.
+ # must be lower than ./configure maxclients.
+ softlimit="12800"
+
+ # quietbursts: When syncing or splitting from a network, a server
+ # can generate a lot of connect and quit messages to opers with
+ # +C and +Q snomasks. Setting this to yes squelches those messages,
+ # which makes it easier for opers, but degrades the functionality of
+ # bots like BOPM during netsplits.
+ quietbursts="yes"
+
+ # nouserdns: If enabled, no DNS lookups will be performed on
+ # connecting users. This can save a lot of resources on very busy servers.
+ nouserdns="no">
+
+#-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
+# #
+
+<security
+
+ # announceinvites: 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' will make the messages
+ # go to every user who has power of INVITE on the channel. This
+ # is the recommended setting.
+ announceinvites="dynamic"
+
+ # hidemodes: If enabled, then the listmodes given will be hidden
+ # from users below halfop. This is not recommended to be set on +b
+ # as it may break some functionality in popular clients such as mIRC.
+ hidemodes="eI"
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Show Whois module: Adds the +W usermode which allows opers
-# to see when they are whois'ed
-#<module name="m_showwhois.so">
+ # hideulines: If this value is set to yes, U-lined servers will
+ # be hidden from non-opers in /links and /map.
+ hideulines="no"
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Strip colour module: Adds the channel mode +S
-#<module name="m_stripcolor.so">
+ # flatlinks: If this value is set to yes, /map and /links will
+ # be flattened when shown to non-opers.
+ flatlinks="no"
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Censor module: Adds the channel mode +G
-#<module name="m_censor.so">
+ # hidewhois: When defined, the given text will be used in place
+ # of the server a user is on when whoised by a non-oper. Most
+ # networks will want to set this to something like "*.netname.net"
+ # to conceal the actual server a user is on.
+ hidewhois=""
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Nick locking module: Adds the oper-only /NICKLOCK command
-#<module name="m_nicklock.so">
+ # hidebans: If this value is set to yes, when a user is banned ([gkz]lined)
+ # only opers will see the ban message when the user is removed
+ # from the server.
+ hidebans="no"
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Oper Join module: Forces opers to join a channel on oper-up
-#<module name="m_operjoin.so">
+ # hidekills: If defined, replaces who set a /kill with a custom string.
+ hidekills=""
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Redirect module: Adds channel redirection (mode +L)
-#<module name="m_redirect.so">
+ # hidesplits: If enabled, non-opers will not be able to see which
+ # servers split in a netsplit, they will only be able to see that one
+ # occurred (If their client has netsplit detection).
+ hidesplits="no"
+
+ # maxtargets: Maximum number of targets per command.
+ # (Commands like /notice, /privmsg, /kick, etc)
+ maxtargets="20"
+
+ # customversion: Displays a custom string when a user /version's
+ # the ircd. This may be set for security reasons or vanity reasons.
+ customversion=""
+
+ # operspywhois: If this is set to yes, when a oper /whois 's a user,
+ # it will show all channels the user is in including +s and +p
+ # channels.
+ operspywhois="no"
+
+ # runasuser: If this is set, InspIRCd will attempt to setuid
+ # to run as this user- allows binding of ports under 1024.
+ # NOT SUPPORTED/NEEDED UNDER WINDOWS.
+ #runasuser=""
+
+ # runasgroup: If this is set, InspIRCd will attempt to set group
+ # to run under this group, which allows binding of ports under 1024
+ # NOT SUPPORTED/NEEDED UNDER WINDOWS.
+ #runasgroup=""
+
+ # restrictbannedusers: If this is set to yes, InspIRCd will not allow users
+ # banned on a channel to change nickname or message channels they are
+ # banned on.
+ restrictbannedusers="yes"
+
+ # genericoper: Setting this value to yes makes all opers on this server
+ # appear as 'is an IRC operator' in their WHOIS, regardless of their
+ # oper type, however oper types are still used internally. This only
+ # affects the display in WHOIS.
+ genericoper="no"
+
+ # userstats: /stats commands that users can run (opers can run all).
+ userstats="Pu">
+
+#-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
+# #
+# This configuration tag defines the maximum sizes of various types #
+# on IRC, such as the maximum length of a channel name, and the #
+# maximum length of a channel. Note that with the exception of the #
+# identmax value all values given here are the exact values you would #
+# expect to see on IRC. This contrasts with the older InspIRCd #
+# releases where these values would be one character shorter than #
+# defined to account for a null terminator on the end of the text. #
+# #
+# These values should match network-wide otherwise issues will occur. #
+# #
+# The highest safe value you can set any of these options to is 500, #
+# but it is recommended that you keep them somewhat #
+# near their defaults (or lower). #
+
+<limits
+ # maxnick: Maximum length of a nickname.
+ maxnick="31"
+
+ # maxchan: Maximum length of a channel name.
+ maxchan="64"
+
+ # maxmodes: Maximum number of mode changes per line.
+ maxmodes="20"
+
+ # maxident: Maximum length of a ident/username.
+ maxident="11"
+
+ # maxquit: Maximum length of a quit message.
+ maxquit="255"
+
+ # maxtopic: Maximum length of a channel topic.
+ maxtopic="307"
+
+ # maxkick: Maximum length of a kick message.
+ maxkick="255"
+
+ # maxgecos: Maximum length of a GECOS (realname).
+ maxgecos="128"
+
+ # maxaway: Maximum length of an away message.
+ maxaway="200">
+
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Logging
+# -------
+#
+# Logging is covered with the <log> tag, which you may use to change
+# the behaviour of the logging of the IRCd.
+#
+# In InspIRCd as of 1.2, logging is pluggable and very extensible.
+# Different files can log the same thing, different 'types' of log can
+# go to different places, and modules can even extend the log tag
+# to do what they want.
+#
+# An example log tag would be:
+# <log method="file" type="OPER" level="default" target="opers.log">
+# which would log all information on /oper (failed and successful) to
+# a file called opers.log.
+#
+# There are many different types which may be used, and modules may
+# generate their own. A list of useful types:
+# - USERS - information relating to user connection and disconnection
+# - CHANNELS - information relating to joining and parting of channels.
+# XXX someone doc more on this
+#
+# You may also log *everything* by using a type of *, and subtract things out
+# of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
+#
+# The following log tag is highly default and uncustomised. It is recommended you
+# sort out your own log tags. This is just here so you get some output.
+
+<log method="file" type="* -USERINPUT -USEROUTPUT -m_spanningtree" level="default" target="ircd.log">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#- WHOWAS OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
+# #
+# This tag lets you define the behaviour of the /whowas command of #
+# your server. #
+# #
+
+<whowas
+ # groupsize: Maximum entries per nick shown when performing
+ # a /whowas nick.
+ groupsize="10"
+
+ # maxgroups: Maximum number of nickgroups that can be added to
+ # the list so that /whowas does not use a lot of resources on
+ # large networks.
+ maxgroups="100000"
+
+ # maxkeep: Maximum time a nick is kept in the whowas list
+ # before being pruned. Time may be specified in seconds,
+ # or in the following format: 1y2w3d4h5m6s. Minimum is
+ # 1 hour.
+ maxkeep="3d">
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# SAPART module: Adds the oper /SAPART command
-#<module name="m_sapart.so">
+#-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# #
+# The ban tags define nick masks, host masks and ip ranges which are #
+# banned from your server. All details in these tags are local to #
+# Your server. #
+# #
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# SILENCE module: Adds support for /SILENCE
-#<module name="m_silence.so">
+<badip
+ # ipmask: IP range to ban. Wildcards and CIDR can be used.
+ ipmask="69.69.69.69"
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Test command module: Does nothing significant
-#<module name="m_testcommand.so">
+ # reason: Reason to display when user is disconnected.
+ reason="No porn here thanks.">
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Channel filter module: Allows channel-op defined message
-# filtering using simple string matches (channel mode +g)
-#<module name="m_chanfilter.so">
+<badnick
+ # nick: Nick to disallow. Wildcards are supported.
+ nick="ChanServ"
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# No ctcp module: Adds the channel mode +C to block CTCPs
-#<module name="m_noctcp.so">
+ # reason: Reason to display on /nick.
+ reason="Reserved For Services">
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Oper levels module: Gives each oper a level and prevents
-# actions being taken against higher level opers
-#<module name="m_operlevels.so">
+<badnick nick="NickServ" reason="Reserved For Services">
+<badnick nick="OperServ" reason="Reserved For Services">
+<badnick nick="MemoServ" reason="Reserved For Services">
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Remove module: Adds the /REMOVE command which is a peaceful
-# alternative to /KICK
-#<module name="m_remove.so">
+<badhost
+ # host: ident@hostname to ban.
+ # Wildcards and CIDR (if you specify an IP) can be used.
+ host="*@hundredz.n.hundredz.o.1337.kiddies.com"
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
-#<module name="m_saquit.so">
+ # reason: Reason to display when user is disconnected
+ reason="Too many 1337 kiddiots">
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Timed bans module: Adds timed bans and the /TBAN command
-#<module name="m_timedbans.so">
+<badhost host="root@*" reason="Don't irc as root!">
+<badhost host="*@172.32.0.0/16" reason="This subnet is bad.">
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Oper modes module: Allows you to specify modes to add/remove on oper
-#<module name="m_opermodes.so">
+# exception: Hosts that are exempt from [kgz]lines.
+<exception
+ # host: ident@hostname to exempt.
+ # Wildcards and CIDR (if you specify an IP) can be used.
+ host="*@ircop.host.com"
+ # reason: Reason for exception. Only shown in /stats e
+ reason="Opers hostname">
-#-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
+#-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# #
+# This optional tag allows you to specify how wide a gline, eline, #
+# kline, zline or qline can be before it is forbidden from being #
+# set. By setting hostmasks="yes", you can allow all G, K, E lines, #
+# no matter how many users the ban would cover. This is not #
+# recommended! By setting ipmasks="yes", you can allow all Z lines, #
+# no matter how many users these cover too. Needless to say we #
+# don't recommend you do this, or, set nickmasks="yes", which will #
+# allow any qline. #
# #
-# Optional - If you specify to use the m_filter.so module, then #
-# specfiy below the path to the filter.conf file. #
-#<filter file="/path/to/inspircd/filter.conf">
+<insane
+ # hostmasks: Allow bans with insane hostmasks. (over-reaching bans)
+ hostmasks="no"
+ # ipmasks: Allow bans with insane ipmasks. (over-reaching bans)
+ ipmasks="no"
-#-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
-# #
-# Optional - If you specify to use the m_helpop.so module, then #
-# specify below the path to the helpop.conf file. #
+ # nickmasks: Allow bans with insane nickmasks. (over-reaching bans)
+ nickmasks="no"
-<die value="If you used the helpop include above then do *NOT* use this tag.">
-#<helpop file="/path/to/inspircd/helpop.conf">
+ # trigger: What percentage of users on the network to trigger
+ # specifying an insane ban as. The default is 95.5%, which means
+ # if you have a 1000 user network, a ban will not be allowed if it
+ # will be banning 955 or more users.
+ trigger="95.5">
-#-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# #
-# Optional - If you specify to use the m_randquotes.so module, then #
-# specify below the path to the randquotes.conf file. #
+# You should already know what to do here :) #
-#<randquote file="/path/to/inspircd/randquotes.conf">
+<die value="User error. Insert new user and press any key. (you didn't edit your config properly.)">
-#-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# #
-# The ban tags define nick masks, host masks and ip ranges which are #
-# banned from your server. All details in these tags are local to #
-# Your server. #
-# #
-# #
-# badip lines ban an ip range (same as a zline) #
-# #
-# ipmask - The ip range to ban (wildcards possible) #
-# reason - Reason to display when disconnected #
-# #
-# badnick lines ban a nick mask (same as a qline) #
-# #
-# nick - Nick mask to ban (wildcards possible) #
-# reason - Reason to display on /NICK #
-# #
-# badhost lines ban a user@host mask (same as a kline) #
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# ____ _ _____ _ _ ____ _ _ _ #
+# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
+# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
+# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
+# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
# #
-# host - ident@hostname (wildcards possible) #
-# reason - Reason to display on disconnection #
+# Well done, you've reached the end of the basic configuration, your #
+# ircd should now start if you want to try it out! (./inspircd start) #
# #
-# exception lines define a hostmask that is excempt from [kzg]lines #
+# We now suggest you read and edit modules.conf, as modules are what #
+# provide almost all the features of InspIRCd. :) #
# #
-# host - ident@hostname (wildcards possible) #
-# reason - Reason, shown only in /stats e #
-# #
-
-<badip ipmask="69.69.69.69" reason="No porn here thanks.">
-
-<badnick nick="ChanServ" reason="Reserved For Services">
-<badnick nick="NickServ" reason="Reserved For Services">
-<badnick nick="OperServ" reason="Reserved For Services">
-<badnick nick="MemoServ" reason="Reserved For Services">
-
-<badhost host="*@hundredz.n.hundredz.o.1337.kiddies.com" reason="Too many 1337 kiddiots">
-<badhost host="*@localhost" reason="No irc from localhost!">
-
-<exception host="*@ircop.host.com" reason="Opers hostname">
-
-#-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# #
-# If you have the m_alias.so module loaded, you may also define #
-# aliases as shown below. They are commonly used to provide shortcut #
-# commands to services, however they are not limited to jsut this use.#
-# An alias tag requires the following values to be defined in it: #
-# #
-# text - The text to detect at the start of the line, #
-# must be at the start of the line to trigger the #
-# alias. May contain spaces, but case insensitive. #
-# replace - The text to replace 'text' with. Usually this #
-# will be "PRIVMSG ServiceName :" or similar. #
-# requires - If you provide a value for 'requires' this means #
-# the given nickname MUST be online for the alias #
-# to successfully trigger. If they are not, then #
-# the user receives a 'no such nick' 401 numeric. #
-# uline - Defining this value with 'yes', 'true' or '1' #
-# will ensure that the user given in 'requires' #
-# must also be on a u-lined server, as well as #
-# actually being on the network. If the user is #
-# online, but not on a u-lined server, then an #
-# oper-alert is sent out as this is possibly signs #
-# of a user trying to impersonate a service. #
-# #
-
-<alias text="NICKSERV" replace="PRIVMSG NickServ :" requires="NickServ" uline="yes">
-<alias text="CHANSERV" replace="PRIVMSG ChanServ :" requires="ChanServ" uline="yes">
-<alias text="NS" replace="PRIVMSG NickServ :" requires="NickServ" uline="yes">
-<alias text="CS" replace="PRIVMSG ChanServ :" requires="ChanServ" uline="yes">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# #
-# You should already know what to do here :) #
-
-<die value="You should probably edit your config *PROPERLY* and try again.">
+# The default does nothing -- we include it for simplicity for you. #
+<include file="modules.conf.example">
#########################################################################
-# #
-# -InspIRCd Development and Coding Team- #
-# www.inspircd.org #
-# #
+# #
+# - InspIRCd Development Team - #
+# http://www.inspircd.org #
+# #
#########################################################################
projects / user / henk / code / inspircd.git / blobdiff