path: root/data/example_new.conf

/*
 * 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: three types of comments are supported:
 *  - All text after a '#' on a line is ignored, as in shell scripting
 *  - All text after '//' on a line is ignored, as in C++
 *  - A block of text like this one is ignored, as in C
 *
 * Outside of comments, there are three structures: blocks, keys, and values.
 *
 * A block is a named container, which contains a number of key to value pairs
 * - you may think of this as an array.
 *
 * A block is created like so:
 * foobar
 * {
 *    moo = "cow"
 *    foo = bar
 * }
 *
 * Keys are case insensitive. Values depend on what key - generally, information is
 * given in the key comment. The quoting of values (and most other syntax) is quite
 * flexible, however, please do not forget to quote your strings:
 *
 *   "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.
 */


/*
 * [REQUIRED] IRCd Config
 *
 * This section is used to set up Anope to connect to your IRC network.
 */
uplink
{
	/*
	 * This directive instructs Anope which IRCd Protocol to speak when connecting.
	 * You MUST modify this to match the IRCd you run.
	 *
	 * Supported:
	 *  - inspircd11
	 *  - ratbox
	 *  - bahamut
	 *  - charybdis
	 *  - unreal32
	 */
	type = "inspircd11"

	/*
	 * The IP or hostname of the IRC server you wish to connect Services to.
	 * Usually, you will want to connect Services over 127.0.0.1 (aka localhost).
	 *
	 * NOTE: On some shell providers, this will not be an option.
	 */
	host = "localhost"

	/*
	 * The port to connect to.
	 * The IRCd *MUST* be configured to listen on this port, and to accept
	 * server connections.
	 *
	 * Refer to your IRCd documentation for how this is to be done.
	 */
	port = 6667

	/*
	 * The password to send to the IRC server for authentication.
	 * This must match the link block on your IRCd.
	 *
	 * Refer to your IRCd documentation for more information on link blocks.
	 */
	password = "mypassword"

	/*
	 * What Server ID to use for this connection?
	 * Note: This should *ONLY* be used for TS6/P10 IRCds.
	 */
	#id = "64"
}

/*
 * [REQUIRED] Server Information
 *
 * This section contains information about the Services server.
 */
serverinfo {
	/*
	 * The hostname that Services will be seen as, it must have no conflicts with any
	 * other server names on the rest of your IRC network.  Note that it does not have
	 * to be an existing hostname, just one that isn't on your network already. This
	 * can be overridden with the -name command-line option when starting Services.
	 */
	name = "services.localhost.net"

	/*
	 * The text which should appear as the server's information in /whois and similar
	 * queries. This can be overridden by the -desc command-line option when starting
	 * Services.
	 */
	description = "Services for IRC Networks"

	/*
	 * These identify the ident@hostname which will be used by the Serivces pesudoclients.
	 * They can be overridden by the -user and -host command-line options when starting
	 * Services.
	 */
	ident = "services"
	hostname = "localhost.net"

	/*
	 * The filename containing the Services process ID. The path is relative to the
	 * services executable. If not given, defaults to "services.pid".
	 */
	pid = "services.pid"

	/*
	 * The filename containing the Message of the Day. The path is relative to the
	 * services executable. If not given, defaults to "services.motd".
	 */
	motd = "services.motd"
}

/*
 * [REQUIRED] Network Information
 *
 * This section contains information about the IRC network that Services will be
 * connecting to.
 */
networkinfo {
	/*
	 * For the given channel, every use that has or gets op status of the channel
	 * will automatically receive the +h user mode. This directive is optional.
	 */
	helpchannel = "#help"

	/*
	 * If set, Services will output log messages to the given channel. This
	 * directive is optional.
	 *
	 * IMPORTANT: This can be a security risk, so make certain this channel is
	 * sufficiently protected from normal access.
	 */
	#logchannel = "#services"

	/*
	 * If set, Services will output all BotServ chatter to the defined logchannel
	 * 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.
	 * This directive is optional.
	 */
	#logbot = yes

	/*
	 * This is the name of the network that Services will be running on.
	 */
	networkname = "LocalNet"

	/*
	 * Set this to the maximum allowed nick length on your network. Anope does not
	 * support values larger than 31. Be sure to set this correctly, as setting
	 * this wrong can result in Services being disconnected from the network.
	 * This directive is optional, but recommended.
	 */
	nicklen = 31
}

/*
 * [OPTIONAL] Mail Config
 *
 * This section contains settings related to the use of e-mail from Services.
 * If the usemail directive is set to yes, unless specified otherwise, all other
 * directives are required.
 */
mail
{
	/*
	 * If set, this option enables the mail commands in Services. You may choose
	 * to disable it if you have no Sendmail-compatible mailer installed. While
	 * this directive (and entire block) is optional, it is required if the
	 * nickserv:emailregistration is set to yes.
	 */
	usemail = yes

	/*
	 * This is the command-line that will be used to call Sendmail to send an
	 * e-mail. It must be called with all the parameters needed to make it
	 * scan the mail input to find the mail recipient; consult your Sendmail
	 * documentation.
	 *
	 * Postfix users must use the compatible sendmail utility provided with
	 * it; this one usually needs no parameters on the command-line. Most
	 * sendmail applications (or replacements of it) require the -t option
	 * to be used.
	 */
	sendmailpath = "/usr/sbin/sendmail -t"

	/*
	 * This is the e-mail address from which all the e-mails are to be sent from.
	 * It should really exist.
	 */
	sendfrom = "services@localhost.net"

	/*
	 * If set, SENDPASS will be restricted to IRC operators. This directive is
	 * optional.
	 *
	 * WARNING: If you choose to not enable this option, you should limit the
	 * number of processes that the services user can have at a time (you can
	 * create a special user for this; remember to NEVER launch Services as
	 * root).
	 */
	restrict = yes

	/*
	 * This controls the minimum amount of time an user must wait before sending
	 * another e-mail after they have sent one. It also controls the minimum time
	 * an user must wait before they can receive another e-mail. This directive
	 * is optional, but recommended.
	 *
	 * This feature prevents users from being mail bombed using Services and
	 * it is highly recommended that it be used.
	 */
	delay = 5m

	/*
	 * If set, Services will not attempt to put quotes around the TO: fields
	 * in e-mails. This directive is optional, and as far as we know, it's
	 * only needed if you are using ESMTP or QMail to send out e-mails.
	 */
	#dontquoteaddresses = yes
}

/*
 * [REQUIRED] NickServ Config
 *
 * This section is used to set up the Nickname Registration Service pseudo-client.
 * Unless specified otherwise, all directives are required.
 */
