Skip to content

Commit

Permalink
Update text explaining how to configure SMS and EMAIL senders for the…
Browse files Browse the repository at this point in the history
… stellar-disbursement-platform (#208)

* Update text explaining email and sms sender types configurations.

* Apply prettier

* Add missing colon.
  • Loading branch information
marcelosalloum authored Aug 9, 2023
1 parent 48325b0 commit 858fab8
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/stellar-disbursement-platform/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -193,15 +193,15 @@ Now that you've been able to make a disbursement, lets go back to our docker com

### Email and SMS Messages

The Stellar Disbursement Platform sends SMS messages and emails to receivers and users, respectively. For SMS messages, the Stellar Disbursemnet Platform supports Twilio or AWS SNS. For emails, it supports AWS SES.
The Stellar Disbursement Platform sends SMS messages and emails to receivers and users, respectively. For SMS messages, the Stellar Disbursement Platform supports Twilio, AWS SNS, and a dry run mode that just logs the messages. For emails, it supports AWS SES and dry run.

You'll need to chose if you want to use Twilio or AWS SNS for SMS messages. Once you create your AWS and potentially your Twilio account, you can configure the following values with your credentials.
These services can be selected through the `SMS_SENDER_TYPE` and `EMAIL_SENDER_TYPE` configurations. When selecting Twilio or AWS services, you'll need to fill their service-specific configuration as well. Here's an example of what the setup might look like if you're using both Twilio and AWS:

<CodeExample>

```yaml
# Or AWS_EMAIL
MESSAGE_SENDER_TYPE: TWILIO_SMS
SMS_SENDER_TYPE: TWILIO_SMS # or AWS_SMS or DRY_RUN
EMAIL_SENDER_TYPE: AWS_EMAIL # or DRY_RUN
# AWS
AWS_ACCESS_KEY_ID:
AWS_REGION:
Expand Down

0 comments on commit 858fab8

Please sign in to comment.