an IRC bouncer written in JavaScript for Node.js
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
doc/cli
lib
modules
test
.gitignore
.npmignore
.travis.yml
README.md
config.json.sample
package.json

README.md

Build Status

homura

This is a IRC bouncer written in JavaScript for Node.js. The name "homura" is from madoka which is the IRC bouncer I used first ;)

This project is under DEVELOPMENT. APIs are unstable and some features have not implemented yet.

Synopsis

$ cd homura_workingdir
$ npm install homura
$ vim config.json # see Configuration section
$ ./node_modules/.bin/homura -v

To connect to homura with your IRC client, use the host and the port configured in config.json. You have to set the IRC user name like USERNAME@BOUNCERNAME. (e.g. akemi@freenode or akemi@ircnet )

USERNAME is an actual user name for IRC networks, and BOUNCERNAME is a name that homura uses to decide which IRC network connect to.

Install

$ npm install -g homura

Configuration

homura uses a JSON format configuration file.

The default path of the configuration file is config.json of current directry that homur is running on, and you can also specify config.json by using --config option.

$ homura --config /path/to/your_config.json

config.json defines options below:

  • host (required) : Host the client should connect to homura
  • port (required) : Port the client should connect to homura
  • password (optional) : Password that is required to connect to homura
  • tls (optional) : With this option, the client should connect to homura using TLS. The passed Object should be used for tls.createServer options directry. For key, cert, ca and pfx options, you can pass the file path by appending _file to the option name like key_path.
  • bouncers (required) : An Array of IRC bouncer settings.
    • name (required) : name to identify network. You can connect this network with USERNAME@{name}
    • host (required) : IRC server host
    • port (required) : IRC server port
    • nick (required) : IRC nick
    • user (optional) : IRC user. Default is the same as the nick
    • real (optional) : IRC real name. Default is the same as the nick
    • encoding (optional) : The character encoding used on this IRC network. Default is UTF-8
    • tls (optional) : With this option, homura makes the connection to IRC network using TLS. The passed Object should be used for tls.connect options directry. For key, cert, ca and pfx options, you can pass the file path by appending _file to the option name like key_path.

config.json (sample)

{
    "host" : "localhost",
    "port" : 6667,
    "password" : "YOURPASSWORD",
    "tls" : {
        "key_file"  : "/absolute/path/to/your/privatekey.pem",
        "cert_file" : "/absolute/path/to/your/cetificate.pem",
        // and you can put tls.createServer options here.
    },
    "bouncers" : [
        {
            "name"     : "freenode",
            "host"     : "hubbard.freenode.net",
            "port"     : 7000,
            "nick"     : "YOURNICK",
            "user"     : "YOURUSER",
            "real"     : "YOURNAME",
            "encoding" : "UTF-8",
            "tls"      : {
              "ca_file"  : "/absolute/path/to/your/ca.pem",
              // and you can put tls.connect options here.
            }
        },
        {
            "name"     : "ircnet",
            "encoding" : "ISO-2022-JP",
            "host"     : "irc.media.kyoto-u.ac.jp",
            "port"     : 6667,
            "nick"     : "YOURNICK",
            "user"     : "YOURUSER",
            "real"     : "YOURNAME",
        }
    ],
    "modules" : [
        {
            "name" : "log",
            "dir"  : "/path/to/logs"
        },
        {
            "name" : "log-buffer",
            "size" : 100
        },
        {
            "name" : "auto-join",
            "channels" : {
                "freenode" : [ "#autojoinchan1 passwordchan1", "#autojoinchan2" ],
                "ircnet"   : [ "#autojoinchan3" ]
            }
        },
        {
            "name" : "auto-reply"
        },
        {
            "name" : "auto-away",
            "message" : "oh I'm away from a keyborad"
        },
        {
            "name" : "away-nick",
            "awayNick" : "YOURNICK_AWAY"
        },
        {
            "name"     : "auto-nickserve-identify",
            "passwords" : {
                "freenode" : "PASSWORD"
            }
        }
    ]
}

Run

Start the homura with config.json in current directory.

$ homura

or specify config.json by --config option.

$ homura --config /path/to/your_config.json

Please specify -v or --verbose options to see what the homura is doing. --debug may be too noisy (prints the same IRC messages 4 times...) .

$ homura -v
$ homura --debug

Modules

Modules are placed under modules directory. You can enable modules and can pass options to modules in config.json. Please see Configuration section.

log

Writes out logs to files.

Options

  • dir : Directory to save log files in
  • format : Format of the log filename (e.g. {bouncer}-{channel}-{year}{month}{date}.log )

log-buffer

Buffres conversation logs for each target (channel or user), and sends logs as notice when you connect to homura.

Options

  • size : Buffer size of logs

auto-join

Joins to specified channels when homura has connected to network.

Options

  • channels : Object that maps network-name-key to Array of channel name to join.

auto-reply

Replies a message automatically while you are not connected to homura.

Options

  • message : Message to reply

auto-away

Sends AWAY message automatically when all clients disconnected.

Options

  • message : AWAY message

away-nick

Changes nick automatically when you AWAY

Options

  • awayNick : Nick name when you are AWAY

auto-nickserve-identify

Send NickServe Identify command automatically at start of connection

Options

  • passwords : Object that contains bouncer name and password pairs.

Author

  • @hakobe

License

Licensed under the MIT License