X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Finspircd.conf.example;h=e6f5d8ea1b46bbb16b2c20e5b8e993106d7561e0;hb=861ca7f2fe22c95cbbdbe534ba6477cc5f8baaf3;hp=cd2018a37034d76194e36fe47bb3cc5e3f2620e9;hpb=b78f4284d514233d546b69ea5c1541734010e798;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/inspircd.conf.example b/docs/inspircd.conf.example index cd2018a37..e6f5d8ea1 100644 --- a/docs/inspircd.conf.example +++ b/docs/inspircd.conf.example @@ -79,8 +79,13 @@ # # # Enter the port and address bindings here. # # # -# bind address - specifies which the address which ports bind # -# port - opens an unused port # +# bind address - specifies which the address which ports bind. # +# may be a hostname or an IP address. Resolution of # +# hostnames may block for up to one second per IP # +# as port binding occurs before the socket engine is # +# initialized and therefore nonblocking DNS is not # +# available at this point until startup is complete. # +# port - The port number to bind to # # 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 # @@ -100,8 +105,14 @@ # # # Syntax is as follows: # # # -# # -# # +# # +# # +# # +# 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. # # # @@ -154,9 +165,11 @@ # # # # # # -# # +# # # # # # +# IP masks may be specified in CIDR format for IPV4 and IPV6. # +# # # 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 # @@ -209,6 +222,7 @@ + #-#-#-#-#-#-#-#-#-#-#-#- CLASS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#- @@ -246,6 +260,9 @@ # This works alongside with the classes specified above. # # # # 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 # @@ -286,6 +303,7 @@ # # # host - host of client allowed to oper-up. # # wildcards accepted, seperate multiple hosts with space # +# You may also specify CIDR ip addresses. # # # # type - specified above, defines the kind of operator # # # @@ -298,7 +316,7 @@ @@ -338,6 +356,13 @@ # UNLESS the connection fails (e.g. due to a bad # # password or servername) # # # +# allowmask - When this is defined, it indicates a range of IP # +# addresses to allow for this link (in CIDR form). # +# e.g. if your server is going to connect to you from # +# the range 1.2.3.1 through 1.2.3.255, put 1.2.3.0/24 # +# into this value. If it is not defined, then only # +# the ipaddr field of the server shall be allowed. # +# # # 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. # @@ -346,11 +371,11 @@ # 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. # +# 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. # # # # ____ _ _____ _ _ ____ _ _ _ # # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # @@ -367,6 +392,7 @@ @@ -374,6 +400,7 @@ @@ -412,9 +439,22 @@ # 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. # +# # +# An example of using IPV4 nameservers over IPV6 +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # # # Define the path to the PID file here. The PID file can be used to # @@ -447,8 +487,8 @@ # 'registered' (e.g. after the initial USER/NICK/PASS on connection) # # so for example disabling NICK will not cripple your network. # # # -# # -# # + +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -469,6 +509,7 @@ # 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 # @@ -512,6 +553,11 @@ # oper-only independent of if they are in a module # # or the core. # # # +# operspywhois - If this is set then when an IRC operator uses # +# /WHOIS on a user they will see all channels, even # +# ones if channels are secret (+s), private (+p) or # +# if the target user is invisible +i. # +# # # customversion - If you specify this configuration item, and it is # # not set to an empty value, then when a user does # # a /VERSION command on the ircd, this string will # @@ -557,6 +603,16 @@ # temporarily copied before loading. If not defined, # # defaults to /tmp. # # # +# 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 et 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. # +# # @@ -646,6 +705,11 @@ # # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Antibear security module: Prevents 'bear.txt' based trojans from +# connecting to your network by sending them a numeric they can't handle. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Antibottler module: Labels bottler leech bots # @@ -757,6 +821,23 @@ # # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Connection throttle module. Configuration: +# +# +#-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# seconds, maxconns - Amount of connections per . +# timeout - Time to wait after the throttle was activated +# before deactivating it. Be aware that the time +# is seconds + timeout. +# quitmsg - The message that users get if they attempt to +# connect while the throttle is active. +# bootwait - Amount of time to wait before enforcing the +# throttling when the server just booted. +# +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Deny Channels: Deny Channels from being used by users # @@ -828,6 +909,29 @@ # # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# httpd module: Provides http server support for InspIRCd +# +# +#-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# +# Optional - If you choose to use the m_httpd.so module, then you must +# specify the port number and other details of your http server: +# +# +# + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# http stats module: Provides basic stats pages over HTTP +# Required m_httpd.so +# +# +#-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-# +# +# No extra configuration yet. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Ident: Provides RFC 1413 ident lookup support # @@ -861,6 +965,19 @@ # Msg flood module: Adds message/notice flood protection (+f) # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# MySQL module: Allows other SQL modules to access MySQL databases +# through a unified API. You must copy the source for this module +# from the directory src/modules/extra, plus the file m_sqlv2.h +# +# +#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_mysql.so is more complex than described here, see the wiki for # +# more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module # +# +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Nicklock module: Let opers change a user's nick and then stop that # user from changing their nick again. /NICKLOCK and /NICKUNLOCK @@ -911,10 +1028,6 @@ # # -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper WHO module: Provides a more revealing /WHO to opers -# - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Override module: Adds support for oper override # @@ -953,6 +1066,19 @@ # m_park.so is too complex it describe here, see the wiki: # # http://www.inspircd.org/wiki/User_Parking_Module # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# PostgreSQL module: Allows other SQL modules to access PgSQL databases +# through a unified API. You must copy the source for this module +# from the directory src/modules/extra, plus the file m_sqlv2.h +# +# +#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# +# # +# m_pgsql.so is more complex than described here, see the wiki for # +# more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module # +# +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Random Quote module: provides a random quote on connect # @@ -1006,6 +1132,11 @@ # 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. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Set Idle module: Adds a command for opers to change their # idle time (mainly a toy) @@ -1013,8 +1144,17 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # 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. # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# 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. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Sethost module: Adds the /SETHOST command # @@ -1044,6 +1184,13 @@ # does not do anything useful without a working SSL module (see below) # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Dummy ssl module: If you have other servers on your network which +# have SSL, but your server does not have ssl enabled, you should load +# this module, which will handle SSL metadata (e.g. the "Is using ssl" +# field in the WHOIS information). +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS, # if enabled. You must copy the source for this module from the directory @@ -1076,19 +1223,6 @@ # SILENCE module: Adds support for /SILENCE # -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SQL module: Allows other SQL modules to access SQL databases -# through a unified API. You must copy the source for this module -# from the directory src/modules/extra -# -# -#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# -# # -# m_sql.so is more complex than described here, see the wiki for more:# -# http://www.inspircd.org/wiki/SQL_Service_Provider_Module # -# -# - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SQL authentication module: Allows IRCd connections to be tied into # a database table (for example a forum). You must copy the source for @@ -1139,6 +1273,11 @@ # Timed bans module: Adds timed bans and the /TBAN command # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Test line module: Adds the /TLINE command, used to test how many +# users a /GLINE or /ZLINE etc would match. +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Uninvite module: Adds the /UNINVITE command which lets users remove # pending invites from channels without waiting for the user to join. @@ -1178,6 +1317,7 @@ # badip lines ban an ip range (same as a zline) # # # # ipmask - The ip range to ban (wildcards possible) # +# CIDR is supported in the IP mask. # # reason - Reason to display when disconnected # # # # badnick lines ban a nick mask (same as a qline) # @@ -1188,11 +1328,13 @@ # badhost lines ban a user@host mask (same as a kline) # # # # host - ident@hostname (wildcards possible) # +# If you specify an IP, CIDR is supported. # # reason - Reason to display on disconnection # # # # exception lines define a hostmask that is excempt from [kzg]lines # # # # host - ident@hostname (wildcards possible) # +# If you specify an IP, CIDR is supported. # # reason - Reason, shown only in /stats e # # # @@ -1205,6 +1347,7 @@ +