This template adds Redis support for Botkit storage:
Simply ass a REDIS_URL variable to configure your redis engine, and the Botkit-Redis storage module gets automatically added and configured.
All other features from the Botkit template's master branch apply (see below), BUT the capabity to run on glitch.
Features:
-
configuration: pass settings either through environment variables on the command line, or hard-coded values in the
.env
file. Note that command line variables are priorized over the.env
file if present in both places. -
skills: organize your bot behaviours by placing 'commands', 'conversations' and 'events' in the skills directory.
-
user experience: the template comes ready-to-use skills: a 'welcome' invite, as well as 'help' and 'fallback' commands.
-
healthcheck: easilly check that everything goes well by hitting the
ping
endpoint automatically exposed. -
metadata: expose extra info via command and on a public address so that Webex Teams users can inquire on Bot Author / Legal mentions / Healthcheck endpoint...
-
mentions: the appendMention utility function helps Webex Teams users remind to mention the bot in Group spaces.
-
popular cloud providers: the bot self-configures when run on Glitch and Heroku (if the dyno_metadata feature is activated)
Create a new project pointing to this repo.
Reach to your app settings, reveal your config variables, and add a ACCESS_TOKEN variable with your bot token as value.
Unless your app is using Dyno Metadata, you also need to add a PUBLIC_URL variable pointing to your app domain.
You bot is all set, responding in 1-1 and 'group' spaces, and sending a welcome message when added to a space, Its healthcheck is accessible at your application public url, suffixed with "/ping"
Assuming you plan to expose your bot via ngrok, you can run this template in a snatch.
-
Create a Bot Account from the 'Webex for developers' bot creation page, and copy your bot's access token.
-
Launch ngrok to expose port 3000 of your local machine to the internet:
ngrok http 3000
Pick the HTTPS address that ngrok is now exposing. Note that ngrok exposes HTTP and HTTPS protocols, make sure to pick the HTTPS address.
-
[Optional] Open the
.env
file and modify the settings to accomodate your bot.Note that you can also specify any of these settings via env variables. In practice, the values on the command line or in your machine env will prevail over .env file settings
To successfully run your bot, you'll need to specify a PUBLIC_URL for your bot, and a Webex Teaùs API ACCESS_TOKEN (either in the .env settings or via env variables). In the example below, we do not modify any value in settings and specify all configuration values on the command line.
-
You're ready to run your bot
From a bash shell:
git clone https://github.com/CiscoDevNet/botkit-template cd botkit-template npm install ACCESS_TOKEN=0123456789abcdef PUBLIC_URL=https://abcdef.ngrok.io node bot.js
From a windows shell:
> git clone https://github.com/CiscoDevNet/botkit-template > cd botkit-template > npm install > set ACCESS_TOKEN=0123456789abcdef > set PUBLIC_URL=https://abcdef.ngrok.io > node bot.js
where:
- ACCESS_TOKEN is the API access token of your bot
- PUBLIC_URL is the root URL at which the Webex cloud platform can reach your bot
- ngrok helps you expose the bot running on your laptop to the internet, type:
ngrok http 3000
to launch