From c8e9bbbe40839848dad686bd6e96a64130ff094f Mon Sep 17 00:00:00 2001 From: Peter Powell Date: Tue, 12 Jun 2012 18:38:54 +0100 Subject: Move all example configuration files to their own directory. --- docs/inspircd.conf.example | 963 --------------------------------------------- 1 file changed, 963 deletions(-) delete mode 100644 docs/inspircd.conf.example (limited to 'docs/inspircd.conf.example') diff --git a/docs/inspircd.conf.example b/docs/inspircd.conf.example deleted file mode 100644 index d1293be25..000000000 --- a/docs/inspircd.conf.example +++ /dev/null @@ -1,963 +0,0 @@ -######################################################################## -# # -# ___ ___ ____ ____ _ # -# |_ _|_ __ ___ _ __|_ _| _ \ / ___|__| | # -# | || '_ \/ __| '_ \| || |_) | | / _` | # -# | || | | \__ \ |_) | || _ <| |__| (_| | # -# |___|_| |_|___/ .__/___|_| \_\\____\__,_| # -# |_| # -# ____ __ _ _ _ # -# / ___|___ _ __ / _(_) __ _ _ _ _ __ __ _| |_(_) ___ _ __ # -# | | / _ \| '_ \| |_| |/ _` | | | | '__/ _` | __| |/ _ \| '_ \ # -# | |__| (_) | | | | _| | (_| | |_| | | | (_| | |_| | (_) | | | | # -# \____\___/|_| |_|_| |_|\__, |\__,_|_| \__,_|\__|_|\___/|_| |_| # -# |___/ # -# # -##################################||#################################### - #||# -##################################||#################################### -# # -# This is an example of the config file for InspIRCd. # -# Change the options to suit your network # -# # -# # -# ____ _ _____ _ _ ____ _ _ _ # -# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # -# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # -# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # -# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # -# # -# 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 that the # -# process runs in. # -# # -# 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: # -# # -# # -# # -# Executable Include Example: # -# -# # - - -#-#-#-#-#-#-#-#-#-#-#-# VARIABLE DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-# -# # -# You can define variables that will be substituted later in the # -# configuration file. This can be useful to allow settings to be # -# easily changed, or to parameterize a remote includes. # -# # -# Variables may be redefined and may reference other variables. # -# Value expansion happens at the time the tag is read. # -# # -# Using variable definitions REQUIRES that the config format be # -# changed to "xml" from the default "compat" that uses escape # -# sequences such as "\"" and "\n", and does not support # - - - - -#-#-#-#-#-#-#-#-#-#-#-#- SERVER DESCRIPTION -#-#-#-#-#-#-#-#-#-#-#-#- -# # -# Here is where you enter the information about your server. # -# # - - - - -#-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-# -# # -# Describes the Server Administrator's real name (optionally), # -# nick, and email address. # -# # - - - - -#-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#- -# # -# 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. # - - - - - -# When linking servers, the openssl and gnutls implementations are completely -# link-compatible and can be used alongside each other -# on each end of the link without any significant issues. -# Supported ssl types are: "openssl" and "gnutls". -# You must load, m_ssl_openssl for openssl -# or m_ssl_gnutls for gnutls. - - - - - -#-#-#-#-#-#-#-#-#-#- DIE/RESTART CONFIGURATION -#-#-#-#-#-#-#-#-#-#- -# # -# You can configure the passwords here which you wish to use for # -# the die and restart commands. Only trusted IRCop's who will # -# need this ability should know the die and restart password. # -# # - - - #hash="sha256" - - # diepass: Password for opers to use if they need to shutdown (die) - # a server. - diepass="" - - # restartpass: Password for opers to use if they need to restart - # a server. - restartpass=""> - - -#-#-#-#-#-#-#-#-#-#- 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 '*' 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:reason is the message that users will see if they match a deny block - - - - #hash="sha256" - - # password: Password to use for this block/user(s) - password="secret" - - # 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" - - # maxconnwarn: Enable warnings when localmax or globalmax is hit (defaults to on) - maxconnwarn="off" - - # 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" - - # requireident, requiressl, requireaccount: require that users of this - # block have a valid ident response, use SSL, or have authenticated. - # Requires m_ident, m_sslinfo, or m_services_account respectively. - requiressl="on" - # NOTE: For requireaccount, you must complete the signon prior to full - # connection. Currently, this is only possible by using SASL - # authentication; passforward and PRIVMSG NickServ happen after - # your final connect block has been found. - - # Alternate MOTD file for this connect class. The contents of this file are - # specified using or - motd="secretmotd" - - # port: What port this user is allowed to connect on. (optional) - # The port MUST be set to listen in the bind blocks above. - port="6697"> - - - - -#-#-#-#-#-#-#-#-#-#-#-#- CIDR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#- -# # -# 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 # -# # - - - -# This file has all the information about oper classes, types and o:lines. -# You *MUST* edit it. - - -# This file has all the information about server links and ulined servers. -# You *MUST* edit it if you intend to link servers. - - -#-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-# -# # - -# Files block - contains files whose contents are used by the ircd -# -# motd - displayed on connect and when a user executes /MOTD -# rules - displayed when the user executes /RULES -# Modules can also define their own files - - -# Example of an executable file include. Note this will be read on rehash, -# not when the command is run. -# - -#-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# # - - - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# If these values are not defined, InspIRCd uses the default DNS resolver -# of your system. - - - -# An example of using an IPv6 nameserver -# - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# 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. If this is a relative path, it will be # -# relative to the configuration directory, and if it is not defined, # -# the default of 'inspircd.pid' is used. # -# # - -# - -#-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# # -# Use these tags to customise the ban limits on a per channel basis. # -# The tags are read from top to bottom, and any tag found which # -# 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 # -# matched, the banlist size defaults to 64 entries. # -# # - - - - -#-#-#-#-#-#-#-#-#-#-#- DISABLED FEATURES -#-#-#-#-#-#-#-#-#-#-#-#-#-# -# # -# This tag is optional, and specifies one or more features which are # -# not available to non-operators. # -# # -# 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. # -# # -# `fakenonexistant' will make the ircd pretend that nonexistant # -# commands simply don't exist to non-opers ("no such command"). # -# # -# - - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-# -# # -# Just remove this... Its here to make you read ALL of the config # -# file options ;) # - - - - - -#-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-# -# # -# Settings to define which features are usable on your server. # -# # - - - - # suffixpart: What (if anything) a users' part message - # should be suffixed with. - suffixpart=""" - - # fixedquit: Set all users' quit messages to this value. - #fixedquit="" - - # fixedpart: Set all users' part messages in all channels - # to this value. - #fixedpart="" - - # 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" - - # 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" - - # cyclehostsfromuser: If enabled, the source of the mode change for - # cyclehosts will be the user who cycled. This can look nicer, but - # triggers anti-takeover mechanisms of some obsolete bots. - cyclehostsfromuser="no" - - # 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" - - # 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" - - # 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" - - # defaultbind: Sets the default for tags without an address. Choices are - # ipv4 or ipv6; if not specified, IPv6 will be used if your system has support, - # falling back to IPv4 otherwise. - defaultbind="auto" - - # 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" - - # 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" - - # serverpingfreq: How often pings are sent between servers (in seconds). - serverpingfreq="60" - - # 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" - - # 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." - - # exemptchanops: exemptions for channel access restrictions based on prefix. - exemptchanops="nonick:v flood:o" - - # invitebypassmodes: This allows /invite to bypass other channel modes. - # (Such as +k, +j, +l, etc) - invitebypassmodes="yes" - - # nosnoticestack: This prevents snotices from 'stacking' and giving you - # the message saying '(last message repeated X times)'. Defaults to no. - nosnoticestack="no"> - - -#-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-# -# # - - - -#-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-# -# # - -