locnh/cloudflare-slackbot repository overview

⁠CloudFlare Slack Bot

A Slack⁠ bot for CloudFlare⁠.

⁠Configuration

Configure cachebot using environment variables:

⁠How to start

Choose one of the ways below:

1. Use pre-compiled for Mac OS X / Linux (amd64)

   $ bin/cf_bot_<os>_amd64 -cloudflare-email CF-EMAIL -cloudflare-token CF-API-TOKEN -slack-token SLACK-TOKEN -cloudflare-zone example.com -restricted-channels SLACK-CHANNEL -authorised-users SLACK-USER
   

   Copy

2. Compile and run by yourself

   $ make
   $ bin/cf_bot_<os>_amd64 -cloudflare-email CF-EMAIL -cloudflare-token CF-API-TOKEN -slack-token SLACK-TOKEN -cloudflare-zone example.com -restricted-channels SLACK-CHANNEL -authorised-users SLACK-USER
   

   Copy

3. Docker

   $ docker pull locnh/cloudflare-slackbot
   $ docker run --name cfslackbot -e CF_EMAIL=<cf-email> -e CF_TOKEN=<cf-token> -e SLACK_TOKEN=<slack-token> -e CF_ZONE=example.com -e RESTRICTED_CHANNELS=<slack-channels> -e AUTHORISED_USERS=<slack-users> -d locnh/cloudflare-slackbot
   

   Copy

⁠Usage

1. Start the bot
2. /invite the bot to a channel
3. Ask cachebot to clear your cache:
   • clear cache
   • clear cache url1 url2 url3

⁠Authorised users / restricted channels

The bot only works in RESTRICTED_CHANNELS and only allows messages from AUTHORISED_USERS.

Example:

# Only 'foo' and 'bar' users can talk to the bot in the 'support' channel.
# cachebot works as normal in all other channels.
AUTHORISED_USERS=foo,bar
RESTRICTED_CHANNELS=support,cloudflare

⁠Elastic Beanstalk

If you deploy to Elastic Beanstalk, you'll need to add an EXPOSE line to the Dockerfile. Cachebot doesn't listen on any ports, but Elastic Beanstalk prevents deployments of apps without it.

⁠Credit

This bot was based on ian-kent/cachebot⁠ and rewritten with cloudflare/cloudflare-go⁠. I also removed BASE_URI, URI_SUFFIX and used full URLs of files to be cleared from CF Cache, that means we actually can clean cache for subdomain and don't be limited inside the CF Zone

⁠License

Released under MIT license, see LICENSE⁠ for details.