anope/data/hostserv.example.conf

/*
 * Example configuration file for HostServ.
 */

/*
 * First, create the service.
 */
service
{
	/*
	 * The name of the HostServ client.
	 * If you change this value, you probably want to change the client directive in the configuration for the hostserv module too.
	 */
	nick = "HostServ"

	/*
	 * The username of the HostServ client.
	 */
	user = "services"

	/*
	 * The hostname of the HostServ client.
	 */
	host = "${services.host}"

	/*
	 * The realname of the HostServ client.
	 */
	real = "Hostname Service"

	/*
	 * The modes this client should use.
	 * Do not modify this unless you know what you are doing.
	 *
	 * These modes are very IRCd specific. If left commented, sane defaults
	 * are used based on what protocol module you have loaded.
	 *
	 * Note that setting this option incorrectly could potentially BREAK some, if
	 * not all, usefulness of the client. We will not support you if this client is
	 * unable to do certain things if this option is enabled.
	 */
	#modes = "+o"

	/*
	 * An optional comma separated list of channels this service should join. Outside
	 * of log channels this is not very useful, as the service will just idle in the
	 * specified channels, and will not accept any types of commands.
	 *
	 * Prefixes may be given to the channels in the form of mode characters or prefix symbols.
	 */
	#channels = "@#services,#mychan"

	/*
	 * The server alias that can be used to securely message this service. If
	 * your IRC server does not have an alias for this service you can set this
	 * to an empty string to tell users to use /msg instead.
	 *
	 * This setting is ignored when options:servicealias is disabled.
	 *
	 * Defaults to the nick of the service if not set.
	 */
	#alias = "HS"
}

/*
 * Core HostServ module.
 *
 * Provides essential functionality for HostServ.
 */
module
{
	name = "hostserv"

	/*
	 * The name of the client that should be HostServ.
	 */
	client = "HostServ"

	/*
	 * If enabled, vhosts are activated on users immediately when they are set.
	 */
	activate_on_set = yes

	/*
	 * If enabled, vhosts are activated on users immediately when they log out of an operator account.
	 */
	activate_on_deoper = yes
}

/*
 * Core HostServ commands.
 *
 * In Anope modules can provide (multiple) commands, each of which has a unique command name. Once these modules
 * are loaded you can then configure the commands to be added to any client you like with any name you like.
 *
 * Additionally, you may provide a permission name that must be in the opertype of users executing the command.
 *
 * Sane defaults are provided below that do not need to be edited unless you wish to change the default behavior.
 */

/* Give it a help command. */
command { service = "HostServ"; name = "HELP"; command = "generic/help" }

/*
 * hs_del
 *
 * Provides the commands hostserv/del and hostserv/delall.
 *
 * Used for removing users' vhosts.
 */
module { name = "hs_del" }
command { service = "HostServ"; name = "DEL"; command = "hostserv/del"; permission = "hostserv/del" }
command { service = "HostServ"; name = "DELALL"; command = "hostserv/delall"; permission = "hostserv/del" }

/*
 * hs_group
 *
 * Provides the command hostserv/group.
 *
 * Used for syncing one vhost to many nicks.
 */
module
{
	name = "hs_group"

	/*
	 * Upon nickserv/group, this option syncs the nick's main vhost to the grouped nick.
	 */
	syncongroup = yes

	/*
	 * This makes vhosts act as if they are per account.
	 */
	synconset = yes
}
command { service = "HostServ"; name = "GROUP"; command = "hostserv/group" }

/*
 * hs_list
 *
 * Provides the command hostserv/list.
 *
 * Used for listing actively set vhosts.
 */
module { name = "hs_list" }
command { service = "HostServ"; name = "LIST"; command = "hostserv/list"; permission = "hostserv/list" }

/*
 * hs_off
 *
 * Provides the command hostserv/off.
 *
 * Used for turning off your vhost.
 */
module { name = "hs_off" }
command { service = "HostServ"; name = "OFF"; command = "hostserv/off" }

/*
 * hs_offfer
 *
 * Provides the commands hostserv/offfer and hostserv/offerlist.
 *
 * Used to offer specialized vhosts to users, with template variables available.
 */
module
{
	name = "hs_offer"

	/*
	 * How long after a vhost is applied can another vhost be taken.
	 */
	takedelay = 7d
}
command { service = "HostServ"; name = "OFFER"; command = "hostserv/offer"; permission = "hostserv/offer" }
command { service = "HostServ"; name = "OFFERLIST"; command = "hostserv/offerlist" }

/*
 * hs_on
 *
 * Provides the command hostserv/on.
 *
 * Used for turning on your vhost.
 */
module { name = "hs_on" }
command { service = "HostServ"; name = "ON"; command = "hostserv/on" }

/*
 * hs_request
 *
 * Provides the commands:
 *   hostserv/request  - Requests a vhost.
 *   hostserv/activate - Approves a requested vhost.
 *   hostserv/reject   - Rejects a requested vhost.
 *   hostserv/waiting  - Lists pending vhost requests.
 *   hostserv/validate - Allows self-service approval of vhosts using DNS
 *                       validation (requires the dns module).
 *
 * Used to manage vhosts requested by users.
 */
module
{
	name = "hs_request"

	/*
	 * If set, Anope will send a memo to the user requesting a vhost when it's been
	 * approved or rejected.
	 */
	#memouser = yes

	/*
	 * If set, Anope will send a memo to all services staff when a new vhost is requested.
	 */
	#memooper = yes

	/*
	 * If DNS validation is enabled, how long should users have to wait between
	 * attempts at DNS validation. Defaults to 5 minutes.
	 */
	#validationcooldown = 5m

	/*
	 * If DNS validation is enabled, the TXT record to look for when determining
	 * if the requester controls the domain. Defaults to anope-dns-validation.
	 */
	#validationrecord = "anope-dns-validation"
}
command { service = "HostServ"; name = "REQUEST"; command = "hostserv/request" }
command { service = "HostServ"; name = "ACTIVATE"; command = "hostserv/activate"; permission = "hostserv/set" }
command { service = "HostServ"; name = "REJECT"; command = "hostserv/reject"; permission = "hostserv/set" }
command { service = "HostServ"; name = "WAITING"; command = "hostserv/waiting"; permission = "hostserv/set" }
#command { service = "HostServ"; name = "VALIDATE"; command = "hostserv/validate" }

/*
 * hs_set
 *
 * Provides the commands hostserv/set and hostserv/setall.
 *
 * Used for setting users' vhosts.
 */
module { name = "hs_set" }
command { service = "HostServ"; name = "SET"; command = "hostserv/set"; permission = "hostserv/set" }
command { service = "HostServ"; name = "SETALL"; command = "hostserv/setall"; permission = "hostserv/set" }