pgkbot

From Meta, a Wikimedia project coordination wiki
Jump to: navigation, search

pgkbot is a Python IRC bot written by pgk to display filtered recent changes to wikis. See CVN/Bots for a list of commands and download instructions.

Download[edit]

  1. Download the latest public version of pgkbot (1.7).
  2. Unzip it to C:\pgkbot.

Installation[edit]

Basic installation - Windows[edit]

The basic installation steps for Windows are currently covered on CVN/Bots.

Basic installation - Unix-based systems[edit]

  • Specific installation steps for twisted, getdate
    • Some distributions (Debian, Ubuntu, etc.) have packages for twisted
    • You might need python-dev

Configuration[edit]

Basic configuration[edit]

Open Config/IRCConsole.conf in a text editor and change the configuration options as necessary. This file configures the IRC client connected to freenode, or another network.

Config/IRCConsole.conf
Field Value Notes
server irc.freenode.net This is the IRC server the bot will connect to
port 6667 The server port to connect to; this value should be fine
nick botnick Change this to the nickname of the bot you want to use (do not use pgkbot)
password password The password to use when identifying. Comment out this line if not using Nickserv
operpassword Your oper password, if you have one. Most people don't; leave this blank if you don't.
owner yournick Change this to your nickname. This gives you full access to the interface.

Do the same for Config/RCReader.conf. This file configures the IRC client connected to the Wikimedia RC -> IRC gateway.

Config/RCReader.conf
Field Value Notes
server irc.wikimedia.org This is the IRC server the bot will connect to to get the RC feed(s).
port 6667 The server port to connect to (this value is fine)
nick yournick Choose a nickname for your bot. Make it unique, but short. Most people will not see this name.

That's all for the global configuration - now you need to set up and configure each wiki you want to monitor.

Wiki configuration[edit]

  • NewLangEx.py (download NewLangEx.*.**.tgz from tools:~tangotango/pgkbot/)
    • Detailed XML schema
    • Don't use NewLang.py!
  • Add to systems.ini

Setting up telnet[edit]

  • Edit systems.ini
  • Use a telnet client

Configuring the bot to report feeds from multiple wikis on a single channel[edit]

  1. #Basic configuration
  2. #Wiki configuration multiple times
  3. #Setting up telnet (or boring method)
  4. Install the patch