Page MenuHomePhabricator

EyeInTheSky
Updated 407 Days AgoPublic

Installation

  1. Download the latest binaries from the project page: EyeInTheSky
  2. Extract the archive to an empty folder
  3. Configure the bot by editing configuration.xml
  4. (optional) Configure logging by editing the file log4net.xml
  5. Launch EyeInTheSky.exe

Configuration

For the most part, the comments within configuration.xml should be self-explanatory, because I'm lazy and I don't want to have to update this page very often.

The key parts you need to know -

  • Four general things to configure - the bot itself, the listening IRC network, the reporting IRC network, and the email server.
    • Bot
      • Channels to join on each network
      • A prefix to all commands - commonly ! but I use =, as does this documentation.
      • A path to the configuration file for users - this doesn't need to exist as it is managed by the bot.
      • A path to the configuration file for channels - this doesn't need to exist as it is managed by the bot.
      • A path to the configuration file for the stalk templates - this doesn't need to exist as it is managed by the bot.
      • The full mask of the RC user to listen to
      • The owner of the bot (full mask needed)
      • The format for displaying dates
      • The MediaWiki (aka Wikipedia) API endpoint to use. The default is then English Wikipedia.
      • The user agent string to use when talking to web services. It's very good practice to put your contact details here
      • A URL to the privacy policy for the bot.
    • IRC networks (two of these)
      • Most of this should be self-explanatory.
      • Notably, clientName is just a name for logging and reporting.
      • username is used both as the ident field, and the NickServ username if authToServices is set.
      • password is the NickServ password, not the server password.
    • Email
  • #{name} style values reference properties from the top section
  • The location of the configuration.xml file can be changed, pass the new location as the first command line parameter. This helps with upgrades, as your config can be held outside the application directory at a location of your choosing. As the stalk and template config locations are also specified in the configuration file, these are able to be moved outside the application directory.

Commands

Main article: Commands

Access control

Access control is done on a flag system. There are seven flags available - three are technical can be ignored for most purposes.

  1. Owner (+O). Can only be granted globally, and is granted automatically to the user listed in the configuration file. Grants full access to all bot features and data. Anyone with this role has the ability to see stalks and channels which they might be forbidden from entering.
  2. Global admin (+A). Can only be granted globally. The most powerful role beneath owner, this flag grants the ability to control all flags globally, and locally in any channel the user can enter. This also allows the user to perform user maintenance tasks, such as deleting a user account or removing a registered email address from an account. Global admin grants the ability to see all channels, but not the channel configuration, nor the ability to subscribe to a channel or a stalk. It also does not grant the ability to configure stalks, but it is possible for users with this flag to grant themselves that ability locally if they can enter the channel
  3. Channel join (+J). Can only be granted globally. Allows joining the bot to new channels. Local admin and local configuration access is granted automatically on any channels joined with this right.
  4. Local admin (+a). Can only be granted locally, and is automatically granted to channel operators. Allows management of local flags, and the ability to remove the bot from the channel. It does not grant the ability to configure stalks, but it is possible for users with this flag to grant themselves that ability. It does allow the user to see a channel and it's configuration.
  5. Configuration (+C). Can be granted either globally or locally, and is automatically granted locally to channel operators. Allows the modification of stalk configuration in the channel in which it is granted, or all visible channels if granted globally.
  6. User (+u). Cannot be granted, but applies to every user registered with NickServ automatically.
  7. Standard (+S). Cannot be granted, but applies to everybody automatically.

For the most part, this means access is in three sections - who can manage access (+A, +a, and to some extent +J), who can change settings (+C), and everyone else

Edit Flags

For the flag-based stalks, this is a description of some of the flags:

!    - unreviewed
M    - minor
N    - new
B    - bot
move - move

Templates

Templates can be defined in the template configuration file.

In version 2.2, the "acc" and "quick" commands were removed, due to the expectation that these would be replaced by templates. The relevant configuration for these is listed below:

<template flag="acc" description="ACC {0}: {1}" stalkflag="acc{0}" immediatemail="true"
          stalkenabled="true" templateenabled="true" expiryduration="P90D">
  <searchtree>
    <![CDATA[<or><user value="{1:R}" /><page value="{1:R}" /><summary value="{1:R}" /></or>]]>
  </searchtree>
</template>
<template flag="quick" immediatemail="true" stalkenabled="true" templateenabled="true" 
          expiryduration="P90D">
  <searchtree><![CDATA[<{0} value="{1:R}" />]]></searchtree>
</template>

The attributes available are:

  • flag - the identification tag for this template. Also acts as the command name for instantiating an instance of this template.
  • description - the default description for an instance of this template. Accepts parameters in the form {0}, {1}, etc.
  • stalkflag - if set, a default pattern for the flag of the stalk. Accepts parameters in the form {0}, {1}, etc.
  • stalkenabled - the default value for the enabled attribute on the stalk.
  • templateenabled - whether or not to register this template as a command to allow instantiation
  • expiryduration - a time duration in ISO 8601 format.

Within the template should be a string representing the XML search tree of the stalk. Accepts parameters in the form {0}, {1}, etc. Beware of regular expressions - use the format {0}, {1}, etc to escape the content of the parameter into a form which will match a regular expression.

Last Author
stwalkerster
Last Edited
Aug 16 2019, 11:54 PM

Event Timeline

stwalkerster created this document.Mar 3 2018, 11:26 PM
stwalkerster edited the content of this document. (Show Details)
stwalkerster added a project: EyeInTheSky.
stwalkerster edited the content of this document. (Show Details)Mar 17 2018, 1:12 AM
stwalkerster edited the content of this document. (Show Details)Mar 17 2018, 1:19 PM
stwalkerster edited the content of this document. (Show Details)Mar 17 2018, 2:19 PM
stwalkerster edited the content of this document. (Show Details)Apr 23 2018, 7:51 PM
stwalkerster edited the content of this document. (Show Details)Jul 3 2018, 10:43 PM
stwalkerster edited the content of this document. (Show Details)Jul 4 2018, 12:08 AM
stwalkerster edited the content of this document. (Show Details)Aug 16 2019, 9:43 PM
stwalkerster edited the content of this document. (Show Details)Aug 16 2019, 11:54 PM