Skip to content

Commit c106813

Browse files
enhanced doc: REDIS_URL mention, and no glitch support
1 parent df7ece6 commit c106813

1 file changed

Lines changed: 10 additions & 14 deletions

File tree

README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
1-
# Template to bootstrap a Botkit project for Webex Teams
1+
# Bootstrap a Botkit project for Webex Teams
22

3-
This template regroups a set of best practices:
3+
This template adds Redis support for Botkit storage:
4+
5+
Simply ass a REDIS_URL variable to configure your redis engine, and the Botkit-Redis storage module gets automatically added and configured.
6+
7+
All other features from the Botkit template's master branch apply (see below), BUT the capabity to run on glitch.
8+
9+
-------
10+
11+
Features:
412

513
- 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.
614

@@ -17,18 +25,6 @@ This template regroups a set of best practices:
1725
- popular cloud providers: the bot self-configures when run on Glitch and Heroku (if the dyno_metadata feature is activated)
1826

1927

20-
## Quick start on Glitch
21-
22-
Click [![Remix on Glitch](https://cdn.glitch.com/2703baf2-b643-4da7-ab91-7ee2a2d00b5b%2Fremix-button.svg)](https://glitch.com/edit/#!/import/github/CiscoDevNet/botkit-template)
23-
24-
Then open the `.env` file and paste your bot's token into the ACCESS_TOKEN variable.
25-
26-
You bot is all set, responding in 1-1 and 'group' spaces, and sending a welcome message when added to a space,
27-
Its healthcheck is accessible at your application public url, suffixed with "/ping"
28-
29-
_Note that thanks to Glitch 'PROJECT_DOMAIN' env variable, you did not need to add a PUBLIC_URL variable pointing to your app domain._
30-
31-
3228
## Quick start on Heroku
3329

3430
Create a new project pointing to this repo.

0 commit comments

Comments
 (0)