ermyth/dist/example.conf

/* This is an example configuration for Ermyth.
 *
 * All statements end in semi-colons (';').
 * Shell style, C style, and C++ style comments may be used.
 *
 * Items marked with "(*)" are reconfigurable at runtime via REHASH.
 */

/*
 * These are the modules included with the core distribution of Ermyth 3.
 * You may be interested in the Ermyth community modules distribution as 
 * well, which adds additional features that may or may not be compatible
 * with the project paradigms intended for maintainance of the Ermyth core.
 *
 * Visit the Ermyth website for more information and to download them.
 */

/* Protocol handler.
 *
 * Please select a protocol handler. Different servers use different protocols.
 * Below is a listing of ircd's known to work with the various protocol handlers
 * available.
 *
 * Asuka 1.2.1 or later                         asuka
 * Bahamut 1.8.x                                bahamut
 * Beware IRCd (bircd)                          bircd
 * Charybdis IRCd                               charybdis
 * dancer-ircd/hyperion                         hyperion
 * DreamForge 4.6.7 or later                    dreamforge
 * Hybrid 7.1.2 and later                       hybrid
 * ircd-ratbox 2.0 and later                    ratbox
 * IRCNet ircd (ircd 2.11)                      ircnet
 * ircu 2.10.11.07 or later                     undernet
 * IRCXPRO 1.2/OfficeIRC                        officeirc
 * InspIRCd 1.1b1 or later                      inspircd11
 * InspIRCd 1.2 [experimental]                  inspircd12
 * Nefarious IRCu 0.4.0 or later                nefarious
 * PleXusIRCd 3.x                               plexus
 * PTlink IRCd                                  ptlink
 * ShadowIRCd 3.3/3.6 family                    shadowircd
 * sorircd 1.3.1 or later                       sorcery
 * UltimateIRCd 3.0 or later                    ultimate3
 * UnrealIRCd 3.1/3.2                           unreal
 *
 * If your IRCd vendor has supplied a module file, build it and load it here
 * instead of one above.
 */
protocol "inspircd11";

/* Database backend.
 * 
 * Please select a database backend. Different backends allow for
 * different ways in which the services data can be manipulated. YOU MAY
 * ONLY HAVE ONE OF THESE BACKENDS LOADED.
 * 
 * The following backends are available:
 * 
 * Ermyth 0.1 flatfile database format          flatfile
 * 
 * Most networks will want flatfile.
 */
backend "flatfile";

/* Crypto handler.
 *
 * If you would like encryption for your services passwords, please
 * select a handler here. Note that upon starting with a crypto handler
 * YOUR PASSWORDS ARE IMMEDIATELY AND IRREVERSIBLY CONVERTED. Make at
 * least TWO backups of your database before experimenting with this.
 * If you have several thousand accounts, this conversion may take
 * appreciable time.
 *
 * The following crypto handlers are available:
 *
 * POSIX-style crypt(3)                         posix
 * IRCServices (also Anope etc) compatibility   ircservices
 * SorceryNet services compatibility            sorservices
 *
 * The ircservices and sorservices handlers are only recommended for use with
 * a database converted from other services with password encryption.
 */
crypto "posix";

/* NickServ modules.
 *
 * Here you can disable or enable certain features of NickServ, by
 * defining which modules are loaded. You can even disable NickServ
 * entirely. Please note however, that an authentication service
 * (either NickServ, or UserServ) are required for proper functionality.
 *
 * Core components                              nickserv/main
 * Nickname access lists                        nickserv/access
 * DROP command                                 nickserv/drop
 * GHOST command                                nickserv/ghost
 * GROUP and UNGROUP commands                   nickserv/group
 * HELP command                                 nickserv/help
 * Nickname expiry override (HOLD command)      nickserv/hold
 * IDENTIFY command                             nickserv/identify
 * INFO command                                 nickserv/info
 * LIST command                                 nickserv/list
 * LISTMAIL command                             nickserv/listmail
 * LOGIN command (for no_nick_ownership)        nickserv/login
 * LOGOUT command                               nickserv/logout
 * MARK command                                 nickserv/mark
 * FREEZE command                               nickserv/freeze
 * LISTCHANS command                            nickserv/listchans
 * REGISTER command                             nickserv/register
 * Password reset (RESETPASS command)           nickserv/resetpass
 * Password return (RETURN command)             nickserv/return
 * Password retrieval (SENDPASS command)        nickserv/sendpass
 * SET command                                  nickserv/set
 * Password retrieval uses code (SETPASS cmd)   nickserv/setpass
 * Presence notifications (SUBSCRIBE command)   nickserv/subscribe
 * Nickname enforcement                         nickserv/enforce
 * STATUS command                               nickserv/status
 * Nickname metadata viewer (TAXONOMY command)  nickserv/taxonomy
 * VERIFY command                               nickserv/verify
 * VHOST command                                nickserv/vhost
 */
