Skip to content
This repository has been archived by the owner on Jul 12, 2023. It is now read-only.

Document Twilio setup and recommendations #708

Merged
merged 1 commit into from
Sep 29, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 37 additions & 1 deletion docs/production.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# Production

This page includes helpful tips for configuring things in production:
This page includes helpful tips for configuring things in production.

<!-- TOC depthFrom:2 depthTo:2 -->

- [Key management](#key-management)
- [Observability (tracing and metrics)](#observability-tracing-and-metrics)
- [User administration](#user-administration)
- [Rotating secrets](#rotating-secrets)
- [SMS with Twilio](#sms-with-twilio)

<!-- /TOC -->

## Key management

Expand Down Expand Up @@ -356,4 +366,30 @@ RATE_LIMIT_HMAC_KEY="43+ViAkv7uHYKjsXhU468NGBZrtlJWtZqTORIiY8V6OMsLAZ+XmUF5He/wI
```


## SMS with Twilio

The verification server can optionally be configured to send SMS messages with
app deep-links for the verification codes. This removes the need for a case
worker to dictate a code over the phone, but requires the use of [Twilio](https://twilio.com) to
send SMS text messages. To get started:

1. [Create an account on Twilio](https://www.twilio.com/try-twilio).

1. [Purchase](https://support.twilio.com/hc/en-us/articles/223135247-How-to-Search-for-and-Buy-a-Twilio-Phone-Number-from-Console)
or
[transfer](https://support.twilio.com/hc/en-us/articles/223179348-Porting-a-Phone-Number-to-Twilio)
a phone number from which SMS text messages will be sent.

Note: To reduce the chance of your SMS messages being flagged as spam, we
strongly recommend registering a toll-free SMS number or SMS short code.

1. Find your Twilio **Account SID** and **Auth token** on your [Twilio dashboard](https://twilio.com/dashboard).

1. Go to the realm settings page on the **SMS** tab, enter these values, and
click save.

1. Case workers will now see an option on the **Issue code** page to enter a
phone number. This is _always_ optional in case the patient does not have an
SMS-enabled cell phone.

[gcp-kms]: https://cloud.google.com/kms