Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: refresh getting started documentation #80

Merged
merged 3 commits into from
Jan 22, 2021
Merged

fix: refresh getting started documentation #80

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
de96c69
fix: refresh getting started documentation
nabokihms Jan 11, 2021
cd75fae
Update content/docs/getting-started.md
nabokihms Jan 11, 2021
75fdbb5
Remove the note about GO_PATH
nabokihms Jan 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions content/docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,18 @@ 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may not want to remove the reference to the GOPATH here as we do reference it later on. (and I don't think it is setup by default if you install Go)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gopath is not mandatory after migrating to go modules. If it is confusing, I can completely remove it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm able to run the examples w/o setting the $GOPATH, and if it's not mandatory, it may be best to remove it as it is extra detail that makes the getting started more complicated.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I have no objections.

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 and use `make` to compile the dex binary.

```bash
$ go get github.com/dexidp/dex
$ cd $GOPATH/src/github.com/dexidp/dex
$ git clone https://github.com/dexidp/dex.git
$ cd dex/
$ make
```

## 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
Expand All @@ -39,9 +40,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 "[email protected]" 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 `[email protected]` and `password`.
4. Approve the example app's request.
5. See the resulting token the example app claims from dex.

Expand Down