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
8c36ede2
Commit
8c36ede2
authored
Aug 11, 2016
by
Eric Chiang
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
*: add a "getting started" page to the readme
parent
bfe560ee
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
39 additions
and
0 deletions
+39
-0
README.md
README.md
+39
-0
No files found.
README.md
View file @
8c36ede2
...
...
@@ -25,3 +25,42 @@ backend services.
One such application that consumes OpenID Connect tokens is the
[
Kubernetes
](
http://kubernetes.io/
)
API server, allowing dex to provide identity for any
Kubernetes clusters.
## Getting started
dex requires a Go installation and a GOPATH configured. Clone it down the
correct place, and simply type
`make`
to compile dex.
```
git clone https://github.com:coreos/dex.git $GOPATH/src/github.com/coreos/dex
cd $GOPATH/src/github.com/coreos/dex
make
```
dex is a single, scalable binary that pulls all configuration from a config
file (no command line flags at the moment). Use one of the config files defined
in the
`examples`
folder to start up dex with an in-memory data store.
```
./bin/dex serve examples/config-dev.yaml
```
dex allows OAuth2 clients to be defined statically through the config file. In
another window, run the
`example-app`
(an OAuth2 client). By default this is
configured to use the client ID and secret defined in the config file.
```
./bin/example-app
```
Then to interact with dex, like any other OAuth2 provider, you must first visit
a client app, then be prompted to login through dex. This can be achieved using
the following steps:
NOTE: The UIs are extremely bare bones at the moment.
1.
Navigate to http://localhost:5555/ in your browser.
2.
Hit "login" on the example app to be redirected to dex.
3.
Choose the "mock" option to login as a predefined user.
4.
Approve the example app's request.
5.
See the resulting token the example app claims from dex.
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