nickserv
{
	/*
	 * The nickname of the NickServ client.
	 */
	nick = "NickServ"

	/*
	 * The description of the NickServ client, which will be used as the GECOS (real
	 * name) of the client.
	 */
	description = "Nickname Registration Service"

	/*
	 * The filename of the NickServ database.  The path is relative to the services
	 * executable.  If not given, defaults to "nick.db".
	 */
	database = "nick.db"

	/*
	 * The filename of the NickServ Pre-Nick database.  The path is relative to the
	 * services executable.  This directive is only required if the e-mail registration
	 * option is enabled.
	 */
	#prenickdatabase = "prenick.db"

	/*
	 * The core modules to load for NickServ. This is a space separated list that corresponds
	 * to the base names of the modules for NickServ. This directive is optional, but highly recommended.
	 */
	modules = "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"

	/*
	 * Force users to give an e-mail address when they register a nick. This directive
	 * is recommended to be enabled, and required if the e-mail registration option is
	 * enabled.
	 */
	forceemail = yes

	/*
	 * Require an e-mail to be sent to the user before they can register their nick.
	 */
	#emailregistration = yes

	/*
	 * The default options for newly registered nicks. Note that changing these options
	 * will have no effect on nicks which are already registered. The list must be separated
	 * by spaces.
	 *
	 * The options are:
	 * -         kill: Kill nick if not identified within 60 seconds
	 * -    killquick: Kill nick if not identified within 20 seconds, this one overrides the above
	 *                   option and the above must be specified with this one
	 * -       secure: Enable nickname security, requiring the nick's password before any operations
	 *                   can be done on it
	 * -      private: Hide the nick from NickServ's LIST command
	 * -    hideemail: Hide's the nick's e-mail address from NickServ's INFO command
	 * - hideusermask: Hide's the nick's last or current user@host from NickServ's INFO command
	 * -     hidequit: Hide's the nick's last quit message
	 * -   memosignon: Notify user if they have a new memo when they sign into the nick
	 * -  memoreceive: Notify user if they have a new memo as soon as it's received
	 * -       autoop: User will be automatically opped in channels they enter and have access to
	 * -          msg: Services messages will be sent as PRIVMSGs instead of NOTICEs, requires UsePrivmsg
	 *                   to be enabled as well
	 *
	 * This directive is optional, if left blank, the options will default to secure, memosignon, and
	 * memoreceive. If you really want no defaults, use "none" by itself as the option.
	 */
	defaults="secure private hideemail hideusermask memosignon memoreceive autoop"

	/*
	 * Default language that non- and newly-registered nicks will receive messages in. The number
	 * here is the same as the number in NickServ's SET LANGUAGE help.
	 */
	defaultlanguage = 1

	/*
	 * The minimum length of time between consecutive uses of NickServ's REGISTER command. This
	 * directive is optional, but recommended. If not set, this restriction will be disabled.
	 */
	regdelay = 30s

	/*
	 * The minimum length of time between consecutive uses of NickServ's RESEND command. This
	 * directive is optional, but recommended. If not set, this restriction will be disabled.
	 */
	resenddelay = 90s

	/*
	 * The length of time before a nick registration expires. This directive is optional, but
	 * recommended. If not set, the default is 21 days.
	 */
	expire = 21d

	/*
	 * The length of time a user gets to enter the confirmation code which has been e-mailed
	 * to them before the nick will be released for general use again. This directive is
	 * only required if the e-mail registration option is enabled.
	 */
	#preregexpire = 1d

	/*
	 * The maximum number of nicks allowed in a group. This directve is optional, but
	 * recommended. If not set or set to 0, no limits will be applied.
	 */
	maxaliases = 16

	/*
	 * The maximum number of entries allowed on a nickname's access list.
	 */
	accessmax = 32

	/*
	 * The username (and possibly hostname) used for the fake user created when NickServ collides
	 * a user. Should be in the user@host format. If the host is not given, the one from ServicesUser
	 * is used.
	 */
	enforceruser = "enforcer@localhost.net"
	#enforceruser = "enforcer"

	/*
	 * The delay before a NickServ-collided nick is released.
	 */
	releasetimeout = 1m

	/*
	 * Allow the use of the IMMED option in the NickServ SET KILL command. This directive is optional.
	 */
	#allowkillimmed = yes

	/*
	 * If set, the NickServ GROUP command won't allow any group change. This is recommended for
	 * better performance and to protect against nick stealing, however users will have less
	 * flexibility. This directive is optional.
	 */
	#nogroupchange = yes

	/*
	 * Limits the use of the NickServ LIST command to IRC operators. This directive is optional.
	 */
	#listopersonly = yes

	/*
	 * The maximum number of nicks to be returned for a NickServ LIST command.
	 */
	listmax = 50

	/*
	 * When a user's nick is forcibly changed to enforce a "nick kill", their new nick will start
	 * with this value. The rest will be made up of 6 or 7 digits.
	 */
	guestnickprefix = "Guest"

	/*
	 * Prevents the use of the DROP, FORBID, GETPASS, and SET PASSWORD commands by Services Admins
	 * on other Services Admins or the Services Root(s). This directive is optional, but
	 * recommended.
	 */
	secureadmins = yes

	/*
	 * If set, any user wanting to use the privileges of Services Root, Services Admin, or Services
	 * Operator must have been logged as an IRC Operator with the /oper command. This directive is
	 * optional, but recommended.
	 */
	strictprivileges = yes

	/*
	 * If set, Services will set the channel modes a user has access to upon identifying, assuming
	 * they are not already set. This directive is optional.
	 */
	#modeonid = yes

	/*
	 * If set, Services will only allow Services Root(s) to use the NickServ GETPASS command on
	 * a nick. This directive is optional.
	 */
	restrictgetpass = yes

	/*
	 * If set, Services will track your last nick identified when issuing nick changes. This
	 * directive is optional.
	 */
	#nicktracking = yes

	/*
	 * If set, Services will add the usermask of registering users to the access list of their
	 * newly created account. If not set, users will always have to identify to NickServ before
	 * being recognized, unless they manually add an address to the access list of their account.
	 * This directive is optional.
	 */
	addaccessonreg = yes
}

/*
 * [REQUIRED] ChanServ Config
 *
 * This section is used to set up the Channel Registration Service pseudo-client.
 * Unless specified otherwise, all directives are required.
 */
