💬 simple real-time irc logbot crafted with coffea
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.meteor
client
packages/npm-container
public
server
.gitignore
README.md
main.js
packages.json

README.md

logbot

simple real-time irc logbot crafted with coffea

logbot screenshot

Setup

  • Install meteor (run curl https://install.meteor.com/ | sh on OS X and Linux)
  • Download logbot via zip from github (or run git clone https://github.com/caffeinery/logbot)
  • Change into the directory (run cd logbot)
  • Create a settings.json file (see Configuration section below)
  • Run logbot via meteor --settings settings.json
  • Access http://localhost:3000 to see the logs in real-time

Configuration

The contents of the settings.json file are passed directly to coffea. Make sure to specify a network name or it'll have an automatically generated id like 0. A random nickname will be generated unless specified.

{
  "name": "test",
  "host": "192.168.99.100",
  "port": 32782,
  "channels": ["#foo", "#bar", "#baz"]
}

Multiple networks can be specified too:

[
  {
    "name": "test",
    "host": "192.168.99.100",
    "port": 32782,
    "channels": ["#foo", "#bar", "#baz"]
  },
  {
    "name": "freenode",
    "host": "chat.freenode.net",
    "port": "6667",
    "channels": ["#caffeinery"]
  }
]

A limit (default: 25) can be specified:

{
  "public": {
    "limit": 10,
  },
  "networks": [
    {
      "name": "test",
      "host": "192.168.99.100",
      "port": 32782,
      "channels": ["#foo", "#bar", "#baz"]
    },
    {
      "name": "freenode",
      "host": "chat.freenode.net",
      "port": "6667",
      "channels": ["#caffeinery"]
    }
  ]
}

Note: If networks is defined in the config, it will be used as network configuration instead of using the whole config.

Special Thanks

Special thanks to dannvix (https://github.com/dannvix/Logbot) for inspiration and jasonodoom for sharing this project with me.