From de96c690b4a55f5bfb7338049b8550feeb5cd7cd Mon Sep 17 00:00:00 2001 From: "m.nabokikh" Date: Mon, 11 Jan 2021 16:51:18 +0400 Subject: [PATCH 1/3] fix: refresh getting started documentation Signed-off-by: m.nabokikh --- content/docs/getting-started.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/content/docs/getting-started.md b/content/docs/getting-started.md index c119994..ed62597 100644 --- a/content/docs/getting-started.md +++ b/content/docs/getting-started.md @@ -9,17 +9,21 @@ weight: 10 ## Building the dex binary -Dex requires a Go installation and a GOPATH configured. For setting up a Go workspace, refer to the [official documentation][go-setup]. Clone it down the correct place, and simply type `make` to compile the dex binary. +To build dex from source code, install a working Go environment with version 1.15 or greater according to the [official documentation][go-setup]. +Then clone the repository down to the correct place, and simply type `make` to compile the dex binary. ```bash -$ go get github.com/dexidp/dex -$ cd $GOPATH/src/github.com/dexidp/dex +$ mkdir -p $GOPATH/src/github.com/dexidp/ +$ cd $GOPATH/src/github.com/dexidp/ +$ git clone https://github.com/dexidp/dex.git +$ cd dex $ make ``` +> **Note:** It is possible to clone the repository outside $GOPATH ## Configuration -Dex exclusively pulls configuration options from a config file. Use the [example config][example-config] file found in the `examples/` directory to start an instance of dex with an in-memory data store and a set of predefined OAuth2 clients. +Dex exclusively pulls configuration options from a config file. Use the [example config][example-config] file found in the `examples/` directory to start an instance of dex with a sqlite3 data store, and a set of predefined OAuth2 clients. ```bash ./bin/dex serve examples/config-dev.yaml @@ -39,9 +43,11 @@ By default, the example client is configured with the same OAuth2 credentials de Login to dex through the example app using the following steps. -1. Navigate to the example app in your browser at http://localhost:5555/ in your browser. +1. Navigate to the example app at http://localhost:5555/ in your browser. 2. Hit "login" on the example app to be redirected to dex. -3. Choose the "Login with Email" and enter "admin@example.com" and "password" +3. Choose an option to authenticate: + * "Login with Example" to use mocked user data. + * "Login with Email" to fill the form with static user credentials `admin@example.com` and `password`. 4. Approve the example app's request. 5. See the resulting token the example app claims from dex. From cd75faed74b2f690328f938cab5de4b81930f617 Mon Sep 17 00:00:00 2001 From: Maksim Nabokikh <32434187+nabokihms@users.noreply.github.com> Date: Mon, 11 Jan 2021 23:00:47 +0400 Subject: [PATCH 2/3] Update content/docs/getting-started.md Co-authored-by: Nate W. <4453979+nate-double-u@users.noreply.github.com> Signed-off-by: m.nabokikh --- content/docs/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/getting-started.md b/content/docs/getting-started.md index ed62597..596a890 100644 --- a/content/docs/getting-started.md +++ b/content/docs/getting-started.md @@ -10,7 +10,7 @@ weight: 10 ## Building the dex binary To build dex from source code, install a working Go environment with version 1.15 or greater according to the [official documentation][go-setup]. -Then clone the repository down to the correct place, and simply type `make` to compile the dex binary. +Then clone the repository and use `make` to compile the dex binary. ```bash $ mkdir -p $GOPATH/src/github.com/dexidp/ From 75fdbb57a6901e6bedec459ac5b6257cbf9c20d1 Mon Sep 17 00:00:00 2001 From: "m.nabokikh" Date: Fri, 22 Jan 2021 11:54:42 +0400 Subject: [PATCH 3/3] Remove the note about GO_PATH Signed-off-by: m.nabokikh --- content/docs/getting-started.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/content/docs/getting-started.md b/content/docs/getting-started.md index 596a890..681c06a 100644 --- a/content/docs/getting-started.md +++ b/content/docs/getting-started.md @@ -13,13 +13,10 @@ To build dex from source code, install a working Go environment with version 1.1 Then clone the repository and use `make` to compile the dex binary. ```bash -$ mkdir -p $GOPATH/src/github.com/dexidp/ -$ cd $GOPATH/src/github.com/dexidp/ $ git clone https://github.com/dexidp/dex.git -$ cd dex +$ cd dex/ $ make ``` -> **Note:** It is possible to clone the repository outside $GOPATH ## Configuration