loadmodule "nickserv/main";
#loadmodule "nickserv/access";
loadmodule "nickserv/drop";
loadmodule "nickserv/ghost";
loadmodule "nickserv/group";
loadmodule "nickserv/help";
loadmodule "nickserv/hold";
loadmodule "nickserv/identify";
loadmodule "nickserv/info";
loadmodule "nickserv/list";
loadmodule "nickserv/listmail";
#loadmodule "nickserv/login";
loadmodule "nickserv/logout";
loadmodule "nickserv/mark";
loadmodule "nickserv/freeze";
loadmodule "nickserv/listchans";
loadmodule "nickserv/register";
loadmodule "nickserv/resetpass";
loadmodule "nickserv/return";
loadmodule "nickserv/sendpass";
loadmodule "nickserv/set";
loadmodule "nickserv/setpass";
loadmodule "nickserv/subscribe";
#loadmodule "nickserv/enforce";
loadmodule "nickserv/status";
loadmodule "nickserv/taxonomy";
loadmodule "nickserv/verify";
loadmodule "nickserv/vhost";

/* ChanServ modules.
 * 
 * Here you can disable or enable certain features of ChanServ, by
 * defining which modules are loaded. You can even disable ChanServ
 * entirely. Please note that ChanServ requires an authentication
 * service, either NickServ or UserServ will do.
 *
 * Core components                              chanserv/main
 * AKICK command                                chanserv/akick
 * BAN/UNBAN commands                           chanserv/ban
 * UNBAN self only (load ban or this not both)  chanserv/unban_self
 * CLOSE command                                chanserv/close
 * CLEAR command                                chanserv/clear
 * CLEAR BANS command                           chanserv/clear_bans
 * CLEAR USERS command                          chanserv/clear_users
 * COUNT command                                chanserv/count
 * DROP command                                 chanserv/drop
 * Forced flags changes                         chanserv/fflags
 * FLAGS command                                chanserv/flags
 * Forced foundership transfers                 chanserv/ftransfer
 * GETKEY command                               chanserv/getkey
 * HALFOP/DEHALFOP commands                     chanserv/halfop
 * HELP command                                 chanserv/help
 * Channel expiry override (HOLD command)       chanserv/hold
 * INFO command                                 chanserv/info
 * INVITE command                               chanserv/invite
 * KICK/KICKBAN commands                        chanserv/kick
 * LIST command                                 chanserv/list
 * MARK command                                 chanserv/mark
 * OP/DEOP commands                             chanserv/op
 * QUIET command (+q support)                   chanserv/quiet
 * Channel takeover recovery (RECOVER command)  chanserv/recover
 * REGISTER command                             chanserv/register
 * SET command                                  chanserv/set
 * STATUS command                               chanserv/status
 * Channel metadata viewer (TAXONOMY command)   chanserv/taxonomy
 * TEMPLATE command                             chanserv/template
 * TOPIC/TOPICAPPEND commands                   chanserv/topic
 * VOICE/DEVOICE commands                       chanserv/voice
 * WHY command                                  chanserv/why
 * VOP/HOP/AOP/SOP commands                     chanserv/xop
 *      This module provides emulation of the ircservices XOP scheme ONLY.
 *      Do not report discrepencies when using native commands to edit channel
 *      ACLs. This is intentional.
 */
loadmodule "chanserv/main";
loadmodule "chanserv/akick";
loadmodule "chanserv/ban";
#loadmodule "chanserv/unban_self";
loadmodule "chanserv/close";
loadmodule "chanserv/clear";
loadmodule "chanserv/clear_bans";
loadmodule "chanserv/clear_users";
loadmodule "chanserv/count";
loadmodule "chanserv/drop";
#loadmodule "chanserv/fflags";
loadmodule "chanserv/flags";
loadmodule "chanserv/ftransfer";
loadmodule "chanserv/getkey";
loadmodule "chanserv/halfop";
loadmodule "chanserv/help";
loadmodule "chanserv/hold";
loadmodule "chanserv/info";
loadmodule "chanserv/invite";
loadmodule "chanserv/kick";
loadmodule "chanserv/list";
loadmodule "chanserv/mark";
loadmodule "chanserv/op";
#loadmodule "chanserv/quiet";
loadmodule "chanserv/recover";
loadmodule "chanserv/register";
loadmodule "chanserv/set";
loadmodule "chanserv/status";
loadmodule "chanserv/taxonomy";
loadmodule "chanserv/template";
loadmodule "chanserv/topic";
loadmodule "chanserv/voice";
loadmodule "chanserv/why";
#loadmodule "chanserv/xop";

