irc.md

December 13, 2018 · View on GitHub

IRC notifier

This notifier sends notifications to an IRC channel using the carrier-pigeon gem.

Usage

Just add the carrier-pigeon gem to your Gemfile:

gem 'carrier-pigeon'

To configure it, you need to set at least the 'domain' option, like this:

Rails.application.config.middleware.use ExceptionNotification::Rack,
                                        email: {
                                          email_prefix: '[PREFIX] ',
                                          sender_address: %{"notifier" <notifier@example.com>},
                                          exception_recipients: %w{exceptions@example.com}
                                        },
                                        irc: {
                                          domain: 'irc.example.com'
                                        }

There are several other options, which are described below. For example, to use ssl and a password, add a prefix, post to the '#log' channel, and include recipients in the message (so that they will be notified), your configuration might look like this:

Rails.application.config.middleware.use ExceptionNotification::Rack,
                                        irc: {
                                          domain: 'irc.example.com',
                                          nick: 'BadNewsBot',
                                          password: 'secret',
                                          port: 6697,
                                          channel: '#log',
                                          ssl: true,
                                          prefix: '[Exception Notification]',
                                          recipients: ['peter', 'michael', 'samir']
                                        }