X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Finspircd.conf.example;h=2259858b0742499e4efe4608c96be2ff6dc81ec0;hb=6c6d83a21718b342c4f615dcca4093d06638f9fb;hp=4f69d46b0515da8a7b88a8e6efb7fdfe1cde78f0;hpb=484229f5c65cfe3c88ed99af02502c62894f0494;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/inspircd.conf.example b/docs/inspircd.conf.example index 4f69d46b0..2259858b0 100644 --- a/docs/inspircd.conf.example +++ b/docs/inspircd.conf.example @@ -20,10 +20,7 @@ # This is an example of the config file for InspIRCd. # # Change the options to suit your network # # # -# Last updated on : 04/09/2006 # -# Written by : CC (cc@backchat.co.za) # -# Updated by : katsklaw (katsklaw@gmail.com) # -# Updated by : brain (brain@inspircd.org) # +# Last updated on : 03 Feb 2007 # # # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # @@ -61,8 +58,8 @@ #-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# Describes the Server Administrator's real name, nick # -# and email address. # +# Describes the Server Administrator's real name (optionally), # +# nick, and email address. # # # # Syntax is as follows: # # # # # - + #-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#- @@ -136,10 +133,20 @@ # # # # # If InspIRCd is built for IPV6, and you wish to accept IPV4 clients, # -# then you must specify your IPV6 clients in the following form: # -# ::ffff:1.2.3.4, where 1.2.3.4 is the IPV4 address to bind the # -# port on. If InspIRCd is built for IPV4 connections (this is the # -# default) then you do not need to prefix your addresses like this. # +# 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 # +# 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 # +# 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. # # # @@ -374,11 +381,10 @@ # type="oper type"> # # # - + #-#-#-#-#-#-#-#-#-#-#- SERVER LINK CONFIGURATION -#-#-#-#-#-#-#-#-#-# @@ -459,6 +465,20 @@ # seconds. If this is not defined, the default of ten # # seconds is used. # # # +# 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 # +# is not empty or localhost from your 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 # +# looking for the error 'Could not assign requested # +# address' in your log when connecting to servers. # +# # # to u:line a server (give it extra privilages required for running # # services, Q, etc) you must include the tag as shown # # in the example below. You can have as many of these as you like. # @@ -467,11 +487,17 @@ # that server to operoverride modes. This should only be used for # # services and protected oper servers! # # # -# NOTE: If you have built InspIRCd with IPV6 support, and you want # -# to link to an IPV4 server, you must specify the IP address in the # -# form '::ffff:1.2.3.4' where 1.2.3.4 is the IP address of the target # -# server. If you have built InspIRCd for IPV4 (this is the default) # -# you should not prefix your IP addresses in this fashion. # +# ------------------------------------------------------------------- # +# # +# 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 # +# than the hostname of the server. # +# # +# ------------------------------------------------------------------- # # # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # @@ -492,22 +518,23 @@ # # + ipaddr="penguin.box.com" + port="7000" + allowmask="69.58.44.0/24" + autoconnect="300" + failover="hub.other.net" + timeout="15" + transport="gnutls" + bind="1.2.3.4" + sendpass="outgoing!password" + recvpass="incoming!password"> + ipaddr="localhost" + port="7000" + allowmask="127.0.0.0/8" + sendpass="penguins" + recvpass="polarbears"> @@ -519,8 +546,19 @@ # configurtion directory. # # # - + + +#-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# 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 # +# defined. Remote users are not restricted in any manner. # +# # + + #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # # @@ -545,21 +583,18 @@ # resolving even though the DNS server appears to be up! Most ISP and # # hosting provider DNS servers support recursive lookups. # # # -# NOTE: If you have built InspIRCd with IPV6 support, and you want # -# to use an IPV4 nameserver, you must specify the IP address in the # -# form '::ffff:1.2.3.4' where 1.2.3.4 is the IP address of the target # -# server. If you have built InspIRCd for IPV4 (this is the default) # -# you should not prefix your IP addresses in this fashion. # +# ------------------------------------------------------------------- # # # -# IF YOUR RESOLV.CONF CONTAINS ONLY IPV4 ADDRESSES, AND YOU ARE USING # -# IPV6, YOU MUST DEFINE THE TAG, AND USE THE ::FFFF # -# PREFIX NOTATION. IF YOU DO NOT, HOSTS WILL *NOT* RESOLVE. # +# 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. # # # -# An example of using IPV4 nameservers over IPV6 -# +# An example of using an IPV6 nameserver +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # # @@ -612,7 +647,15 @@ # # # Settings to define which features are useable on your server. # # # -# prefixquit - a prefix for a client's quit message # +# prefixquit - A prefix to be placed on the start of a client's # +# quit message # +# # +# suffixquit - A suffix to be placed on the end of a client's # +# quit message. # +# # +# fixedquit - A fixed quit message to display for all client # +# QUITS. If specified, overrides both prefixquit # +# and suffixquit options. # # # # loglevel - specifies what detail of messages to log in the # # log file. You may select from debug, verbose, # @@ -744,15 +787,17 @@ # ircumsgprefix - Use undernet style message prefix for channel # # NOTICE and PRIVMSG adding the prefix to the line # # of text sent out. Eg. NOTICE @#test :@ testing # -# vs off: NOTICE @#test :testing # -# -# notimesync - If this value is 'yes', 'true', or '1', time # -# synchronization is disabled on this server. This # -# means any servers you are linked to will not # -# automatically synchronize time with you, and in # -# most cases will just result in more bounced modes # -# on netsplits. This option should be the same on # -# all servers. # +# vs. the off setting: NOTICE @#test :testing # +# # +# hostintopic - If this is set to yes (the default) then the full # +# nick!user@host is shown for who set a TOPIC last. # +# 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. # # # +#-#-#-#-#-#-#-#-#-#-#-#-#-#- TIME SYNC OPTIONS -#-#-#-#-#-#-#-#-#-#-#-# +# Time sychronization 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 # +# 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 # +# means any servers you are linked to will # +# automatically synchronize time, however you should # +# use ntpd instead where possible, NOT this option. # +# # +# master - If this value is set to yes, then this server will # +# act as the authoritative time source for the whole # +# network. All other servers will respect its time # +# without question, and match their times to it. # +# only one server should have the master value set # +# to 'yes'. # +# # + + #-#-#-#-#-#-#-#-#-#-#-#-#- WHOWAS OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-# # # # This tag lets you define the behaviour of the /whowas command of # @@ -947,6 +1014,13 @@ # # +# This alias fixes a glitch in xchat 2.6.x and above and the way it +# assumes IDENTIFY must be prefixed by a colon (:) character. It should +# be placed ABOVE the default NICKSERV alias (the first example) listed +# above. +# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Alltime module: Shows time on all connected servers at once @@ -965,6 +1039,11 @@ # Ban except module: Adds support for channel ban exceptions (+e) # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Ban redirection module: Allows bans which redirect to a specified +# channel. e.g. +b nick!ident@host#channelbanneduserissentto +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Block amsg module: Attempt to block all usage of /amsg and /ame # @@ -985,6 +1064,22 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Block CAPS module: Blocking all-CAPS messages with cmode +P # +# # +#-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# # +# percent - How many percent of text must be caps before text # +# will be blocked. # +# # +# minlen - The minimum length a line must be for the block # +# percent to have any effect. # +# # +# capsmap - A list of chars to be considered CAPS, this was # +# you can add CAPS for your language. Also you can # +# add things like ! and space to further lock down # +# on caps usage. # +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Block colour module: Blocking colour-coded messages with cmode +c @@ -1010,6 +1105,30 @@ # # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# CGI:IRC module: Adds support for automatic host changing in CGI:IRC +# (http://cgiirc.sourceforge.net). +# +# +#-#-#-#-#-#-#-#-#-#-#-# 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 +# will be connecting to your network, and an optional cgiirc tag. +# For more information see: http://www.inspircd.org/wiki/CGI-IRC_Module +# +# Set to yes if you want to notice opers when CGI clients connect +# +# +# The type field indicates where the module should get the real +# client's IP address from, for further information, please see the +# CGI:IRC documentation. +# +# # Get IP from PASS +# # Get IP from WEBIRC +# # Get IP from ident +# # See the docs + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Channel filter module: Allows channel-op defined message # filtering using simple string matches (channel mode +g) @@ -1041,15 +1160,29 @@ # be included. However, if prefix is not included, it will default # # to your networks name from the tag. # # # -# # # # # Please note that the key values will accept any number, and should # # be large numbers. Using small numbers such as "7" or "1924" will # -# seriously weaken the security of your cloak. # +# seriously weaken the security of your cloak. It is recommended you # +# use hexdecimal numbers prefixed by "0x", as shown in this example, # +# with each key eight hex digits long. # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Conn-Join: Allows you to force users to join one or more channels +# automatically upon connecting to the server. +# +# +#-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# +# If you have m_conn_join.so loaded, you can configure it using the +# follow values: +# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Conn-Lusers: Shows the LUSERS output on connect @@ -1146,6 +1279,14 @@ # Devoice Module: Let users devoice themselves. # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# DNS Blacklist Module: Provides support for looking up IPs on one or # +# more blacklists. # +# # +# # +# For configuration options please see the wiki page for m_dnsbl at # +# http://inspircd.org/wiki/DNS_Blacklist_Module # + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Filter module: Provides glob-based message filtering # @@ -1260,6 +1401,10 @@ # Join flood module: Adds support for join flood protection (+j) # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Jump Server module: Adds support for the RPL_REDIR numeric +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J) # @@ -1268,6 +1413,16 @@ # Knock module: adds the /KNOCK command and +K channel mode # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is # +# used to temporarily close/open for new connections to the server. # +# These commands require OPER status and that the LOCKSERV UNLOCKSERV # +# are specified in a tag that the oper is part of. This is so # +# you can control who has access to this possible dangerous command. # +# If your server is locked and you got disconnected, do a REHASH from # +# shell to open up again. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Msg flood module: Adds message/notice flood protection (+f) # @@ -1331,7 +1486,7 @@ # To use this module, you must define a hash type for each oper's # password you want to hash. For example: # -# +# +#-#-#-#-#-#-#-#-#-#-# SAFELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# +# When using Safelist, you may set the following values; +# +# The first value, 'throttle', sets the amount of time in seconds a user +# must wait between LIST commands. For example, if this is set to 60 +# (the default) then the user may not /LIST more than once a minute. +# If not defined, the default value is 60 seconds. +# +# The second value, 'maxlisters', indicates the maximum number of users +# which may be retrieving a LIST at once. It is not recommended you raise +# this value, as increasing it too high can make your network vulnerable +# to floodbots which waste your bandwidth and CPU time with LIST requests. +# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SAJOIN module: Adds the /SAJOIN command @@ -1457,10 +1628,28 @@ # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!) # -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Secure list module: Prevent /LIST in the first minute of connection, # crippling most spambots and trojan spreader bots. # +# +#-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# 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: # + + + +# # +# Define the following variable to change how long a user must wait # +# before issuing a LIST. If not defined, defaults to 60 seconds. # +# # +# # + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# See nicks module: Allow for SNOMASK +N which shows nick changes. +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Set Idle module: Adds a command for opers to change their @@ -1578,6 +1767,20 @@ # features to silence based on invites, channel messages, etc. # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SQLite3 module: Allows other SQL modules to access SQLite3 # +# databases through a unified API. You must link the source for this # +# module from the directory src/modules/extra to src/modules, plus # +# the file m_sqlv2.h # +# +# +#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_sqlite.so is more complex than described here, see the wiki for # +# more: http://www.inspircd.org/wiki/SQLite3_Service_Provider_Module # +# +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SQLutils module: Provides some utilities to SQL client modules, such # as mapping queries to users and channels. You must copy the source @@ -1626,6 +1829,12 @@ # # # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be # +# added/removed by Services. # +# + + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SWHOIS module: Allows you to add arbitary lines to user WHOIS. #