/* OperServ modules.
 *
 * Here you can disable or enable certain features of OperServ, by
 * defining which modules are loaded.
 *
 * Core components                              operserv/main
 * AKILL system                                 operserv/akill
 * CLEARCHAN command                            operserv/clearchan
 * CLONES system                                operserv/clones
 * COMPARE command                              operserv/compare
 * HELP command                                 operserv/help
 * IGNORE system                                operserv/ignore
 * INJECT command                               operserv/inject
 * JUPE command                                 operserv/jupe
 * MODE command                                 operserv/mode
 * MODINSPECT command                           operserv/modinspect
 * MODLIST command                              operserv/modlist
 * MODLOAD command                              operserv/modload
 * MODUNLOAD command                            operserv/modunload
 * NOOP system                                  operserv/noop
 * Regex mass akill (RAKILL command)            operserv/rakill
 * RAW command                                  operserv/raw
 * REHASH command                               operserv/rehash
 * RESTART command                              operserv/restart
 * Display regex matching (RMATCH command)      operserv/rmatch
 * Most common realnames (RNC command)          operserv/rnc
 * RWATCH system                                operserv/rwatch
 * SHUTDOWN command                             operserv/shutdown
 * Non-config oper privileges (SOPER command)   operserv/soper
 * Oper privilege display (SPECS command)       operserv/specs
 * UPDATE command                               operserv/update
 * UPTIME command                               operserv/uptime
 */
loadmodule "operserv/main";
loadmodule "operserv/akill";
loadmodule "operserv/clearchan";
loadmodule "operserv/clones";
loadmodule "operserv/compare";
loadmodule "operserv/help";
loadmodule "operserv/ignore";
#loadmodule "operserv/inject";
loadmodule "operserv/jupe";
loadmodule "operserv/mode";
loadmodule "operserv/modinspect";
loadmodule "operserv/modlist";
loadmodule "operserv/modload";
loadmodule "operserv/modunload";
loadmodule "operserv/noop";
loadmodule "operserv/rakill";
#loadmodule "operserv/raw";
loadmodule "operserv/rehash";
loadmodule "operserv/restart";
loadmodule "operserv/rmatch";
loadmodule "operserv/rnc";
loadmodule "operserv/rwatch";
loadmodule "operserv/shutdown";
loadmodule "operserv/soper";
loadmodule "operserv/specs";
loadmodule "operserv/update";
loadmodule "operserv/uptime";

/* MemoServ modules.
 *
 * Here you can disable or enable certain features of MemoServ, by
 * defining which modules are loaded. You can even disable MemoServ
 * entirely.
 *
 * Core components                              memoserv/main
 * HELP command                                 memoserv/help
 * SEND command                                 memoserv/send
 * Channel memos (SENDOPS command)              memoserv/sendops
 * LIST command                                 memoserv/list
 * READ command                                 memoserv/read
 * FORWARD command                              memoserv/forward
 * DELETE command                               memoserv/delete
 * IGNORE command                               memoserv/ignore
 */
loadmodule "memoserv/main";
loadmodule "memoserv/help";
loadmodule "memoserv/send";
loadmodule "memoserv/sendops";
loadmodule "memoserv/list";
loadmodule "memoserv/read";
loadmodule "memoserv/forward";
loadmodule "memoserv/delete";
loadmodule "memoserv/ignore";

/* Global module.
 *
 * Like the other services, the Global noticer is a module. You can
 * disable or enable it to your liking below. Please note that the
 * Global noticer is dependent on OperServ for full functionality.
 */
loadmodule "global/main";

/* SASL agent module.
 *
 * Allows clients to authenticate to services via SASL with an appropriate
 * ircd. You need the core components and at least one mechanism.
 *
 * Core components                              saslserv/main
 * PLAIN mechanism                              saslserv/plain
 * DH-BLOWFISH mechanism                        saslserv/dh-blowfish
 */
