mystiq/dex
Archived
4
0
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity

examples: add sample for clients

Browse source 
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.
This commit is contained in:
Pavel Strashkin 2016-05-18 18:18:20 -07:00
parent 02bf115026
commit dec5d90657
4 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.gitignore vendored
View file

@ -28,6 +28,7 @@ coverage/
deploy/ deploy/
Godeps/_workspace/src/github.com/coreos/dex Godeps/_workspace/src/github.com/coreos/dex
static/fixtures/env.txt static/fixtures/env.txt
static/fixtures/clients.json
static/fixtures/connectors.json static/fixtures/connectors.json
static/fixtures/users.json static/fixtures/users.json
static/fixtures/emailer.json static/fixtures/emailer.json

3
Documentation/dev-guide.md
View file

@ -4,11 +4,12 @@
When you are working on dex it's convenient to use the `--no-db` flag. This starts up dex in a mode which uses an in-memory datastore for persistence. It also does not rotate keys, so no overlord is required. When you are working on dex it's convenient to use the `--no-db` flag. This starts up dex in a mode which uses an in-memory datastore for persistence. It also does not rotate keys, so no overlord is required.
In this mode you provide the binary with paths to files for connectors, users, and emailer. There are example files you can use inside of `static/fixtures` named *"connectors.json.sample"*, *"users.json.sample"*, and *"emailer.json.sample"*, respectively. In this mode you provide the binary with paths to files for clients, connectors, users, and emailer. There are example files you can use inside of `static/fixtures` named *"clients.json.sample"*, *"connectors.json.sample"*, *"users.json.sample"*, and *"emailer.json.sample"*, respectively.
You can rename these to the equivalent without the *".sample"* suffix since the defaults point to those locations: You can rename these to the equivalent without the *".sample"* suffix since the defaults point to those locations:
```console ```console
cp static/fixtures/clients.json.sample static/fixtures/clients.json
cp static/fixtures/connectors.json.sample static/fixtures/connectors.json cp static/fixtures/connectors.json.sample static/fixtures/connectors.json
cp static/fixtures/users.json.sample static/fixtures/users.json cp static/fixtures/users.json.sample static/fixtures/users.json
cp static/fixtures/emailer.json.sample static/fixtures/emailer.json cp static/fixtures/emailer.json.sample static/fixtures/emailer.json

3
examples/README.md
View file

@ -14,6 +14,7 @@ Now copy the example configurations into place to get dex configured.
You can customize these later but the defaults should work fine. You can customize these later but the defaults should work fine.
```console ```console
cp static/fixtures/clients.json.sample static/fixtures/clients.json
cp static/fixtures/connectors.json.sample static/fixtures/connectors.json cp static/fixtures/connectors.json.sample static/fixtures/connectors.json
cp static/fixtures/users.json.sample static/fixtures/users.json cp static/fixtures/users.json.sample static/fixtures/users.json
cp static/fixtures/emailer.json.sample static/fixtures/emailer.json cp static/fixtures/emailer.json.sample static/fixtures/emailer.json
@ -27,7 +28,7 @@ With `dex-worker` configuration in place we can start dex in local mode.
## Example Webapp Client ## Example Webapp Client
Build and run the example app webserver by pointing the discovery URL to local Dex, and 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. supplying the client information from `./static/fixtures/clients.json` into the flags.
```console ```console

0
static/fixtures/clients.json → static/fixtures/clients.json.sample
View file