README
¶
Flottbot
Flottbot is a chatbot framework written in Go. But there's a catch, you don't need to know a lick of Go! Configure your bot via YAML files, extend functionality by writing scripts in your favorite language.
The philosophy behind flottbot is to create very simple, lightweight, "dumb" bots that interact with APIs and scripts which house a bot's business logic. The word flott comes from the German word meaning quick/speedy.
Installation
Using go
$ go get -u github.com/target/flottbot/cmd/flottbot
Binaries
Binaries for Linux, macOS, and Windows are available as Github Releases.
Docker Images
We currently provide a few Docker images:
target/flottbot - Alpine image and flottbot binary installed
target/flottbot:ruby - Alpine image, flottbot binary, and ruby v3.2 installed
target/flottbot:golang - Alpine image, flottbot binary, and golang v1.22 installed
target/flottbot:python - Alpine image, flottbot binary, and python v3.11 installed
Note: We highly recommend pinning your image to a version, ie. target/flottbot:0.10.0 or target/flottbot:ruby-0.10.0
Note: The images run with the unprivileged flottbot user (uid/gid 900) by default
Helm Chart
To install using the Helm chart located in this repo, clone this repo, create Kubernetes secrets for your Slack Token and Slack App Token in your namespace & install the chart:
$ helm install helm/flottbot/
Available remotes
| Remote | Status | Documentation |
|---|---|---|
| Slack | ✔ | Docs |
| Discord | 🚧 | Docs |
| Google Chat | 🚧 | Docs |
| Telegram | 🚧 | coming soon |
✔ = Done 🚧 = in progress (functional but some features may not work)
Documentation
For installation and usage, please visit the flottbot docs
For questions join the #flottbot channel in the Gophers Slack.
Contributing
Please do! Check CONTRIBUTING.md for info.
Credits
Inspired by Hexbot.io
Directories