#loadmodule "saslserv/main";
#loadmodule "saslserv/plain";
#loadmodule "saslserv/dh-blowfish"; /* requires SSL */

/* Miscellaneous modules.
 *
 * These are fully accepted user contributions and modules that don't fit
 * into a service. Modules in misc can generally be considered stable.
 *
 * Perl interface                               misc/svsperl
 */
#loadmodule "misc/svsperl";

/* GameServ modules.
 *
 * Here you can disable or enable certain features of GameServ, by
 * defining which modules are loaded. You can even disable GameServ
 * entirely.
 *
 * Core components                              gameserv/main
 * DICE/WOD commands                            gameserv/dice
 * HELP commands                                gameserv/help
 * NAMEGEN command                              gameserv/namegen
 */
loadmodule "gameserv/main";
loadmodule "gameserv/dice";
loadmodule "gameserv/help";
loadmodule "gameserv/namegen";

/* RPC modules.
 * 
 * Ermyth includes an optional HTTP server that can be used for integration
 * with portal software and other useful things. To enable it, load this
 * module, and uncomment the httpd { } block towards the bottom of the config.
 *
 * The RPC handlers require rpc/http to be loaded as it merely registers a
 * path handler for RPC. The path used for XML-RPC is /xmlrpc. For JSON-RPC,
 * it registers /jsonrpc.
 *
 * XMLRPC handler for the httpd                 xmlrpc/main
 */
loadmodule "rpc/httpd"; // Required
loadmodule "rpc/xmlrpc";
#loadmodule "rpc/jsonrpc";

/* Other modules.
 *
 * Put any other modules you want to load on startup here.
 * A list of user contributions and non-core modules is given here.
 */
#loadmodule "contrib/cs_kickdots";
#loadmodule "contrib/cs_ping";
#loadmodule "contrib/cs_sync";
#loadmodule "contrib/cs_userinfo";
#loadmodule "contrib/gen_echoserver";
#loadmodule "contrib/gen_listenerdemo";
#loadmodule "contrib/gen_regcheckemail";
#loadmodule "contrib/gen_vhostonreg";
#loadmodule "contrib/graphtastical";
#loadmodule "contrib/ircd_alis";
#loadmodule "contrib/ircd_catserv";
#loadmodule "contrib/ircd_nohalfops";
#loadmodule "contrib/ircd_noowner";
#loadmodule "contrib/ircd_noprotect";
#loadmodule "contrib/ns_fregister";
#loadmodule "contrib/ns_generatepass";
#loadmodule "contrib/ns_mxcheck";
#loadmodule "contrib/ns_ratelimitreg";
#loadmodule "contrib/os_logonnews";
#loadmodule "contrib/os_logstream";
#loadmodule "contrib/os_pingspam";
#loadmodule "contrib/os_tabletest";
#loadmodule "contrib/os_testcmd";

/* The serverinfo{ } block defines how we
 * appear on the IRC network.
 */
