SMS Setup
Melody Auth supports SMS-based Multi-Factor Authentication. To enable it, you need to configure Twilio as your SMS provider.
Supported SMS Providers
- Twilio
Environment Variables
Use the table below to configure Twilio as your SMS provider.
| Variable Name | Description | Example Value |
|---|---|---|
| ENVIRONMENT | Determines the sms sending behavior | "prod" or "dev" |
| DEV_SMS_RECEIVER | Phone number for testing (used when ENVIRONMENT ≠ "prod"). | "+16471231234" |
| TWILIO_ACCOUNT_ID | Your Twilio account id | |
| TWILIO_AUTH_TOKEN | Your Twilio auth token | |
| TWILIO_SENDER_NUMBER | Your Twilio sender number |
Production vs. Development Behavior
Production (ENVIRONMENT = "prod")
- Messages will be sent to the actual user phone number.
- Use this setting for production deployments.
Development (ENVIRONMENT ≠ "prod")
- All messages will be redirected to the phone number specified in
DEV_SMS_RECEIVER. - This is useful for testing and development to avoid sending messages to real users.
- All messages will be redirected to the phone number specified in
Cloudflare Remote/Production Configuration
- Navigate to the Cloudflare dashboard -> Go to "Workers & Pages"
- Select your "melody-auth" worker -> "Settings" -> "Variables"
- Add any environment variables that apply to your use case.
- Click "Save and deploy" to apply the changes.
Cloudflare Local/Development or Node.js Environment
- In your melody-auth/server directory, locate or create a .dev.vars file (you can copy .dev.vars.example if needed).
- Update any environment variables that apply to your use case to .dev.vars
SMS MFA Country Code
Default country code for SMS MFA is "+1". You can change it by setting the CountryCode for SmsMfaConfig in server/src/configs/variable.ts.