https://github.com/keybase/hubot-keybase
A Hubot adapter for Keybase bot development
https://github.com/keybase/hubot-keybase
Last synced: 16 days ago
JSON representation
A Hubot adapter for Keybase bot development
- Host: GitHub
- URL: https://github.com/keybase/hubot-keybase
- Owner: keybase
- License: other
- Created: 2019-05-31T17:47:29.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-26T11:06:55.000Z (about 1 year ago)
- Last Synced: 2024-09-18T10:04:46.008Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 38.1 KB
- Stars: 11
- Watchers: 16
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hubot-keybase
Hubot adapter for Keybase Chat.
## Building a bot
```bash
mkdir mybot
cd mybot
yo hubot # choose the "keybase" adapter
# Set the desired environment variables
./bin/hubot -a keybase
```
## Configuration
All of `hubot-keybase` configuration is done using environment variables.
In local development, the following can be set in an `.env` file. Using
that approach in production is not recommended, as paper keys should be
kept a secret.
| Env variable | Description |
|------------------|-------------|
| `KB_USERNAME`* | If passed, a new Keybase service will be spawned using the passed username. |
| `KB_PAPERKEY`* | If passed, a new Keybase service will be spawned using the passed paper key. |
| `KB_UNFURL_MODE` | If set, [unfurling mode](#unfurling) will be changed to the passed value. |
\* If you don't set either `KB_USERNAME` or `KB_PAPERKEY` the adapter will
try to attach to an already running Keybase service. This might be
desirable if you require support for features such as exploding messages.
## Unfurling
In Keybase, unfurling means generating previews for links that you're
sending in chat messages. If the mode is set to `always` or the domain in
the URL is present on the whitelist (which is not configurable using
`hubot-keybase`), the Keybase service will automatically send a preview
to the message recipient in a background chat channel.
This is incredibly useful for all sorts of Hubot plugins, as nearly every
single script expects the chat software to automatically unfurl links.
That being said, this feature also has quite a few caveats, most
importantly it might leak the IP address of the server running Hubot.