inspircd/docs/inspircd.conf.example
2004-05-01 13:45:45 +00:00

373 lines
18 KiB
Plaintext

########################################################################
# #
# --------------------------- #
# InspIRCd Configuration File #
# --------------------------- #
# #
##################################||####################################
#||#
##################################||####################################
# #
# This is an example of the config file for InspIRCd. #
# Change the options to suit your network #
# #
# Last updated on : 24/04/2004 #
# Written by : CC (cc@backchat.co.za) #
# Updated by : Brain (brain@inspircd.org) #
# #
########################################################################
#-#-#-#-#-#-#-#-#-#-#-#- 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="penguin.omega.org.za"
description="Waddle World"
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"> #
# #
<admin name="Johnny Casino"
nick="CC"
email="cc@monkeynut.co.za">
#-#-#-#-#-#-#-#-#-#-#-#- 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"> #
# #
<bind address="" port="6660" type="clients">
<bind address="" port="7000" type="servers" default="yes">
<bind address="" port="7001" type="servers">
#-#-#-#-#-#-#-#-#-#- 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 #
# 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">
#-#-#-#-#-#-#-#-#-#- 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 number"> #
# <connect allow="ip number" password="blahblah"> #
# <connect allow="ip number" password="blah" timeout="10"> #
# <connect allow="ip number" timeout="blah" flood="5"> #
# <connect deny="ip number"> #
# #
# 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. #
<connect allow="196.12.*" password="secret">
<connect allow="*" timeout="60" flood="10">
<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"> #
# #
<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">
#-#-#-#-#-#-#-#-#-#-#-#- 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 #
# #
# Syntax is as follows: #
# <type name="name" classes="class name" host="oper hostmask"> #
# #
<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">
#-#-#-#-#-#-#-#-#-#-#- 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 yet available #
# 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"> #
# #
<oper name="cc"
password="s3cret"
host="*@*"
type="NetAdmin">
#-#-#-#-#-#-#-#-#-#-#- 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 ip address for remote server. #
# 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. #
# #
# 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! #
# #
<link name="hub.penguin.org"
ipaddr="12.34.56.78"
port="7000"
sendpass="outgoing!password"
recvpass="incoming!password">
<link name="services.antarctic.com"
ipaddr="98.76.54.32"
port="7000"
sendpass="penguins"
recvpass="polarbears">
<uline server="services.antarctic.com">
#-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
# #
# These options let you define the path to your motd and rules #
# files. #
# #
<files motd="/home/cc/inspircd-1.0/conf/inspire.motd"
rules="/home/cc/inspircd-1.0/conf/inspire.rules">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-#
# #
# Just remove this... Its here to make you read ALL of the config #
# file options ;) #
<die value="And god came down from the heavens and smote down the noob.">
#-#-#-#-#-#-#-#-#-#-#-#-#- 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. #
<options prefixquit="Quit: "
loglevel="default"
netbuffersize="10240"
maxwho="128"
noservices="0">
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. #
<module name="m_foobar.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. #
# #
# #
# 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) #
# #
# host - ident@hostname (wildcards possible) #
# reason - Reason to display on disconnection #
# #
<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!">
#-#-#-#-#-#-#-#-#-#-#- 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 ID" replace="PRIVMSG NickServ :identify" requires="NickServ" 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="All l33t noobs must edit their configs.">
#########################################################################
# #
# -InspIRCd Development and Coding Team- #
# www.inspircd.org #
# #
#########################################################################