From 14cf24da7f9a085ac72bd24388edc570801a85e1 Mon Sep 17 00:00:00 2001 From: Brandon Philips Date: Tue, 20 Oct 2015 09:11:19 -0400 Subject: [PATCH 1/2] README: consistent tabbing some of these items were space indented, others were tabbed. Use tabs. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 409a49b4..c371137b 100644 --- a/README.md +++ b/README.md @@ -13,13 +13,13 @@ We named the project 'dex' because it is a central index of users that other pie dex consists of multiple components: - **dex-worker** is the primary server component of dex - - host a user-facing API that drives the OIDC protocol + - host a user-facing API that drives the OIDC protocol - proxy to remote identity providers via "connectors" - - provides an API for administrators to manage users. + - provides an API for administrators to manage users. - **dex-overlord** is an auxiliary process responsible for various administrative tasks: - rotation of keys used by the workers to sign identity tokens - garbage collection of stale data in the database - - provides an API for bootstrapping the system. + - provides an API for bootstrapping the system. - **dexctl** is a CLI tool used to manage a dex deployment - configure identity provider connectors - administer OIDC client identities From 714710719b5212f000f15a6fa377c16cddfb9503 Mon Sep 17 00:00:00 2001 From: Brandon Philips Date: Tue, 20 Oct 2015 09:35:51 -0400 Subject: [PATCH 2/2] Documentation: getting-started md cleanups Markdown needs a newline between a paragraph and a code block for most renderers. Fix this. --- Documentation/getting-started.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Documentation/getting-started.md b/Documentation/getting-started.md index a7328312..dbd6ca7f 100644 --- a/Documentation/getting-started.md +++ b/Documentation/getting-started.md @@ -88,7 +88,8 @@ Note: the issuer URL MUST have an `https` scheme in production to meet spec comp The worker and overlord are up and running, but we need to tell dex what connectors we want to use to authenticate. For this case we'll set up a local connector, where dex manages credentials and provides a UI for authentication, and a Google OIDC connector. -If you prefer to use the Google OIDC Identity Provider (IdP), just omit the second entry in the JSON connector list. Note that you must replace DEX_GOOGLE_CLIENT_{ID,SECRET} with the client ID and client Secret you got when you registered your project with the Google developer console. +If you prefer to use the Google OIDC Identity Provider (IdP), just omit the second entry in the JSON connector list. Note that you must replace `DEX_GOOGLE_CLIENT_SECRET` and `DEX_GOOGLE_CLIENT_ID` with the client secret and client ID you got when you registered your project with the Google developer console. + ``` cat << EOF > /tmp/dex_connectors.json [ @@ -116,6 +117,7 @@ One thing to note here that's a bit confusing here is that in the case of the Go Like all OAuth2/OIDC IdPs, clients must be registered with the IdP (dex), along with their valid redirect URLS. New clients can be registered with the dexctl CLI tool: + ``` eval "$(./bin/dexctl -db-url=$DEX_DB_URL new-client http://127.0.0.1:5555/callback)" ```