Menu

Home

Chris Robichaud

This tool was originally written to replace the massive amounts of email sent out by automated build scripts. After setting up your server, your build scripts can simply use a HTTP Post (via a command-line tool such as curl) to submit events. There is also a web interface where events can be submitted manually.

Developers, release engineers, project managers or other interested users can subscribe to the RSS feed to receive updates, instead of receiving an email for each event. This removes the need for IT / Ops to manage adding and removing users from email distribution lists. Once you create a feed, any users who are interested in that feed simply subscribe with any RSS client. When they are no longer interested, they unsubscribe.

It is trivial to add a new feed, and using http to submit events means that firewalls are (usually) not a concern.

Webserver setup

  1. Set up a linux server (physical or VM)
  2. Install apache and php
  3. Copy files into your web root (usually /var/www/html)
  4. You may need to create the feeds directory {web root}/feeds

Build server setup

  1. Make sure you can access {server ip}/index.php in a browser
  2. Create a new feed through the web interface (or skip to {server ip}/add_new_feed.php)
  3. Modify your build script or other event to use the curl command
    • curl -d "feed={feed_name}&title={subject}&description={description}" http://{server ip}/submit_event.php > /dev/null 2>&1
  4. Alternatively, you can also submit events using the web interface, just visit {server ip} in a browser

Client setup

  1. Once feed is created, subscribe to http://{server ip}/feeds/{feed name}/feed.xml with any RSS client

If you have questions or problems, post in the forums