User:SPCUClerkbot/documentation

Checkuserbot is in current development.

Config commands

These can be done by sending it the command "!config set <command> <value>" where command is one of the bolded items below and value is a sensible value. Please note that <command> may be referred to as a "key" in the instructions below.

Array values

If there is more then one value in the variable, (The bot will tell you) you need to use the command !config set <command> <add|del> <value>. Please do not execute this on an item where there is only one value unless the list below tells you it is ok.

!config set <key> <add|del> <value>
- Command to modify keys that store an array of values.

Other interesting config commands

!config save -- Saves the configuration file to disk, don't do this unless you know the changes you made are good as it may be difficult to undo. (ie you may have to wait for me to fix it by manually editing it's config file). Restricted to group admin_hosts.
!config reload -- Loads the config file. This is a safe command, if you did something you want to undo, this loads the config file from disk and resets everything to the last prior saved state. Restricted to group admin_hosts.
!config get <key> -- Displays in IRC the contents of a config value. This is useful for seeing who has access, and exploring the config settings. Not restricted to any group
!config key <new key> <add|del> <value> -- This is primarally for developer use, a new value added by a user won't be taken advantage of by the program. How it works is when "new key" is added, it also adds the value you specify as an initial value. When a key is deleted, it just removes the key ignoring the value parameter. Restricted to group developer_hosts.

List of current keys

wikimedia_channel - What channel it joins on the wikimedia rc server. This should be left at en.wikipedia. You may change this to an array value by by following the instructions at #Array values. Doing so tells the bot to join more then one channel on the wikimedia server.
freenode_channel - What channel it joins on the freenode network. This is the checkuser clerk channel. You may change this to an array value by by following the instructions at #Array values. Doing so tells the bot to join more then one channel on the freenode server.

Access system related

admin_hosts - Admins are considered to be anyone permitted to edit the configuration files. Normal users will be allowed to query the bot, but won't be allowed to change any of the configuration files or settings. Admins can add or remove other admins by following the instructions listed at #Array values.
- These values are the irc hostmask. You can see these by typing /whois <irc nick>, and looking for the output from nickserv: it should look like "=== nixeagle <i=something@Wikimedia/Nixeagle> “Wilhelm”" where the bolded portion is the part you want to add to the array for the bot.
developer_hosts - An array of hosts that are accepted by the bot as developers. This is used by the bot to limit commands that are useful only for developing to developers only as some of those commands can be annoying/hard to fix if used wrongly.

Developer config

The following values are probably not that interesting to change as a user of the bot. Please don't change these values unless you are actively debugging/programming the bot.

In the future these may be limited by access control to specific users, but for the time being its on the honor system.

wikimedia_flood - Instructs the bot to act as a repeater from irc.wikimedia.org to irc.freenode.org. There are two valid settings: 0 and 1. The default is 0. Changing this value to 1 will cause the bot to flood any and all channels it is in on freenode.