hubot/README.md

   1 This image has a custom [hubot][] with the [hubot-irc][] adapter and a
   2 number of [scripts][] installed out of the box:
   3
   4 * [github-commit-link][]
   5 * [github-commits][]
   6 * [github-issue-link][]
   7 * [github-issues][]
   8 * [github-pull-request-notifier][]
   9 * [github-logger][]
  10
  11 It's also easy to [write your own scripts][scripting].
  12
  13 Run this [hubot][] image with:
  14
  15     $ docker run -d --name hubot-0 \
  16     >   -e HUBOT_IRC_NICK="myhubot" \
  17     >   -e HUBOT_IRC_USESSL="true" \
  18     >   -e HUBOT_IRC_SERVER="irc.freenode.net" \
  19     >   -e HUBOT_IRC_PORT="6697" \
  20     >   -e HUBOT_IRC_ROOMS="#my-channel, #my-other-channel" \
  21     >   -e HUBOT_IRC_UNFLOOD="200" \
  22     >   -e HUBOT_GITHUB_USER="github" \
  23     >   -e HUBOT_GITHUB_REPO="github/hubot" \
  24     >   -e LOG_HTTP_USER="logs" \
  25     >   -e LOG_HTTP_PASS="changme" \
  26     >   -e LOG_HTTP_PORT=8000" \
  27     >   --link redis-0:redis \
  28     >   -p 80:80 \
  29     >   -p 8000:8000 \
  30     >   wking/hubot
  31
  32 If your IRC server requires a server-wide password, you can set
  33 `HUBOT_IRC_PASSWORD`.
  34
  35 The [link][] to `redis-0` is for the default [redis-brain][] script.
  36 You should be able to link to any Redis server, but this Dockerfile
  37 repository already [provides one][redis].
  38
  39 If you want the GitHub scripts to be able to access private
  40 repositories (e.g. to link to private issues or commits), you need to
  41 set `HUBOT_GITHUB_TOKEN` to your [OAuth token][token].
  42
  43 If things aren't working as you'd expect, you can crank up the logging
  44 with `HUBOT_LOG_LEVEL=debug` (see [robot.coffee][]).
  45
  46 [hubot]: https://github.com/github/hubot
  47 [hubot-irc]: https://github.com/nandub/hubot-irc
  48 [scripts]: https://github.com/github/hubot-scripts/tree/master/src/scripts
  49 [github-commit-link]: https://github.com/github/hubot-scripts/blob/master/src/scripts/github-commit-link.coffee
  50 [github-commits]: https://github.com/github/hubot-scripts/blob/master/src/scripts/github-commits.coffee
  51 [github-issue-link]: https://github.com/github/hubot-scripts/blob/master/src/scripts/github-issue-link.coffee
  52 [github-issues]: https://github.com/github/hubot-scripts/blob/master/src/scripts/github-issues.coffee
  53 [github-pull-request-notifier]: https://github.com/github/hubot-scripts/blob/master/src/scripts/github-pull-request-notifier.coffee
  54 [github-logger]: https://github.com/jenrzzz/hubot-logger
  55 [scripting]: https://github.com/github/hubot/blob/master/docs/scripting.md
  56 [link]: http://docs.docker.io/en/latest/use/port_redirection/#linking-a-container
  57 [redis-brain]: https://github.com/github/hubot-scripts/blob/master/src/scripts/redis-brain.coffee
  58 [redis]: ../redis/
  59 [token]: https://help.github.com/articles/creating-an-access-token-for-command-line-use
  60 [robot.coffee]: https://github.com/github/hubot/blob/master/src/robot.coffee