https://github.com/hakobera/redashbot

Slack Bot for re:dash
https://github.com/hakobera/redashbot

Last synced: about 1 month ago
JSON representation

Slack Bot for re:dash

• Host: GitHub
• URL: https://github.com/hakobera/redashbot
• Owner: hakobera
• Created: 2016-09-12T05:29:30.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-08-23T11:08:06.000Z (over 7 years ago)
• Last Synced: 2024-04-14T09:15:54.173Z (8 months ago)
• Language: JavaScript
• Size: 9.93 MB
• Stars: 68
• Watchers: 1
• Forks: 50
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Slack Bot for re:dash

This is slack bot for [re:dash](https://redash.io).

## Features

- Take a screen capture of visualization

  - Bot can handle message format like `@botname `

    - example: `@redashbot https://your-redash-server.example.com/queries/1#2`

![screenshot.png](./images/screenshot.png)

## How to develop

Clone this repository, then

```bash

$ npm install

$ export REDASH_HOST=https://your-redash-server.example.com

$ export REDASH_API_KEY=your-redash-api-key

$ export SLACK_BOT_TOKEN=your-slack-bot-token

$ node index.js

```

## How to deploy to Heroku

You can easy to deploy redashbot to Heroku, just click following button.

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

## Environment variables

### SLACK_BOT_TOKEN (required)

Slack's Bot User Token

### REDASH_HOST and REDASH_API_KEY (optional)

Re:dash's URL and its API Key.

## REDASH_HOST_ALIAS (optional)

Re:dash' URL accessible from the bot.

### REDASH_HOSTS_AND_API_KEYS (optional)

If you want to use multiple Re:dash at once, specify this variable like below

```

REDASH_HOSTS_AND_API_KEYS="http://redash1.example.com;TOKEN1,http://redash2.example.com;TOKEN2"

```

or if you need to specify REDASH_HOST_ALIAS for each Re:dash, like below

```

REDASH_HOSTS_AND_API_KEYS="http://redash1.example.com;http://redash1-alias.example.com;TOKEN1,http://redash2.example.com;TOKEN2"

```

### SLACK_MESSAGE_EVENTS (optional)

Message events this bot reacts.

Available values are listd in https://github.com/howdyai/botkit/blob/master/readme-slack.md#message-received-events

Its default is *direct_message,direct_mention,mention*