Skip to content

Commit

Permalink
feat: prettier documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
oleksiireshetnik committed Dec 15, 2021
1 parent 5c8a9ce commit 7bc9f03
Showing 1 changed file with 20 additions and 13 deletions.
33 changes: 20 additions & 13 deletions docs/docs/concepts/email-sms.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ courier:

### Sender Address and Template Customization

You can customize the sender address and email templates by overriding path to templates folder.
See more about custom templates in templates section.
You can customize the sender address and email templates by overriding path to
templates folder. See more about custom templates in templates section.

```yaml title="path/to/my/kratos/config.yml"
# $ kratos -c path/to/my/kratos/config.yml serve
Expand Down Expand Up @@ -112,9 +112,12 @@ courier:
## Sending SMS
For sending SMS Ory Kratos requires external SMS gateway, which must be able to satisfy HTTP contract.
Address of the SMS gateway endpoint must be set in the configuration file.
Please note that it needs to be absolute, start with http:// or https:// scheme, and include path part - e.g. "https://api.sender.com/v1/message".
For sending SMS Ory Kratos requires external SMS gateway, which must be able to
satisfy HTTP contract. Address of the SMS gateway endpoint must be set in the
configuration file. Please note that it needs to be absolute, start with http://
or https:// scheme, and include path part - e.g.
"https://api.sender.com/v1/message".
```yaml title="path/to/my/kratos/config.yml"
# $ kratos -c path/to/my/kratos/config.yml serve
courier:
Expand All @@ -124,26 +127,30 @@ courier:
### HTTP API contract
Kratos will send POST request to endpoint setted in config for phone verification and recovery (note that recovery using SMS is currently not implemented).
Post request body has urlencoded format, and contains three parameters - "To", "From", and "Body".
To - phone number of recipient.
From - configurable sender name.
Body - the text of sms message. It will contain link or OTP code for verification(in progress).
Kratos will send POST request to endpoint setted in config for phone
verification and recovery (note that recovery using SMS is currently not
implemented). Post request body has urlencoded format, and contains three
parameters - "To", "From", and "Body". To - phone number of recipient. From -
configurable sender name. Body - the text of sms message. It will contain link
or OTP code for verification(in progress).
Authorization with third party SMS gate via access tokens are not implemented yet.
Authorization with third party SMS gate via access tokens are not implemented
yet.
### Sender name
You can customize the sender name for sms by overriding the config. Default sender name is equal to "Kratos".
You can customize the sender name for sms by overriding the config. Default
sender name is equal to "Kratos".
```yaml title="path/to/my/kratos/config.yml"
# $ kratos -c path/to/my/kratos/config.yml serve
courier:
sms:
from_name: "Your Org Name"
from_name: 'Your Org Name'
```
## Message templates
Ory Kratos comes with built-in templates. If you wish to define your own, custom
templates, you should define `template_override_path`, as shown above, to
indicate where your custom templates are located. This will become the
Expand Down

0 comments on commit 7bc9f03

Please sign in to comment.