Twilio Gatekeeper is an automated access control system (ACS) for gated communities and apartment buildings. Gatekeeper prompts visitors for a passcode and if correct, dials a specific number to grant access using the standard telephone entry systems found in most communities.
Gatekeeper uses Twilio, Serverless, and AWS Lambda.
Gatekeeper provides the following features:
- Grant access using passcode
- Restrict passcode attempts
- Dial operator for assistance
Before getting started, make sure the following prerequisites are met:
-
Clone this repo
-
Install dependencies
npm install
-
Configure your environment
echo "GATEKEEPER_ACCESS_TONE=$YOUR_ACCESS_TONE GATEKEEPER_MAX_ATTEMPTS=$YOUR_MAX_ATTEMPTS GATEKEEPER_OPERATOR=$YOUR_OPERATOR_NUMBER GATEKEEPER_PASSCODE=$YOUR_PASSCODE GATEKEEPER_URL=$YOUR_SERVICE_URL GATEKEEPER_DOMAIN_ENABLED=$YOUR_DOMAIN_ENABLED GATEKEEPER_DOMAIN_NAME=$YOUR_DOMAIN_NAME GATEKEEPER_CERTIFICATE_NAME=$YOUR_CERTIFICATE_NAME" > .env
-
Deploy to AWS
npm run deploy
-
Run end-to-end tests to confirm deployment
npm run test:e2e
To configure Twilio to respond to incoming calls from your ACS, you must:
- Buy and configure a Twilio phone number
- Configure the phone number to send a request to your service when a call comes in
Twilio already has these steps covered in their Responding to Incoming Phone Calls tutorial.
Finally, contact your community manager and have them change your ACS phone number to the Twilio number above.
You can use a custom domain for your service by using the Serverless Domain Manager plugin. See How to set up a custom domain name for Lambda & API Gateway with Serverless for more details on setting up a custom domain and certificate using Route53 and Certificate Manager.
Using a custom domain name is disabled by default. To enabled a custom domain, set these environment variables:
GATEKEEPER_DOMAIN_ENABLED=true
GATEKEEPER_DOMAIN_NAME=$YOUR_DOMAIN_NAME
GATEKEEPER_CERTIFICATE_NAME=$YOUR_CERTIFICATE_NAME"