diff --git a/data/example.conf b/data/example.conf index b791a9793..d66a1efe6 100644 --- a/data/example.conf +++ b/data/example.conf @@ -1,1518 +1,1517 @@ -# Example configuration file for Services. After making the appropriate -# changes to this file, place it in the Services data directory (as -# specified in the "configure" script, default /home/username/services) -# under the name "services.conf". -# -# The format of this file is fairly simple: a line beginning with a # is a -# comment, and any other non-blank line is expected to be a directive and -# parameters, separated by spaces or tabs. For example: -# -# Directive Parameter-1 Parameter-2 ... -# -# Directives are case-insensitive. Note that some directives do not take -# any parameters; these are typically "on-off" directives, for which simply -# including the directive in this file (or removing it) has an effect on -# Services' functionality. -# -# If a parameter's value is a string which includes spaces, enclose the -# string in double quotation marks, like the example below. Quotes may be -# used around any string at all for clarity. -# -# "This is a parameter string with spaces in it" -# -# If you need to include a double quote inside a quoted string, precede it -# by a backslash: -# -# "This string has \"double quotes\" in it" -# -# Time parameters can be specified either as an integer representing a -# number of seconds (e.g. "3600" = 1 hour), or as an integer with a unit -# specifier: "s" = seconds, "m" = minutes, "h" = hours, "d" = days. -# Combinations (such as "1h30m") are not permitted. Examples (all of which -# represent the same length of time, one day): -# -# "86400", "86400s", "1440m", "24h", "1d" -# -# CAUTION: -# Please note that your services might _CRASH_ if you add more format- -# strings (%s, %d, etc.) to custom messages than Anope needs. Use the -# default messages to see how many format-strings are needed. -# -# In the documentation for each directive, one of the following will be -# included to indicate whether an option is required: -# -# [REQUIRED] -# Indicates a directive which must be given. Without it, Services will -# not start. -# -# [RECOMMENDED] -# Indicates a directive which may be omitted, but omitting it may cause -# undesirable side effects. -# -# [OPTIONAL] -# Indicates a directive which is optional. If not given, the feature -# will typically be disabled. If this is not the case, more -# information will be given in the documentation. -# -# [DISCOURAGED] -# Indicates a directive which may cause undesirable side effects if -# specified. -# -# [DEPRECATED] -# Indicates a directive which will disappear in a future version of -# Services, usually because its functionality has been either -# superseded by that of other directives or incorporated into the main -# program. - -########################################################################### -# -# IRCD configuration -# -########################################################################### - -# IRCDModule [REQUIRED] -# The ircd protocol module should be used when connecting anope to your -# chosen IRCD. This should be one of the following options, or a file -# provided by your IRCD author. -# -# Bahamut 1.4.27 [or later] - "bahamut" -# Charybdis 1.0 [or later] - "charybdis" -# DreamForge 4.6.7 - "dreamforge" -# Hybrid IRCd 7.0 [experimental] - "hybrid" -# InspIRCd 1.0 [beta 5 or later] - "inspircd10" -# InspIRCd 1.1 [beta 8 or later] - "inspircd11" -# Plexus 3.0 [or later] - "plexus3" -# Plexus 2.0 [or later] - "plexus2" -# PTLink 6.15.0 [experimental] - "ptlink" -# RageIRCd 2.0.x - "rageircd" -# Ratbox 2.0.6 [or later] - "ratbox" -# ShadowIRCD 4.0x [beta 7 or later] - "shadowircd" -# Solid IRCD 3.4.x [3.4.6 or later] - "solidircd" -# UltimateIRCd 3.0.0 [or later] - "ultimate3" -# UltimateIRCd 2.8.2 [or later] - "ultimate2" -# Unreal 3.2 [beta-19 or later] - "unreal32" -# Unreal 3.1.1 [or later] - "unreal31" -# ViagraIRCd 1.3.x [or later] - "viagra" -# - -#IRCDModule "unreal32" - -########################################################################### -# -# Encryption settings -# -########################################################################### - -# EncModule [REQUIRED] -# The encryption module to use when dealing with passwords. -# This determines how the passwords are stored in the databases, -# and does not add any security as far as transmitting passwords over -# the network goes. -# enc_none provides no password encryption, storing the password in -# plain text, this is the most versiatle as passwords can easily be -# recovered. -# -# NOTE: users of anope's previous (broken) md5 implementation should -# select the enc_old option, or things may break. -# -# NOTE2: Some of these encryption methods are one-way (md5, sha1, old) -# meaning that you can NOT retrieve the passwords in plain text once -# encrypted. -# -# Plain Text - enc_none -# Previous (broken) MD5 - enc_old -# MD5 - enc_md5 -# SHA1 - enc_sha1 -# - -EncModule "enc_none" - -########################################################################### -# -# Core module configuration -# -########################################################################### -# HostCoreModules [RECOMMENDED] -# These modules will be loaded as part of HostServ's core. -# It is not recommended you change these settings unless you are -# sure you understand exactly what it is you are doing. -HostCoreModules "hs_help hs_on hs_off hs_group hs_list hs_set hs_setall hs_del hs_delall" - -# MemoCoreModules [RECOMMENDED] -# These modules will be loaded as part of MemoServ's core. -# It is not recommended you change these settings unless you are -# sure you understand exactly what it is you are doing. -MemoCoreModules "ms_send ms_cancel ms_list ms_read ms_del ms_set ms_info ms_rsend ms_check ms_staff ms_sendall ms_help" - -# HelpCoreModules [RECOMMENDED] -# These modules will be loaded as part of HelpServ's core. -# It is not recommended you change these settings unless you are -# sure you understand exactly what it is you are doing. -HelpCoreModules "he_help" - -# BotCoreModules [RECOMMENDED] -# These modules will be loaded as part of BotServ's core. -# It is not recommended you change these settings unless you are -# sure you understand exactly what it is you are doing. -BotCoreModules "bs_help bs_botlist bs_assign bs_set bs_kick bs_badwords bs_act bs_info bs_say bs_unassign bs_bot bs_fantasy bs_fantasy_kick bs_fantasy_kickban bs_fantasy_owner bs_fantasy_seen" - -# OperCoreModules [RECOMMENDED] -# These modules will be loaded as part of OperServ's core. -# It is not recommended you change these settings unless you are -# sure you understand exactly what it is you are doing. -OperCoreModules "os_help os_global os_stats os_oper os_admin os_staff os_mode os_kick os_clearmodes os_akill os_sgline os_sqline os_szline os_chanlist os_userlist os_logonnews os_randomnews os_opernews os_session os_noop os_jupe os_ignore os_set os_reload os_update os_restart os_quit os_shutdown os_defcon os_chankill os_svsnick os_oline os_umode os_modload os_modunload os_modlist os_modinfo" - -# NickCoreModules [RECOMMENDED] -# These modules will be loaded as part of NickServ's core. -# It is not recommended you change these settings unless you are -# sure you understand exactly what it is you are doing. -NickCoreModules "ns_help ns_register ns_group ns_identify ns_access ns_set ns_saset ns_drop ns_recover ns_release ns_sendpass ns_ghost ns_alist ns_info ns_list ns_logout ns_status ns_update ns_getpass ns_getemail ns_forbid ns_suspend" - -# ChanCoreModules [RECOMMENDED] -# These modules will be loaded as part of ChanServ's core. -# It is not recommended you change these settings unless you are -# sure you understand exactly what it is you are doing. -ChanCoreModules "cs_help cs_register cs_identify cs_set cs_xop cs_access cs_akick cs_drop cs_sendpass cs_ban cs_clear cs_modes cs_getkey cs_invite cs_kick cs_list cs_logout cs_topic cs_info cs_getpass cs_forbid cs_suspend cs_status" -########################################################################### -# -# Remote server configuration -# -########################################################################### - -# RemoteServer [REQUIRED] -# Specifies the remote server hostname and port. The hostname may -# either be a standard Internet hostname or dotted-quad numeric -# address; the port number must be an integer between 1 and 65535 -# inclusive. The password is a string which should be enclosed in -# double quotes if it contains any spaces (or just for clarity). -# -# The remote server and port may be overridden at runtime with the -# -remote command-line option. The password may not be set at runtime. -# -# If services can't connect to the RemoteServer, they will try -# RemoteServer2 (if defined). If they can't connect to RemoteServer2, -# they will use RemoteServer3 (if defined). - -RemoteServer localhost 6667 "mypass" -#RemoteServer2 localhost 6667 "mypass" -#RemoteServer3 localhost 6667 "mypass" - -# LocalAddress [port] [OPTIONAL] -# Specifies the local address to bind to before connecting to the -# remote server. This may be useful on multihomed hosts. The hostname -# and port number are specified the same way as with the RemoteServer -# directive. If this is not specified, Services will let the operating -# system choose the local address. If only a hostname is specified, -# Services will bind to that address but let the operating system -# choose the local port number. -# -# If you don't know what this means or don't need to use it, just leave -# the directive commented out. -# -# This directive may be overridden at runtime by the -local -# command-line option. - -#LocalAddress nowhere. 0 - -########################################################################### -# -# Services identification and pseudoclient names -# -########################################################################### - -# ServerName [REQUIRED] -# Specifies the IRC server name which Services should use. May be -# overridden by the -name command-line option. - -ServerName "services.localhost.net" - -# ServerDesc [REQUIRED] -# Specifies the text which should appear as the server's information in -# /whois and similar queries. May be overridden by the -desc -# command-line option. - -ServerDesc "Services for IRC Networks" - -# ServiceUser [REQUIRED] -# Specifies the user@host mask which should be used by the Services -# pseudoclients. May be overridden by the -user and -host command-line -# options. - -ServiceUser "services@localhost.net" - -# ...Name [REQUIRED except as noted below] -# Specify the nicknames (first parameter) and "real" names (second -# parameter) for the Services pseudoclients. BotServ and DevNull may -# be disabled by commenting out the appropriate lines below. Disabling -# BotServ is recommended on large networks. - -NickServName "NickServ" "Nickname Server" -ChanServName "ChanServ" "Channel Server" -MemoServName "MemoServ" "Memo Server" -BotServName "BotServ" "Bot Server" -HelpServName "HelpServ" "Help Server" -OperServName "OperServ" "Operator Server" -GlobalName "Global" "Global Noticer" -#DevNullName "DevNull" "/dev/null -- message sink" -HostServName "HostServ" "vHost Server" - -# ...Alias [OPTIONAL] -# Specify alternate nicknames for services. When a user will /msg -# NickServAlias something, it will be forwarded to NickServName, and -# NickServName will answer. This can be used to ease the migration -# from another network, for example if your services are called -# NickKeeper, ChanKeeper, etc ... and the other network calls them -# NickServ, ChanServ, etc ... - -#NickServAlias "NickServ2" "Nickname Server Forwarder" -#ChanServAlias "ChanServ2" "Channel Server Forwarder" -#MemoServAlias "MemoServ2" "Memo Server Forwarder" -#BotServAlias "BotServ2" "Bot Server Forwarder" -#HelpServAlias "HelpServ2" "Help Server Forwarder" -#OperServAlias "OperServ2" "Operator Server Forwarder" -#GlobalAlias "Global2" "Global Noticer Forwarder" -#DevNullAlias "DevNull2" "/dev/null -- message sink Forwarder" -#HostServAlias "HostServ2" "vHost Server Forwarder" - -########################################################################### -# -# Services data filenames -# -########################################################################### - -# NOTE: All filenames are relative to the Services data directory. - -# PIDFile [REQUIRED] -# Specifies the name of the file containing Services' process ID. - -PIDFile services.pid - -# MOTDFile [REQUIRED] -# Specifies the name of the Message of the Day file. - -MOTDFile services.motd - -# ...DB [REQUIRED] -# Specifies the filenames for the various Services subsystems' databases. - -NickServDB nick.db -#PreNickServDB prenick.db -ChanServDB chan.db -BotServDB bot.db -OperServDB oper.db -NewsDB news.db -ExceptionDB exception.db -HostServDB hosts.db - -# There is no more databases for AKILLs. This setting is kept to allow -# you to import old AKILL database, and is optional. (If not given, -# Services will look for a file named akill.db.) - -# AutokillDB akill.db - -########################################################################### -# -# Network information -# -########################################################################### - -# HelpChannel [OPTIONAL] -# -# When defined, every users that has or gets op status on this channel -# automatically receive the +h user mode. - -HelpChannel "#help" - -# LogChannel [OPTIONAL] -# -# When defined, services will output log messages to this channel. -# IMPORTANT: This can be a security risk so make certain this channel -# is sufficiently protected from normal access. - -#LogChannel "#services" - -# LogBot [OPTIONAL] -# -# When defined, services will output all BotServ chatter to the defined -# LogChan above. It shows all uses of BotServ ACT and SAY commands. Note -# that there is no logging to the log file. Only works if LogChannel is -# also defined. - -#LogBot - -# NetworkName [REQUIRED] -# -# This is the name of the network the Services are running on. - -NetworkName "LocalNet" - -# Numeric [OPTIONAL] -# Many ircd identify themselves with a Numeric ID when using this option -# consult your ircds documentation before using this -#Numeric "64" - -# NickLen [RECOMMENDED] -# Set this to the maximum allowed nick length on your network. Anope does -# not support values larger than 31, so setting them makes no sense. Be -# sure to set this correctly, as setting this wrong can result in services -# being disconnected from the network. - -NickLen 31 - -########################################################################### -# -# Basic functionality -# -########################################################################### - -# UserKey1|2|3 [RECOMMENDED] -# -# These keys are required to initiate the random number generator. These -# numbers MUST be random as you want your passcodes to be random. Don't -# give these keys to anyone! Keep them private! -# -# *** NOTE *** -# If you don't enable these, or keep their default values, any talented -# programmer would be able to easily "guess" random strings used to mask -# information. Be safe, and come up with three different 7 digit numbers - -#UserKey1 9866235 -#UserKey2 8362013 -#UserKey3 2362899 - -# NoBackupOkay [DISCOURAGED] -# Allows Services to continue file write operations (i.e. database -# saving) even if the original file cannot be backed up. Enabling this -# option may allow Services to continue operation under some conditions -# when it might otherwise fail, such as a nearly-full disk. -# -# *** NOTE *** -# Enabling this option can cause irrecoverable data loss under some -# conditions, so make CERTAIN you know what you're doing when you -# enable it! - -#NoBackupOkay - -# StrictPasswords [RECOMMENDED] -# When enabled, causes Services to perform more stringent checks on -# passwords. If this is disabled, Services will only disallow a -# password if it is the same as the entity (nickname or channel name) -# with which it is associated. When enabled, however, Services will -# also check that the password is at least five characters long, and -# in the future will probably check other things as well. - -StrictPasswords - -# BadPassLimit [RECOMMENDED] -# Sets the number of invalid password tries before Services removes a -# user from the network. If a user enters invalid passwords -# for any Services function or combination of functions during a -# single IRC session (subject to BadPassTimeout, below), Services will -# issue a /KILL for the user. If not given, Services will ignore -# failed password attempts (though they will be logged in any case). - -BadPassLimit 5 - -# BadPassTimeout