ciscospark-doorman's Introduction

🎩 Doorman Bot for Cisco Spark

Doorman is a bot that can manage invitations to a private space. Invite him to a space and he'll give you a URL that you can give to people who might want to join. Add the URL to a forum, email chain, Twitter, or whatever.

Doorman will ask you to review any guests before letting them join your space (or not).

Try it out

The official Doorman bot is [email protected]. Add him to your space and play around.

Deploying your own Doorman bot

Here are instructions for deploying on Heroku, but this can be adapted to any host.

Create a new bot account on Cisco Spark
Clone this repo
Create a new app on heroku
```
 heroku apps:create my-doorman-bot
```

Add environment variables to the heroku app to match those in .env. e.g.

 heroku config:add PUBLIC_ADDRESS=https://my-doorman-bot.herokuapp.com

Add a Redis addon. The Heroku Redis is a good one.
Push to heroku
```
 git push heroku
```
Add your bot to your space. He'll tell you what to do from there.

Development

Work on the bot

Create a new bot account on Cisco Spark
Clone this repo
Install dependencies
```
 nvm install
 yarn install
```
Install Redis. If you're on a Mac, do brew install redis
Copy .env to .env.local and customize
```
 cp .env .env.local
```
Start the local development server
```
 npm start
```
Run ngrok (or something like it).

Because Spark uses webhooks to talk to bots, you must run something like ngrok locally to expose your server to the web. We've included a script to do this for you (requires ngrok)
```
 npm run ngrok
```