gcalbot

README

Google Calendar Bot

I can connect to your Google calendar and notify you of invites, upcoming events and more! 📅

Running

In order to run the Google Calendar bot, there needs to be a running MySQL database in order to store account and webhook data.

1. On that SQL instance, create a database for the bot, and run db.sql to set up the tables.
2. Build the bot using Go 1.13+, like such (in this directory):

   go install .
   

3. Create an OAuth Client ID for a 'Web Application' via the Google API Console. Download the credentials locally as credentials.json.
4. In order for users to login using a web browser, the bot needs a server side secret. You must pass this in with --login-secret.
5. The bot sets itself up to serve HTTP requests on /gcalbot. The HTTP server runs on port 8080. You can configure nginx or any other reverse proxy software to route to this port and path.
6. To start the Google Calendar bot, run a command like this:

   # NOTE --kbfs-root specifies the path to the credentials.json file.
   # NOTE --http-prefix needs to be https for the Google API webhooks to function
   $GOPATH/bin/gcalbot --dsn 'root@/gcalbot' --kbfs-root ~/Downloads --http-prefix https://mydomain.com --login-secret 'moony wormtail padfoot prongs'
   

7. Run gcalbot --help for more options.

Helpful Tips

• If you accidentally run the bot under your own username and wish to clear the ! commands, run the following:

  keybase chat clear-commands
  

• Restricted bots are restricted from knowing channel names. If you would like a bot to announce or report errors to a specific channel you can use a ConversationID which can be found by running:

  keybase chat conv-info teamname --channel channel
  

• By default, bots are unable to read their own messages. For development, it may be useful to disable this safeguard. You can do this using --read-self flag when running the bot.
• The following links are helpful for using the Google Calendar API:
  • https://developers.google.com/calendar/quickstart/go
  • https://developers.google.com/calendar/v3/reference

Docker

There are a few complications running a Keybase chat bot, and it is likely easiest to deploy using Docker. See https://hub.docker.com/r/keybaseio/client for our preferred client image to get started.