THIS PROJECT HAS MOVED

Please see https://github.com/threatsimple/smug-broker for the latest version.

This is here for historical purposes only.

 ___ _ __ ___  _   _  __ _ 
/ __| '_ ` _ \| | | |/ _` |
\__ \ | | | | | |_| | (_| |
|___/_| |_| |_|\__,_|\__, |
                     |___/ 

smug

Want to mirror everything from one irc to another with ease?

Want to proxy everything from a slack channel to an irc channel?

Want to proxy everything from a slack channel to an external RESTful api?

Broker communications between irc, slack, other services.

quickstart

To connect a slack channel to irc, set some environment variables and then run the docker command.

export SMUG_IRC_SERVER="irc.example.com:6667"
export SMUG_IRC_CHANNEL="#my_chan"
export SMUG_SLACK_TOKEN="xoxo-blah"
docker run -e SMUG_IRC_SERVER,SMUG_IRC_CHANNEL,SMUG_SLACK_TOKEN threatsimple/smug:latest

Note - getting a slack token requires creating an integration. It's simple but can seem daunting. We'll write a doc about that shortly.

usage

Download a release or build as documented below.

Copy the smug.yaml.template file to smug.yaml. Edit the file to set your connection parameters and keys.

Run like the following:

$ ./smug -conf=smug.yaml

See doc/config.md for more configuration details.

building

Assuming golang version 1.12+ installed, you can do the following:

$ cd $GOPATH/src
$ git clone https://github.com/nod/smug
$ cd smug
$ make test
$ make

If all goes well, this should create a build/smug as a compiled binary at that point.