serverinfo {
        /* name
         * The server name that this program uses on the IRC network.
         * This is the name you'll have to use in C:/N:Lines. It must be
         * unique on the IRC network and contain at least one dot, but does
         * not have to be equal to any DNS name.
         */
        name = "services.int";

        /* desc
         * The ``server comment'' we send to the IRC network.
         * If you want server hiding, prefix your desc with "(H)"
         */
        desc = "Ermyth IRC Services";

        /* numeric
         * Some protocol drivers (Charybdis, Ratbox2, Hybrid, P10, IRCNet, InspIRCd 1.2)
         * require a server id, also known as a numeric. Please consult your
         * ircd's documentation when providing this value. 
         */
        numeric = "00A";

        /* (*)recontime
         * The number of seconds before we reconnect to the uplink.
         */
        recontime = 10;

        /* (*)netname
         * The name of your network.
         */
        netname = "Misconfigured Network";

        /* (*)hidehostsuffix
         * P10 +x host hiding gives <account>.<hidehostsuffix>.
         * If using +x on asuka/bircd/undernet, this must agree
         * with F:HIDDEN_HOST.
         */
        hidehostsuffix = "users.misconfigured";

        /* (*)adminname
         * The name of the person running this service.
         */
        adminname = "Misconfigured Admin";

        /* (*)adminemail
         * The email address of the person running this service.
         */
        adminemail = "misconfigured@admin.tld";

        /* (*)mta
         * The full path to your mail transfer agent.
         * This is used for email authorization and password retrieval.
         * Comment this out to disable sending email.
         * Warning: sending email can disclose the IP of your services
         * unless you take precautions (not discussed here further).
         */
        mta = "/usr/sbin/sendmail";

        /* (*)loglevel
         * Specify the default categories of logging information to record
         * in the master Ermyth logfile, usually var/ermyth.log.
         *
         * Options include:
         *      debug, all      - meta-keyword for all possible categories
         *      trace           - meta-keyword for a little bit of info
         *      misc            - like trace, but with some more miscillaneous info
         *      notice          - meta-keyword for notice-like information
         * ------------------------------------------------------------------------------
         *      error           - critical errors
         *      info            - miscillaneous log notices
         *      commands        - all command use
         *      admin           - administrative command use
         *      register        - account and channel registrations
         *      set             - changes of account or channel settings
         *      network         - log notices related to network status
         *      rawdata         - log raw data sent and received by services
         *      wallops         - <not yet used>
         */
        loglevel = { error; info; admin; network; wallops; };

        /* (*)maxlogins
         * What is the maximum number of sessions allowed to login to one
         * username? This reduces potential abuse. It is only checked on login.
         */
        maxlogins = 5;

        /* (*)maxusers
         * What are the maximum usernames that one email address can register?
         */
        maxusers = 5;

        /* (*)maxnicks
         * If GROUP is loaded, what are the maximum nicknames that one
         * username can register?
         */
        maxnicks = 5;

        /* (*)maxchans
         * What are the maximum channels that one username can register?
         */
        maxchans = 5;

        /* (*)mdlimit
         * How many metadata entries can be added to an object?
         */
        mdlimit = 30;

        /* (*)emaillimit, emailtime
         * The maximum number of emails allowed to be sent in
         * that amount of time (seconds). If this is exceeded,
         * wallops will be sent, at most one per minute.
         */
        emaillimit = 10;
        emailtime = 300;

        /* (*)auth
         * What type of username registration authorization do you want?
         * If "email," Ermyth will send a confirmation email to the address to
         * ensure it's valid. If "none," no message will be sent and the username
         * will be fully registered.
         * Valid values are: email, none.
         */
        auth = "none";

        /* casemapping
         * Specify the casemapping to use. Almost all TSora (and any that follow
         * the RFC correctly) ircds will use rfc1459 casemapping. Bahamut, Unreal,
         * and other ``Dalnet'' ircds will use ascii casemapping.
         * Valid values are: rfc1459, ascii.
         */
        casemapping = "rfc1459";
};

/* uplink{ } blocks define connections to IRC servers.
 * Multiple may be defined but only one will be used at a time (IRC
 * being a tree shaped network).
 */
uplink "irc.xinutec.org" {
        // the server name goes above

        // host
        // The hostname to connect to.
        host = "127.0.0.1";

        // vhost
        // The source IP to connect from, used on machines with multiple interfaces.
        #vhost = "202.119.187.31";

        // password
        // The password used for linking.
        password = "linkage";

        // port
        // The port used for linking.
        port = 7000;
};

/* The nickserv { } block defines settings specific to the nickname/username
 * registration services client on the IRC network.
 */
nickserv {
        /* If you want NickServ to tell people about how great it is, enable the directive
         * below.
         */
        #spam;

        /* no_nick_ownership
         * Enable this to disable nickname ownership (old userserv{ }).
         * This changes changes "nickname" to "account" in most messages,
         * disables GHOST on users not logged in to the same account and
         * makes the spam directive ineffective.
         * It is suggested that the nick be set to UserServ, login.so
         * be loaded instead of identify.so and ghost.so not be loaded.
         */
        #no_nick_ownership;

        /* (*)nick
         * The nickname we want NickServ to have. 
         */
        nick = "NickServ";

        /* user
         * The username we want NickServ to have.
         */
        user = "NickServ";

        /* host
         * The hostname we want NickServ to have.
         */
        host = "services.int";

        /* real
         * The realname (gecos) information we want NickServ to have.
         */
        real = "Nickname Services";

        /* (*)expire
         * The number of days before inactive registrations are expired.
         */
        expire = 30;
};

/* The chanserv { } block defines settings specific to the channel
 * services client on the IRC network.
 */
