Paul

Paul is a chat bot built on the Hubot framework. It was initially generated by generator-hubot, and hacked together to be deployed with docker.

Running Paul Locally

You can test your hubot by running the following, however some plugins will not behave as expected unless the environment variables they rely upon have been set.

You can start paul locally by running:

% bin/hubot

You'll see some start up output and a prompt:

[Sat Feb 28 2015 12:38:27 GMT+0000 (GMT)] INFO Using default redis on localhost:6379
paul>

Then you can interact with paul by typing paul help.

paul> paul help
paul animate me <query> - The same thing as `image me`, except adds [snip]
paul help - Displays all of the help commands that paul knows about.
...

Configuration

A few scripts (including some installed by default) require environment variables to be set as a simple form of configuration.

Each script should have a commented header which contains a "Configuration" section that explains which values it requires to be placed in which variable. When you have lots of scripts installed this process can be quite labor intensive.

Put environment variables into the .env file, which can be pulled in by docker.

Scripting

An example script is included at scripts/personality.js, so check it out to get started, along with the Scripting Guide.

For many common tasks, there's a good chance someone has already one to do just the thing.

external-scripts

There will inevitably be functionality that everyone will want. Instead of writing it yourself, you can use existing plugins.

Hubot is able to load plugins from third-party npm packages. This is the recommended way to add functionality to your hubot. You can get a list of available hubot plugins on npmjs.com or by using npm search:

% npm search hubot-scripts panda
NAME             DESCRIPTION                        AUTHOR DATE       VERSION KEYWORDS
hubot-pandapanda a hubot script for panda responses =missu 2014-11-30 0.9.2   hubot hubot-scripts panda
...

To use a package, check the package's documentation, but in general it is:

1. Use npm install --save to add the package to package.json and install it
2. Add the package name to external-scripts.json as a double quoted string

You can review external-scripts.json to see what is included by default.

Advanced Usage

It is also possible to define external-scripts.json as an object to explicitly specify which scripts from a package should be included. The example below, for example, will only activate two of the six available scripts inside the hubot-fun plugin, but all four of those in hubot-auto-deploy.

{
  "hubot-fun": [
    "crazy",
    "thanks"
  ],
  "hubot-auto-deploy": "*"
}

Be aware that not all plugins support this usage and will typically fallback to including all scripts.

hubot-scripts

Before hubot plugin packages were adopted, most plugins were held in the hubot-scripts package. Some of these plugins have yet to be migrated to their own packages. They can still be used but the setup is a bit different.

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.

Persistence

If you are going to use the hubot-redis-brain package (strongly suggested), you will need to bug Brian to add it 😄

Deployment

Ping Brian to update and redeploy the docker container.

Build the docker image

docker build --tag=paul .

Run the docker image

docker run --env-file .env --name paul paul

Or even better, if the docker host is on linux, sync the time!

docker run --env-file .env -v /etc/localtime:/etc/localtime:ro --name paul paul