Daioikachan

Ikachan compatible interface with multiple backends (IRC, Slack, etc).

Requirements

Ruby

Installation

Write Gemfile:

source "https://rubygems.org"

gem 'daioikachan'

Run:

$ bundle

IRC, Slack backends are bundled as default.

Daioikachan supports plugin architecture. You may add your favirite backends as gems. See Plugin section for details.

How to Run

This is an example to post messages for both IRC and Slack.

Start

Generate a sample daioikachan.conf:

$ bundle exec daioikachan -g daioikachan.conf

Create .env and configure your IRC server and Slack token:

IRC_SERVER=XX.XX.XX.XX
SLACK_API_TOKEN=XXX-XXXXX-XXXXXX-XXXXX

Start daioikachan as

$ bundle exec daioikachan

Test

Test to post a message to #daioikachan channel of both IRC and Slack via daioikachan like:

$ curl -d "channel=#daioikachan&message=test daioikachan" http://localhost:4979/notice

Look whether posting to IRC, and Slack succeeds.

Configuration

See example.conf or multi_slack.conf as examples.

You might've noticed that the config file is similar with Fluentd. Yes, daioikachan is created based on Fluentd. So, you can use routing functions which Fluentd has (tag and label).

See config-file documentation of Fluentd for details.

See following pages for built-in plugins.

If you need other backends, search other fluentd output plugins and add them. Enjoy!

Plugin

You can create and add your own backends for daioikachan as a Fluentd Plugin.

See http://www.fluentd.org/plugins#notifications for available plugins.

API

/notice

Send notice message.

$ curl -d "channel=#channel&message=test message" http://localhost:4979/notice

/privmsg

Send privmsg message.

$ curl -d "channel=#channel&message=test message" http://localhost:4979/privmsg

/join

The server always returns 200, and ignore.

IRC client (fluent-plugin-irc) automatically joins to a channel on sending message. Slack client does not require to join to a channel.

/leave

The server always returns 200, and ignores.

ChangeLog

See CHANGELOG.md for details.

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request