chanserv {
        /* (*)nick
         * The nickname we want the client to have.
         */
        nick = "ChanServ";

        /* user
         * The username we want the client to have.
         */
        user = "ChanServ";

        /* host
         * The hostname we want the client to have.
         */
        host = "services.int";

        /* real
         * The GECOS of the client.
         */
        real = "Channel Services";

        /* fantasy
         * Do you want to enable fantasy commands? This can
         * use a lot of CPU up, and will only work if you have
         * join_chans (in general) enabled as well.
         */
        fantasy;

        /* (*) ca_xop
         * Defines what flags the xop access levels comprise.
         * These should all be different and not equal to the empty set,
         * except that hop may be equal to vop to disable hop.
         * Each subsequent level should have more flags (except +VHO).
         * For optimal functioning of /cs forcexop, aop should not have
         * any of +sRf, hop should not have any of +sRfoOr and vop should 
         * not have any of +sRfoOrhHt.
         * If this is not specified, the values of Ermyth 0.3 are used,
         * which are generally less intuitive than these.
         * Note: changing these leaves the flags of existing channel access
         * entries unchanged, thus removing them of the view of /cs xop list.
         * Usually the channel founder can use /cs forcexop to update the
         * entries to the new levels.
         */
        vop = "+VA";
        hop = "+vVhHtA";
        aop = "+vhoOtriA";
        sop = "+vhoOtrsifA";

        /* (*) changets
         * Change the channel TS to the registration time when someone
         * recreates a registered channel, ensuring that they are deopped
         * and all their modes are undone. When the channel was not recreated
         * no deops will be done (apart from the SECURE option).
         * This also solves the "join-mode" problem where someone recreates
         * a registered channel and then sets some modes before they are
         * deopped.
         * This is currently supported for charybdis, hybrid, ratbox and
         * bahamut. For charybdis, hybrid and ratbox it only fully works
         * with TS6, with TS5 bans and last-moment modes will still apply.
         * (That can also be used to advantage, when first enabling this.)
         */
        #changets;

        /* (*) trigger
         * This setting allows you to change the trigger prefix for
         * ChanServ's in-channel command feature (disableable via chanserv::fantasy).
         * If no setting is provided, the default is used, which is "!".
         *
         * Other settings you could consider trying: ".", "~", "?", "`", "'".
         */
        trigger = "!";

        /* (*)expire
         * The number of days before inactive registrations are expired.
         */
        expire = 30;

        /* (*)maxchanacs
         * The maximum number of entries allowed in a channel's access list
         * (both channel ops and akicks), 0 for unlimited.
         */
        maxchanacs = 0;

        /* (*)maxfounders
         * The maximum number of founders allowed in a channel.
         * Note that all founders have the exact same privileges and
         * the list of founders is shown in various places.
         */
        maxfounders = 4;
};

/* The global { } block defines settings concerning the global noticer. */
global {
        /* nick
         * Sets the nick used for sending out a global notice.
         */
        nick = "Global";

        /* user
         * Sets the username used for this client.
         */
        user = "Global";

        /* host
         * The hostname used for this client.
         */
        host = "services.int";

        /* real
         * The GECOS (real name) of the client.
         */
        real = "Network Announcements";
};

/* The operserv { } block defines settings concerning the operator service. */
operserv {
        /* nick
         * The nickname we want the Operator Service to have.
         */
        nick = "OperServ";

        /* user
         * Sets the username used for this client.
         */
        user = "OperServ";

        /* host
         * The hostname used for this client.
         */
        host = "services.int";

        /* real
         * The GECOS (real name) of the client.
         */
        real = "Operator Services";
};

/* If you are using SASL, uncomment this */
saslserv {
        /* (*)nick
         * The nickname we want SaslServ to have.
         */
        nick = "SaslServ";

        /* user
         * The username we want SaslServ to have.
         */
        user = "SaslServ";

        /* host
         * The hostname we want SaslServ to have.
         */
        host = "services.int";

        /* real
         * The realname (gecos) information we want SaslServ to have.
         */
        real = "SASL Authentication Agent";
};

/* The httpd { } block defines configuration parameters for the
 * HTTP server.
 */
httpd {
        /* host
         * The host that the HTTP server will listen on.
         * Use 0.0.0.0 if you want to listen on all available hosts.
         */
        host = "0.0.0.0";

        /* www_root
         * The directory that contains the files that should be served by the httpd.
         */
        www_root = "/var/www";

        /* port
         * The port that the HTTP server will listen on.
         */
        port = 8080;
};

