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
}

/*
 * [REQUIRED] Services Options
 *
 * This section contains various options which determine how Services will operate.
 */
options {
	/*
	 * 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.
	 *
	 * When using enc_none, passwords will be stored without encryption in plain
	 * text, allowing for passwords to be recovered later. The other encryption modules
	 * use one-way encryption, so the passwords can not be recovered later if those
	 * are used.
	 *
	 * NOTE: enc_old is Anope's previous (broken) MD5 implementation, if your databases
	 * were made using that module, continue to use it and do not use enc_md5.
	 *
	 * Supported:
	 *  - enc_none (plain text, no encryption)
	 *  - enc_old (old, broken MD5 encryption)
	 *  - enc_md5 (working MD5 encryption)
	 *  - enc_sha1 (SHA1 encryption)
	 */
	encryption = "enc_none"

	/*
	 * These keys are used 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 uncomment 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.
	 *
	 * These directives are optional, but highly recommended.
	 */
	#userkey1 = 9866235
	#userkey2 = 8362013
	#userkey3 = 2362899

	/*
	 * 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 conditions where 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!
	 *
	 * This directive is optional, and you are discouraged against enabling it.
	 */
	#nobackupokay = yes

	/*
	 * If set, Services will perform more stringent checks on passwords. If this
	 * isn't set, Services will only disallow a password if it is the same as the
	 * entity (nickname or channel name) with which it is associated. When set,
	 * 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. This directive is optional, but recommended.
	 */
	strictpasswords = yes

	/*
	 * Sets the number of invalid password tries before Services removes a user
	 * from the network. If a user enters a number of invalid passwords equal to
	 * the given amount for any Services function or combination of functions
	 * during a single IRC session (subject to badpasstimeout, below), Services
	 * will issues a /KILL for the user. If not given, Services will ignore
	 * failed password attempts (though they will be logged in any case). This
	 * directive is optional, but recommended.
	 */
	badpasslimit = 5

	/*
	 * Sets the time after which invalid passwords are forgotten about. If a user
	 * does not enter any incorrect passwords in this amount of time, the incorrect
	 * password count will reset to zero. If not given, the timeout will be
	 * disabled, and the incorrect password count will never be reset until the user
	 * disconnects. This directive is optional.
	 */
	badpasstimeout = 1h

	/*
	 * Sets the delay between automatic database updates. This time is reset by
	 * the OperServ UPDATE command.
	 */
	updatetimeout = 5m

	/*
	 * Sets the delay between checks for expired nicknames and channels. The
	 * OperServ UPDATE command will also cause a check for expiration and reset
	 * this timer.
	 */
	expiretimeout = 30m

	/*
	 * Sets the timout period for reading from the uplink.
	 */
	readtimeout = 5s

	/*
	 * Sets the interval between sending warning messages for program errors via
	 * WALLOPS/GLOBOPS.
	 */
	warningtimeout = 4h

	/*
	 * Sets the (maximum) frequency at which the timeout list is checked. This,
	 * combined with readtimeout above, determine how accurately timed events,
	 * such as nick kills, occur; it also determines how much CPU time Services
	 * will use doing this. Higher values will cause less accurate timing but
	 * less CPU usage.
	 *
	 * This shouldn't be set any higher than 10 seconds, and 1 second is best
	 * if your system is powerful enough (or your network small enough) to
	 * handle it. 0 will cause the timeout list to be checked every time
	 * through the main loop, which will probably slow down Services too much
	 * to be useful on most networks.
	 *
	 * Note that this value is not an absolute limit on the period between
	 * checks of the timeout list; the previous may be as great as readtimeout
	 * (above) during periods of inactivity.
	 *
	 * If this directive is not given, it will default to 0. See the 2nd paragraph
	 * above for performance impacts if you do this.
	 */
	timeoutcheck = 3s
}

/*
 * [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