chanserv
{
	/*
	 * The nickname of the ChanServ client.
	 */
	nick = "ChanServ"

	/*
	 * The description of the ChanServ client, which will be used as the GECOS (real
	 * name) of the client.
	 */
	description = "Channel Registration Service"

	/*
	 * The filename of the ChanServ database.  The path is relative to the services
	 * executable.  If not given, defaults to "chan.db".
	 */
	database = "chan.db"

	/*
	 * The core modules to load for ChanServ. This is a space separated list that corresponds
	 * to the base names of the modules for ChanServ. This directive is optional, but highly recommended.
	 */
	modules = "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"

	/*
	 * The default options for newly registered channels. Note that changing these options
	 * will have no effect on channels which are already registered. The list must be separated
	 * by spaces.
	 *
	 * The options are:
	 * -     keeptopic: Retain topic when the channel is not in use
	 * -      opnotice: Send a notice when OP/DEOP commands are used
	 * -         peace: Disallow users from kicking or removing modes from others who are of the same
	 *                    access level or superior
	 * -       private: Hide the channel from ChanServ's LIST command
	 * -    restricted: Kick/ban users who are restricted from the channel
	 * -        secure: Enable channel security, requiring the user to be identified with NickServ in
	 *                    order to be considered for being on the access list of the channel
	 * -     secureops: Only allow operator status to be given if the user is on the access list
	 * - securefounder: Only allow the real founder of the channel to drop the channel, change it's
	 *                    password, or change the founder or succesor
	 * -      signkick: Use of ChanServ's KICK command will cause the user's nick to be signed to the kick.
	 * - signkicklevel: Same as above, but the kick will not be signed if the user is at the same access
	 *                    level or superior to the target
	 * -     topiclock: Disallow the topic to be changed except with ChanServ's TOPIC command
	 * -           xop: Enable use of the xOP system
	 *
	 * This directive is optional, if left blank, the options will default to keetopic, secure, securefounder,
	 * and signkick. If you really want no defaults, use "none" by itself as the option.
	 */
	defaults="keeptopic peace secure securefounder signkick xop"

	/*
	 * The maximum number of channels which may be registered to a single nickname. This directive is optional,
	 * but recommended. If not set, there will be no restriction on the numbers of channels a single nickname
	 * can have registered.
	 */
	maxregistered = 20

	/*
	 * The length of time before a channel registration expires. This directive is optional, but
	 * recommended. If not set, the default is 14 days.
	 */
	expire = 14d

	/*
	 * The default ban type for newly registered channels (and when importing old databases).
	 *
	 * defbantype can be:
	 *
	 * 0: ban in the form of *!user@host
	 * 1: ban in the form of *!*user@host
	 * 2: ban in the form of *!*@host
	 * 3: ban in the form of *!*user@*.domain
	 */
	defbantype = 2

	/*
	 * The maximum number of entries on a channel's access list.
	 */
	accessmax = 1024

	/*
	 * The maximum number of entries on a channel's autokick list.
	 */
	autokickmax = 32

	/*
	 * The default reason for an autokick if none is given.
	 */
	autokickreason = "User has been banned from the channel"

	/*
	 * The length of time ChanServ stays in a channel after kicking a user from a channel they are not
	 * premitted to be in. This only occurs when the user is the only one in the channel.
	 */
	inhabit = 15s

	/*
	 * Limits the use of the ChanServ LIST command to IRC operators. This directive is optional.
	 */
	#listopersonly = yes

	/*
	 * The maximum number of channels to be returned for a ChanServ LIST command.
	 */
	listmax = 50

	/*
	 * If set, Services will only allow Services Root(s) to use the ChanServ GETPASS command on a
	 * channel. This directive is optional.
	 */
	#restrictgetpass = yes

	/*
	 * Allow only IRC Operators to use ChanServ. This directive is optional.
	 */
	#opersonly = yes
}

/*
 * [REQUIRED] MemoServ Config
 *
 * This section is used to set up the Memo Service pseudo-client. Unless specified otherwise,
 * all directives are required.
 */
memoserv
{
	/*
	 * The nickname of the MemoServ client.
	 */
	nick = "MemoServ"

	/*
	 * The description of the MemoServ client, which will be used as the GECOS (real
	 * name) of the client.
	 */
	description = "Memo Service"

	/*
	 * The core modules to load for MemoServ. This is a space separated list that corresponds
	 * to the base names of the modules for MemoServ. This directive is optional, but highly recommended.
	 */
	modules = "ms_send ms_cancel ms_list ms_read ms_del ms_set ms_info ms_rsend ms_check ms_staff ms_sendall ms_help"

	/*
	 * The maximum number of memos a user is allowed to keep by default. Normal users may set the
	 * limit anywhere between 0 and this value. Services Admins can change it to any value or
	 * disable it. This directive is optional, but recommended. If not set, the limit is disabled
	 * by default, and normal users can set any limit they want.
	 */
	maxmemos = 20

	/*
	 * The delay between consecutive uses of the MemoServ SEND command. This can help prevent spam
	 * as well as denial-of-service attacks from sending large numbers of memos and filling up disk
	 * space (and memory). The default 3-second wait means a maximum average of 150 bytes of memo
	 * per second per user under the current IRC protocol. This directive is optional, but
	 * recommended.
	 */
	senddelay = 3s

	/*
	 * Should we notify all appropriate users of a new memo? This applies in cases where a memo is
	 * sent to a nick which is in the group of another nick. Not that, unlike before, it is currently
	 * more efficient to enable this. This directive is optional.
	 */
	notifyall = yes

	/*
	 * Allow the use of memo receipts for the following groups:
	 *
	 * 1 - Opers Only
	 * 2 - Everybody
	 *
	 * This directive is optional.
	 */
	#memoreceipt = 1
}

/*
 * [OPTIONAL] BotServ Config
 *
 * This section is used to set up the Bot Service pseudo-client. The block is optional and can be
 * removed if yo