Skip to content
Slack integrated bot which provides documentation and playbook based on keywords
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
screenshots
.gitignore
.travis.yml
Gopkg.lock
Gopkg.toml
LICENSE
README.md
dbopts.go
helpText.go
manifest.yml
slackMisc.go
slackParse.go
supportBot.go
tagCache.go

README.md

Acorn-Project Build Status

Acorn is a slackbot which links resources and support channels to relevant keywords

Usage

Using Acorn is easy! Simply send a message in any channel or private message with the bot, alerting the bot with it's name, and it will search the database for relevant information:

alt text

The component channels and playbooks should be populated and maintained by the product owner, but users can add tags by simply marking the appropriate channel with new tags:

alt text

The tag will immediately show up in future queries:

alt text

Of course, a help message is available just by typing "help" or "@Acorn help":

alt text

Behind the scenes

Acorn is written completely in Golang and runs on Pivotal Cloud Foundy. nlopes' slack is used to interface with the Slack API.

A Postgres database is used for backing storage, but all tags are loaded into an in-memory cache at application start to avoid database calls in general usage. This greatly improves performance.

Fuzzy logic for keyword matching, using the levenshtein distance, allows the bot to handle mispellings of keywords.

Contributing

Feel free to fork and submit pull requests, or submit issues and feature requests.

You can’t perform that action at this time.