Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
D
dex
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
go
dex
Commits
d154cad3
Commit
d154cad3
authored
Sep 21, 2015
by
Chance Zibolski
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Documentation: Add how to setup email configuration
parent
b1e146b7
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
59 additions
and
1 deletion
+59
-1
email-configuration.md
Documentation/email-configuration.md
+53
-0
getting-started.md
Documentation/getting-started.md
+6
-1
No files found.
Documentation/email-configuration.md
0 → 100644
View file @
d154cad3
# Configuring Sending Emails
Dex sends emails to a during the registration process to verify an email
address belongs to the person signing up. Currently Dex supports two ways of
sending emails, and has a third option for use during development.
Configuration of the email provider in Dex is provided through a JSON file. All
email providers have a
`type`
and
`id`
field as well as some additional provider
specific fields.
## SMTP
If using SMTP the
`type`
field
**must**
be set to
`smtp`
. Additionally both
`host`
and
`port`
are required. If you wish to use SMTP plain auth, then
set
`auth`
to
`plain`
and specify your username and password.
```
{
"type": "smtp",
"host": "smtp.example.org",
"port": 587,
"auth": "plain",
"username": "postmaster@example.org",
"password": "foo"
}
```
## Mailgun
If using Mailgun the
`type`
field
**must**
be set to
`mailgun`
. Additionally
`privateAPIKey`
,
`publicAPIKey`
, and
`domain`
are required.
```
{
"type": "mailgun",
"privateAPIKey": "key-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"publicAPIKey": "YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY",
"domain": "sandboxZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ.mailgun.org"
}
```
## Dev
The fake emailer should only be used in development. The fake emailer
prints emails to
`stdout`
rather than sending any email. If using the fake
emailer the
`type`
field
**must**
be set to
`fake`
.
```
{
"type": "fake"
}
```
\ No newline at end of file
Documentation/getting-started.md
View file @
d154cad3
...
...
@@ -63,7 +63,12 @@ export DEX_OVERLORD_LOG_DEBUG=true
# Start the dex-worker
Now start the worker:
Before starting
`dex-worker`
you should determine how you want verification emails to be delivered to the user.
If you just want to test dex out, you can just use the provided sample config in
`static/fixtures/emailer.json.sample`
.
Please review
[
email-configuration
](
https://github.com/coreos/dex/blob/master/Documentation/email-configuration.md
)
for details
(make sure you point
`--email-cfg`
to your newly configured file).
Once you have setup your email config run
`dex-worker`
:
`./bin/dex-worker --db-url=$DEX_DB_URL --key-secrets=$DEX_KEY_SECRET --email-cfg=static/fixtures/emailer.json.sample --log-debug=true &`
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment