https://github.com/cloverinteractive/hubot

Our Github's Hubot repo
https://github.com/cloverinteractive/hubot

Last synced: 4 months ago
JSON representation

Our Github's Hubot repo

• Host: GitHub
• URL: https://github.com/cloverinteractive/hubot
• Owner: cloverinteractive
• Created: 2011-12-09T01:43:18.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2013-09-18T22:31:17.000Z (almost 12 years ago)
• Last Synced: 2025-01-19T17:49:54.476Z (5 months ago)
• Language: CoffeeScript
• Homepage:
• Size: 125 KB
• Stars: 1
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Hubot

=====

This is a version of GitHub's Campfire bot, hubot. He's pretty cool.

This version is designed to be deployed on heroku.

Playing with Hubot

==================

You'll need to install the necessary dependencies for hubot. All of

those dependencies are provided by [npm](http://npmjs.org) except for       

Redis server.    

Ubuntu: ```sudo apt-get install redis-server```     

Then:

    % bin/hubot

You'll see some startup output about where your scripts come from.

    Loading deploy-local scripts at /Users/me/nubot/scripts

    Loading hubot core scripts for relative scripts at /Users/me/nubot/src/hubot/scripts

    Hubot: the Shell.

    { id: '1', name: 'Shell' }

    Loading hubot-scripts from /Users/me/nubot/hubot-scripts.json

    Successfully connected to Redis

Then you can interact with Hubot by typing `hubot help`.

    hubot help

    animate me  - The same thing as `image me`, except adds a few

    convert me  to  - Convert expression to given units.

    help - Displays all of the help commands that Hubot knows about.

    ...

Take a look at the scripts in the `./scripts` folder for examples.

Delete any scripts you think are silly.  Add whatever functionality you

want hubot to have.

Adapters

========

Adapters are now external to the core of hubot, apart from Campfire and Shell.

If you would like to use an external adapter you can edit the `package.json` to

include the adapter package in the `dependencies` then update the `Procfile` to

load the adapter `app: bin/hubot -a  -n hubot` where `` is

the name of the adapter with the `hubot-` prefix.

hubot-scripts

=============

There will inevitably be functionality that everyone will want. Instead

of adding it to hubot itself, you can submit pull requests to

[hubot-scripts](https://github.com/github/hubot-scripts). To enable

scripts from the hubot-scripts package, add the script name with extension as a

double quoted string to the hubot-scripts.json file in this repo.

Deployment

==========

    % heroku create --stack cedar

    % git push heroku master

    % heroku ps:scale app=1

    % heroku addons:add redistogo:nano

If you run into any problems, checkout heroku's [docs](http://devcenter.heroku.com/articles/node-js).

You'll need to edit the `Procfile` to say what the bot's name is.

Hubot also needs three environmental variables set to run and to keep him

running on heroku.

Campfire Variables

------------------

Create a separate user for your bot and get their token from the web UI.

    % heroku config:add HUBOT_CAMPFIRE_TOKEN="..."

Get the numeric ids of the rooms you want the bot to join, comma

delimited. If you want the bot to connect to `https://mysubdomain.campfirenow.com/room/42` 

and `https://mysubdomain.campfirenow.com/room/1024` then you'd add it like this:

    % heroku config:add HUBOT_CAMPFIRE_ROOMS="42,1024"

Add the subdomain hubot should connect to. If you web URL looks like

`http://mysubdomain.campfirenow.com` then you'd add it like this:

    % heroku config:add HUBOT_CAMPFIRE_ACCOUNT="mysubdomain"

Restart the bot

---------------

You may want to get comfortable with `heroku logs` and `heroku restart`

if you're having issues.