/* MemoServ */
memoserv {
        /* (*)nick
         * The nickname we want MemoServ to have.
         */
        nick = "MemoServ";

        /* user
         * The username we want MemoServ to have.
         */
        user = "MemoServ";

        /* host
         * The hostname we want MemoServ to have.
         */
        host = "services.int";

        /* real
         * The realname (gecos) information we want MemoServ to have.
         */
        real = "Memo Services";
};

/* The gameserv { } block defines settings concerning GameServ. */
gameserv {
        /* nick
         * The nickname we want GameServ to have.
         */
        nick = "GameServ";

        /* user
         * Sets the username used for this client.
         */
        user = "GameServ";

        /* host
         * The hostname used for this client.
         */
        host = "services.int";

        /* real
         * The GECOS (real name) of the client.
         */
        real = "Game Services";
};

/*
 * logfile{ } blocks can be used to set up log files other than the master
 * logfile used by services, which is controlled by serverinfo::loglevel.
 *
 * The various logging categories are:
 *      debug, all              - meta-keyword for all possible categories
 *      trace                   - meta-keyword for a little bit of info
 *      misc                    - like trace, but with some more miscillaneous info
 *      notice                  - meta-keyword for notice-like information
 * ------------------------------------------------------------------------------
 *      error                   - critical errors
 *      info                    - miscillaneous log notices
 *      commands                - all command use
 *      admin                   - administrative command use
 *      register                - account and channel registrations
 *      set                     - changes of account or channel settings
 *      network                 - log notices related to network status
 *      rawdata                 - log raw data sent and received by services
 *      wallops                 - <not yet used>
 */

/*
 * This block logs all account and channel registrations and drops,
 * and account and channel setting changes to var/account.log.
 */
logfile "var/account.log" { register; set; };

/*
 * This block logs all command use to var/commands.log.
 */
logfile "var/commands.log" { commands; };

/* The general { } block defines general configuration options. */
general {
        /* (*)chan
         * The channel the client joins and sends certain
         * messages to.
         * Comment to disable.
         */
        chan = "#services";

        /* (*)silent
         * If you want to prevent services from sending
         * WALLOPS/GLOBOPS about things uncomment this.
         * Not recommended.
         */
        #silent;

        /* (*)verbose_wallops
         * If you want services to send you more information about
         * events that are occuring (in particular AKILLs), uncomment the
         * directive below.
         *
         * WARNING! This may result in large amounts of wallops/globops
         * floods.
         */
        #verbose_wallops;

        /* (*)use_privmsg
         * If you want services to send messages via PRIVMSG instead of
         * NOTICE, uncomment this below. This could be useful for networks
         * with WEBTV users and various other improperly designed IRC clients
         * connecting to it, such as flash and java chat clients and IRC
         * clients for the physically handicapped.
         *
         * WARNING! It is against the IRC RFC to respond to PRIVMSG
         * automatically with another PRIVMSG, because it can cause
         * feedback loops between bots and services. You have been warned.
         * Some users may not like this feature very well, it
         * can be rather annoying.
         */
        #use_privmsg;

        /* (*)join_chans
         * Should ChanServ be allowed to join registered channels?
         * This option is useful for the fantasy command set.
         *
         * If enabled, you can tell ChanServ to join via SET GUARD ON.
         *
         * If you use ircu-like ircd (asuka, bircd, undernet), you must
         * leave this enabled, and put guard in default cflags.
         *
         * For ratbox it is recommended to leave it on and put guard in 
         * default cflags, in order that ChanServ does not have to join/part
         * to do certain things. On the other hand, enabling this increases
         * potential for bots fighting with ChanServ.
         *
         * Regardless of this option, ChanServ will temporarily join 
         * channels which would otherwise be empty if necessary to enforce
         * akick/staffonly/close.
         */
        join_chans;

        /* (*)leave_chans
         * Do we leave registered channels after everyone else has left?
         * Turning this off serves little purpose, except to mark "official"
         * network channels by keeping them open, and to preserve the
         * topic and +beI lists.
         */
        leave_chans;

        /* secure
         * Do you want to require the use of /msg <service>@<services host>?
         * Turning this on helps protect against spoofers, but is disabled
         * as most networks do not presently use it.
         */
        #secure;

        /* (*)uflags
         * The default flags to set for usernames upon registration.
         * Valid values are: hold, neverop, noop, hidemail, and none.
         */
        uflags = { none; };

        /* (*)cflags
         * The default flags to set for channels upon registration.
         * Valid values are: hold, secure, verbose, verbose_ops, keeptopic,
         * topiclock, guard and none.
         */
        cflags = { verbose; guard; };

        /* (*)raw
         * Do you want to allow SRAs to use the RAW and INJECT commands?
         * These commands are for debugging. If you don't know how to use them
         * then don't enable them. They are not supported.
         */
        #raw;

        /* (*)flood_msgs
         * Do you want services to detect floods?
         * Set to how many messages before a flood is triggered.
         * If services receives `flood_msgs' within `flood_time' the user will
         * trigger the flood protection.
         * Setting this to zero disables flood protection.
         */
        flood_msgs = 7;

        /* (*)flood_time
         * Do you want services to detect floods?
         * Set to how long before the counter resets.
         * If services receives `flood_msgs' within `flood_time' the user will
         * trigger the flood protection.
         */
        flood_time = 10;

        /* (*)kline_time
         * The default expire time for KLINE's in days.
         * Setting this to 0 makes all KLINE's permanent.
         */
        kline_time = 7;

        /* commit_interval
         * The time between database writes in minutes.
         */
        commit_interval = 5;

        /* (*)default_clone_limit
         * The default clone limit used by operserv/clones.
         */
        default_clone_limit = 5;
};

