dex/examples/README.md

# Running Examples

The quickest way to start experimenting with dex is to run a single dex-worker locally, with an in-process database, and then interact with it using the example programs in this directory.

## Build Everything and Start dex-worker

First, build the example webapp client and example CLI client.

```console
./build
```

Now copy the example configurations into place to get dex configured.
You can customize these later but the defaults should work fine.

```console
cp static/fixtures/clients.json.sample static/fixtures/clients.json
cp static/fixtures/connectors.json.sample static/fixtures/connectors.json
cp static/fixtures/users.json.sample static/fixtures/users.json
cp static/fixtures/emailer.json.sample static/fixtures/emailer.json
```

With `dex-worker` configuration in place we can start dex in local mode.

```console
./bin/dex-worker --no-db &
```

## Example Webapp Client

Build and run the example app webserver by pointing the discovery URL to local Dex, and
supplying the client information from `./static/fixtures/clients.json` into the flags.

```console
./bin/example-app \
	--client-id=example-app \
	--client-secret=example-app-secret \
	--discovery=http://127.0.0.1:5556
```

Visit [http://localhost:5555](http://localhost:5555) in your browser and click "login" link.
Next click "Login with Email" and enter the sample credentials from `static/fixtures/connectors.json`:

* email: `elroy77@example.com`
* password: `bones`

The example app will dump out details of the JWT issued by Dex which means that authentication was successful and the application has authenticated you as a valid user.
You can play with adding additional users in connectors.json and users.json.

## Example CLI Client

The example CLI will start, connect to the Dex instance to gather discovery information, listen on `localhost:8000`, and then acquire a client credentials JWT and print it out.

```console
./bin/example-cli \
	--client-id example-cli \
	--client-secret examplie-cli-secret \
	--discovery=http://127.0.0.1:5556
```
examples: improve docs in README Make the docs feel more like a tutorial and add some more context. 2015-11-09 03:17:55 +01:00			`# Running Examples`
*: move original project to dex 2015-08-17 17:27:27 -07:00
examples: improve docs in README Make the docs feel more like a tutorial and add some more context. 2015-11-09 03:17:55 +01:00			`The quickest way to start experimenting with dex is to run a single dex-worker locally, with an in-process database, and then interact with it using the example programs in this directory.`
*: move original project to dex 2015-08-17 17:27:27 -07:00
			`## Build Everything and Start dex-worker`

examples: improve docs in README Make the docs feel more like a tutorial and add some more context. 2015-11-09 03:17:55 +01:00			`First, build the example webapp client and example CLI client.`

Documentation: update dev-guide.md and examples/README.md - Be more explicit with exact instructions to startup - Change some of the commands that were using local directory with "./" when the executable was in a lower directory. These commands (like "./bin/dex-worker") did not work on ZSH or Bash, so I removed the leading "./" - Add some syntax highlighting markdown to code sections 2015-11-06 14:14:44 -06:00			```console
examples: improve docs in README Make the docs feel more like a tutorial and add some more context. 2015-11-09 03:17:55 +01:00			`./build`
			```

			`Now copy the example configurations into place to get dex configured.`
			`You can customize these later but the defaults should work fine.`

Documentation: update dev-guide.md and examples/README.md - Be more explicit with exact instructions to startup - Change some of the commands that were using local directory with "./" when the executable was in a lower directory. These commands (like "./bin/dex-worker") did not work on ZSH or Bash, so I removed the leading "./" - Add some syntax highlighting markdown to code sections 2015-11-06 14:14:44 -06:00			```console
examples: add sample for clients Adds consistency to existing samples for users, connectors, etc., as well as protects users from accidental changes to files under Git, which is why there are samples after all. 2016-05-18 18:18:20 -07:00			`cp static/fixtures/clients.json.sample static/fixtures/clients.json`
examples: improve docs in README Make the docs feel more like a tutorial and add some more context. 2015-11-09 03:17:55 +01:00			`cp static/fixtures/connectors.json.sample static/fixtures/connectors.json`
			`cp static/fixtures/users.json.sample static/fixtures/users.json`
			`cp static/fixtures/emailer.json.sample static/fixtures/emailer.json`
			```

			With `dex-worker` configuration in place we can start dex in local mode.

Documentation: update dev-guide.md and examples/README.md - Be more explicit with exact instructions to startup - Change some of the commands that were using local directory with "./" when the executable was in a lower directory. These commands (like "./bin/dex-worker") did not work on ZSH or Bash, so I removed the leading "./" - Add some syntax highlighting markdown to code sections 2015-11-06 14:14:44 -06:00			```console
examples: improve docs in README Make the docs feel more like a tutorial and add some more context. 2015-11-09 03:17:55 +01:00			`./bin/dex-worker --no-db &`
			```

			`## Example Webapp Client`

examples: add sample for clients Adds consistency to existing samples for users, connectors, etc., as well as protects users from accidental changes to files under Git, which is why there are samples after all. 2016-05-18 18:18:20 -07:00			`Build and run the example app webserver by pointing the discovery URL to local Dex, and`
*: move original project to dex 2015-08-17 17:27:27 -07:00			supplying the client information from `./static/fixtures/clients.json` into the flags.
examples: improve docs in README Make the docs feel more like a tutorial and add some more context. 2015-11-09 03:17:55 +01:00
Documentation: update dev-guide.md and examples/README.md - Be more explicit with exact instructions to startup - Change some of the commands that were using local directory with "./" when the executable was in a lower directory. These commands (like "./bin/dex-worker") did not work on ZSH or Bash, so I removed the leading "./" - Add some syntax highlighting markdown to code sections 2015-11-06 14:14:44 -06:00			```console
examples: improve docs in README Make the docs feel more like a tutorial and add some more context. 2015-11-09 03:17:55 +01:00			`./bin/example-app \`
			`--client-id=example-app \`
			`--client-secret=example-app-secret \`
			`--discovery=http://127.0.0.1:5556`
			```

			`Visit [http://localhost:5555](http://localhost:5555) in your browser and click "login" link.`
Documentation: update dev-guide.md and examples/README.md - Be more explicit with exact instructions to startup - Change some of the commands that were using local directory with "./" when the executable was in a lower directory. These commands (like "./bin/dex-worker") did not work on ZSH or Bash, so I removed the leading "./" - Add some syntax highlighting markdown to code sections 2015-11-06 14:14:44 -06:00			Next click "Login with Email" and enter the sample credentials from `static/fixtures/connectors.json`:
examples: improve docs in README Make the docs feel more like a tutorial and add some more context. 2015-11-09 03:17:55 +01:00
Documentation: update dev-guide.md and examples/README.md - Be more explicit with exact instructions to startup - Change some of the commands that were using local directory with "./" when the executable was in a lower directory. These commands (like "./bin/dex-worker") did not work on ZSH or Bash, so I removed the leading "./" - Add some syntax highlighting markdown to code sections 2015-11-06 14:14:44 -06:00			* email: `elroy77@example.com`
			* password: `bones`
examples: improve docs in README Make the docs feel more like a tutorial and add some more context. 2015-11-09 03:17:55 +01:00
			`The example app will dump out details of the JWT issued by Dex which means that authentication was successful and the application has authenticated you as a valid user.`
			`You can play with adding additional users in connectors.json and users.json.`

			`## Example CLI Client`

			The example CLI will start, connect to the Dex instance to gather discovery information, listen on `localhost:8000`, and then acquire a client credentials JWT and print it out.

Documentation: update dev-guide.md and examples/README.md - Be more explicit with exact instructions to startup - Change some of the commands that were using local directory with "./" when the executable was in a lower directory. These commands (like "./bin/dex-worker") did not work on ZSH or Bash, so I removed the leading "./" - Add some syntax highlighting markdown to code sections 2015-11-06 14:14:44 -06:00			```console
examples: improve docs in README Make the docs feel more like a tutorial and add some more context. 2015-11-09 03:17:55 +01:00			`./bin/example-cli \`
Update README.md Fix command line for example-cli 2016-04-20 11:53:36 -07:00			`--client-id example-cli \`
			`--client-secret examplie-cli-secret \`
examples: improve docs in README Make the docs feel more like a tutorial and add some more context. 2015-11-09 03:17:55 +01:00			`--discovery=http://127.0.0.1:5556`
			```