supbot

KO | EN

gitlite — search

#hacktoberfest #ai #typescript #go #android #rust #deep-learning #docker #macos #awesome #cli #vue #pytorch #open-source

(★ 20)

Simple slack bot powered deployment tool with Sup

supbot Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# supbot

> Sup... Slack?

## What is Sup?

[Sup](https://github.com/pressly/sup) let's you execute commands on remote
machines based on predefined and simple rules.

## What is Supbot?

Supbot is a [Slack](https://www.slack.com) bot that listens to Sup commands.

You can easily monitor, deploy, bring-up, bring-down, tail logs... on any
environment, across any network directly from your Slack channel.

You can do anything Sup can do, directly from Slack.

![screen shot 2016-01-24 at 3 27 42 pm](https://cloud.githubusercontent.com/assets/385670/12538719/1a5c1f48-c2af-11e5-94d9-0be574897f67.png)

How about using a remote network and not only the local one? Yes:

![screen shot 2016-01-24 at 4 01 04 pm](https://cloud.githubusercontent.com/assets/385670/12538901/cee918b8-c2b3-11e5-9974-b4f8a68fea46.png)

## Checking out the repo

```
cd ~/projects
git checkout https://github.com/gophergala2016/supbot.git
```

## Obtaining a Slack token

Your deployment of the Slack bot will require a Slack bot token. This token will need to be set to the `SLACK_TOKEN` environment variable.

To obtain this token, you will need to sign into Slack and request a custom bot integration for your team's subdomain. At the time of writing (Jan 24 2016), you can start this process at the following URL:

`https://[your-team-subdomain].slack.com/apps/build/custom-integration`

## Deploying to a server

You can use `sup` to deploy to a server as defined in the `Supfile`.

```
# This is a portion of the supfile
networks:
  ...
  prod:
    hosts:
      - deploy@162.243.9.244
```

```
make deploy
```

If you want to try it locally, use `make docker` to build the docker image,
then use `make docker-run` to run this server locally.

```
SLACK_TOKEN=yyy make docker-run
```

## Deploying to Heroku

```sh
$ heroku create
$ git push heroku master
$ heroku open
```
or

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

Make sure to set your `SLACK_TOKEN` env variable

```sh
$ heroku config:set SLACK_TOKEN=xxx-xxyz-xxzy

Setting config vars and restarting xxxx... done
SLACK_TOKEN: xxx-xxyz-xxzy

$ heroku config
=== xxxx Config Vars
SLACK_TOKEN: xxx-xxyz-xxzy
```

Some pointers:

- you might need to run `heroku ps:scale worker=1` to scale dyno manually

supbot

supbot Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

supbot

supbot Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README