zitadel/docs
Livio Spring 14e2aba1bc
feat: Add Twilio Verification Service (#8678)
# Which Problems Are Solved
Twilio supports a robust, multi-channel verification service that
notably supports multi-region SMS sender numbers required for our use
case. Currently, Zitadel does much of the work of the Twilio Verify (eg.
localization, code generation, messaging) but doesn't support the pool
of sender numbers that Twilio Verify does.

# How the Problems Are Solved
To support this API, we need to be able to store the Twilio Service ID
and send that in a verification request where appropriate: phone number
verification and SMS 2FA code paths.

This PR does the following: 
- Adds the ability to use Twilio Verify of standard messaging through
Twilio
- Adds support for international numbers and more reliable verification
messages sent from multiple numbers
- Adds a new Twilio configuration option to support Twilio Verify in the
admin console
- Sends verification SMS messages through Twilio Verify
- Implements Twilio Verification Checks for codes generated through the
same

# Additional Changes

# Additional Context
- base was implemented by @zhirschtritt in
https://github.com/zitadel/zitadel/pull/8268 ❤️
- closes https://github.com/zitadel/zitadel/issues/8581

---------

Co-authored-by: Zachary Hirschtritt <zachary.hirschtritt@klaviyo.com>
Co-authored-by: Joey Biscoglia <joey.biscoglia@klaviyo.com>
2024-09-26 09:14:33 +02:00
..
apis/assets
docs feat: Add Twilio Verification Service (#8678) 2024-09-26 09:14:33 +02:00
src docs: optimized examples and sdk for search (#8657) 2024-09-25 08:14:58 +00:00
static feat: Add Twilio Verification Service (#8678) 2024-09-26 09:14:33 +02:00
.gitignore chore(docs): use gh action to build docs (#8097) 2024-06-13 08:07:39 +00:00
babel.config.js chore(docs): use gh action to build docs (#8097) 2024-06-13 08:07:39 +00:00
buf.gen.yaml chore(api): initial definition of API for user schemas (user v3 and user schema v3 service) (#7372) 2024-02-15 11:22:48 +01:00
docusaurus.config.js docs: Improve http notification doc (#8642) 2024-09-18 15:38:55 +02:00
frameworks.json docs: add pylon framework to examples (#8115) 2024-06-17 07:37:07 +00:00
package.json chore(docs): increase heap size (#8547) 2024-09-04 12:38:41 +00:00
README.md
sidebars.js docs: optimized examples and sdk for search (#8657) 2024-09-25 08:14:58 +00:00
tailwind.config.js
vercel.json chore(docs): Migrate from Docusaurus v2 to v3 (#8036) 2024-06-20 12:55:03 +00:00
yarn.lock chore(deps): bump micromatch from 4.0.7 to 4.0.8 in /docs (#8493) 2024-09-25 13:53:38 +00:00

ZITADEL-Docs

This website is built using Docusaurus 2, a modern static website generator.

Add new Sites to existing Topics

To add a new site to the already existing structure simply save the md file into the corresponding folder and append the sites id int the file sidebars.js.

Installation

Install dependencies with

yarn install

then run

yarn generate

Local Development

Start a local development server with

yarn start

When working on the API docs, run a local development server with

yarn start:api

Container Image

If you just want to start docusaurus locally without installing node you can fallback to our container image. Execute the following commands from the repository root to build and start a local version of ZITADEL

docker build -f docs/Dockerfile . -t zitadel-docs
docker run -p 8080:8080 zitadel-docs