/* Operator configuration
 * See the PRIVILEGES document for more information.
 * NOTE: All changes apply immediately upon rehash. You may need
 * to send a signal to regain control.
 */
/* (*) Operclasses specify groups of services operator privileges */
operclass "sra" {
        /* You can have multiple privs { } blocks in an oper class.
         * This example uses multiple privs { } blocks to organize the privileges
         * granted to the operclass by category.
         */
        privs = {
                special:ircop;
        };

        privs = {
                user:auspex;
                user:admin;
                user:sendpass;
                user:vhost;
                user:mark;
                user:hold;
                user:regnolimit;
        };

        privs = {
                chan:auspex;
                chan:admin;
                chan:cmodes;
                chan:joinstaffonly;
        };

        privs = {
                general:auspex;
                general:viewprivs;
                general:flood;
                general:metadata;
                general:admin;
        };

        privs = {
                operserv:omode;
                operserv:akill;
                #operserv:massakill;
                #operserv:akill-anymask;
                operserv:jupe;
                operserv:noop;
                operserv:global;
                operserv:grant;
        };

        /* needoper
         * Only grant privileges to IRC users in this oper class if they
         * are opered; other use of privilege (channel succession, XMLRPC,
         * etc.) is unaffected by this.
         */
        needoper;
};

/* The "ircop" operclass specifies privileges all IRCops get.
 * This may be empty in which case IRCops get no privs.
 * At least chan:cmodes, chan:joinstaffonly and general:auspex are suggested.
 */
operclass "ircop" {
        privs = {
                special:ircop;
        };

        privs = {
                user:auspex;
                user:admin;
                user:sendpass;
                user:vhost;
                user:mark;
        };

        privs = {
                chan:auspex;
                chan:admin;
                chan:cmodes;
                chan:joinstaffonly;
        };

        privs = {
                general:auspex;
                general:viewprivs;
                general:flood;
        };

        privs = {
                operserv:omode;
                operserv:akill;
                operserv:jupe;
                operserv:global;
        };
};

/* (*) Operator blocks specify accounts with certain privileges
 * Oper classes must be defined before they are used in operator blocks.
 */
operator "pippijn" {
        operclass = "sra";
};

/* You may also specify other files for inclusion.
 * For example:
 *
 * include "etc/sras.conf";
 */

# vim:ft=c noexpandtab
Revision:	1.2
Committed:	Tue Aug 28 17:08:06 2007 UTC (16 years, 9 months ago) by pippijn
Branch:	MAIN
CVS Tags:	HEAD
Changes since 1.1:	+370 -354 lines
Log Message:	- changed name - updated the example config to the new system - added more documentation - enhanced documentation generators - added a link to the pdf to the website - added an RSS feed generator - transitioned hooks to c++ callbacks - did various merges with upstream along the way - added const where appropriate - removed the old block allocator - fixed most memory leaks - transitioned some dictionaries to std::map - transitioned some lists to std::vector - made some free functions members where appropriate - renamed string to dynstr and added a static string ststr - use NOW instead of time (NULL) if possible - completely reworked database backends, crypto handlers and protocol handlers to use an object factory - removed the old module system. ermyth does not do any dynamic loading anymore - fixed most of the build system - reworked how protocol commands work