https://github.com/devigned/sample-devex-bot
https://github.com/devigned/sample-devex-bot
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/devigned/sample-devex-bot
- Owner: devigned
- License: mit
- Created: 2017-03-22T18:10:48.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-30T22:27:32.000Z (almost 9 years ago)
- Last Synced: 2024-10-05T17:21:26.358Z (over 1 year ago)
- Language: JavaScript
- Size: 25.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sample-devex-bot
sample-devex-bot is a chat bot built on the [Hubot][hubot] framework. It was
initially generated by [generator-hubot][generator-hubot], and configured to be
deployed on [Heroku][heroku] to get you up and running as quick as possible.
This README is intended to help get you started. Definitely update and improve
to talk about your own instance, how to use and deploy, what functionality is
available, etc!
[hubot]: http://hubot.github.com
### Running sample-devex-bot Locally
You can test your hubot by running the following, however some plugins will not
behave as expected unless the [environment variables](#configuration) they rely
upon have been set.
You can start sample-devex-bot 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
sample-devex-bot>
Then you can interact with sample-devex-bot by typing `sample-devex-bot help`.
sample-devex-bot> sample-devex-bot help
sample-devex-bot animate me - The same thing as `image me`, except adds [snip]
sample-devex-bot help - Displays all of the help commands that sample-devex-bot 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 labour
intensive. The following shell command can be used as a stop gap until an
easier way to do this has been implemented.
grep -o 'hubot-[a-z0-9_-]\+' external-scripts.json | \
xargs -n1 -I {} sh -c 'sed -n "/^# Configuration/,/^#$/ s/^/{} /p" \
$(find node_modules/{}/ -name "*.coffee")' | \
awk -F '#' '{ printf "%-25s %s\n", $1, $2 }'
How to set environment variables will be specific to your operating system.
Rather than recreate the various methods and best practices in achieving this,
it's suggested that you search for a dedicated guide focused on your OS.
### Scripting
An example script is included at `scripts/example.coffee`, so check it out to
get started, along with the [Scripting Guide][scripting-docs].
For many common tasks, there's a good chance someone has already one to do just
the thing.
[scripting-docs]: https://github.com/github/hubot/blob/master/docs/scripting.md
### 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][npmjs] 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`.
```json
{
"hubot-fun": [
"crazy",
"thanks"
],
"hubot-auto-deploy": "*"
}
```
**Be aware that not all plugins support this usage and will typically fallback
to including all scripts.**
[npmjs]: https://www.npmjs.com
### hubot-scripts
Before hubot plugin packages were adopted, most plugins were held in the
[hubot-scripts][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.
[hubot-scripts]: https://github.com/github/hubot-scripts
## Adapters
Adapters are the interface to the service you want your hubot to run on, such
as Campfire or IRC. There are a number of third party adapters that the
community have contributed. Check [Hubot Adapters][hubot-adapters] for the
available ones.
If you would like to run a non-Campfire or shell adapter you will need to add
the adapter package as a dependency to the `package.json` file in the
`dependencies` section.
Once you've added the dependency with `npm install --save` to install it you
can then run hubot with the adapter.
% bin/hubot -a
Where `` is the name of your adapter without the `hubot-` prefix.
[hubot-adapters]: https://github.com/github/hubot/blob/master/docs/adapters.md
## Deployment
### Provisioning
To run on Azure AppService Linux provision the following:
$ az group create -n $groupName -l westus
$ az appservice plan create -g $groupName -n botplan -l westus --is-linux
$ az appservice web create -g $groupName -n $webappName
$ az appservice web config container update -c devigned/sallybot
$ az appservice web config appsettings update # (with HUBOT_SLACK_TOKEN, DEVEX_CONN_STRING and REDIS_URL)
### Docker Container Build, Run and Push
$ docker build -t devigned/sallybot .
$ docker run -it -e HUBOT_SLACK_TOKEN=$HUBOT_SLACK_TOKEN \
-e DEVEX_CONN_STRING=$DEVEX_CONN_STRING -e REDIS_URL=$REDIS_URL \
devigned/sallybot
$ docker push devigned/sallybot
$ az appservice web config container update -c devigned/sallybot:latest