Browse Source

chore: rename the docs directory

Signed-off-by: Mark Sagi-Kazar <mark.sagikazar@gmail.com>
pull/1923/head
Mark Sagi-Kazar 5 years ago
parent
commit
0a88483409
No known key found for this signature in database
GPG Key ID: 34CC109EB5ED1C2A
  1. 4
      README.md
  2. 0
      docs/README.md
  3. 0
      docs/img/caution.png
  4. 0
      docs/img/dex-backend-flow.png
  5. 0
      docs/img/dex-flow.png
  6. 0
      docs/logos/dex-glyph-bw.png
  7. 0
      docs/logos/dex-glyph-bw.svg
  8. 0
      docs/logos/dex-glyph-color.png
  9. 0
      docs/logos/dex-glyph-color.svg
  10. 0
      docs/logos/dex-glyph-white.png
  11. 0
      docs/logos/dex-glyph-white.svg
  12. 0
      docs/logos/dex-horizontal-color.png
  13. 0
      docs/logos/dex-horizontal-color.svg
  14. 0
      docs/logos/dex-horizontal-white.png
  15. 0
      docs/logos/dex-horizontal-white.svg
  16. 2
      examples/config-dev.yaml
  17. 3
      examples/grpc-client/README.md

4
README.md

@ -5,7 +5,7 @@
[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square)](https://pkg.go.dev/mod/github.com/dexidp/dex)
[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod&style=flat-square)](https://gitpod.io/#https://github.com/dexidp/dex)
![logo](Documentation/logos/dex-horizontal-color.png)
![logo](docs/logos/dex-horizontal-color.png)
Dex is an identity service that uses [OpenID Connect][openid-connect] to drive authentication for other apps.
@ -56,7 +56,7 @@ More docs for running dex as a Kubernetes authenticator can be found [here](http
When a user logs in through dex, the user's identity is usually stored in another user-management system: a LDAP directory, a GitHub org, etc. Dex acts as a shim between a client app and the upstream identity provider. The client only needs to understand OpenID Connect to query dex, while dex implements an array of protocols for querying other user-management systems.
![](Documentation/img/dex-flow.png)
![](docs/img/dex-flow.png)
A "connector" is a strategy used by dex for authenticating a user against another identity provider. Dex implements connectors that target specific platforms such as GitHub, LinkedIn, and Microsoft as well as established protocols like LDAP and SAML.

0
Documentation/README.md → docs/README.md

0
Documentation/img/caution.png → docs/img/caution.png

Before

Width:  |  Height:  |  Size: 88 KiB

After

Width:  |  Height:  |  Size: 88 KiB

0
Documentation/img/dex-backend-flow.png → docs/img/dex-backend-flow.png

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 29 KiB

0
Documentation/img/dex-flow.png → docs/img/dex-flow.png

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 21 KiB

0
Documentation/logos/dex-glyph-bw.png → docs/logos/dex-glyph-bw.png

Before

Width:  |  Height:  |  Size: 8.0 KiB

After

Width:  |  Height:  |  Size: 8.0 KiB

0
Documentation/logos/dex-glyph-bw.svg → docs/logos/dex-glyph-bw.svg

Before

Width:  |  Height:  |  Size: 1.4 KiB

After

Width:  |  Height:  |  Size: 1.4 KiB

0
Documentation/logos/dex-glyph-color.png → docs/logos/dex-glyph-color.png

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 10 KiB

0
Documentation/logos/dex-glyph-color.svg → docs/logos/dex-glyph-color.svg

Before

Width:  |  Height:  |  Size: 1.5 KiB

After

Width:  |  Height:  |  Size: 1.5 KiB

0
Documentation/logos/dex-glyph-white.png → docs/logos/dex-glyph-white.png

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 10 KiB

0
Documentation/logos/dex-glyph-white.svg → docs/logos/dex-glyph-white.svg

Before

Width:  |  Height:  |  Size: 1.5 KiB

After

Width:  |  Height:  |  Size: 1.5 KiB

0
Documentation/logos/dex-horizontal-color.png → docs/logos/dex-horizontal-color.png

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

0
Documentation/logos/dex-horizontal-color.svg → docs/logos/dex-horizontal-color.svg

Before

Width:  |  Height:  |  Size: 4.0 KiB

After

Width:  |  Height:  |  Size: 4.0 KiB

0
Documentation/logos/dex-horizontal-white.png → docs/logos/dex-horizontal-white.png

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

0
Documentation/logos/dex-horizontal-white.svg → docs/logos/dex-horizontal-white.svg

Before

Width:  |  Height:  |  Size: 4.0 KiB

After

Width:  |  Height:  |  Size: 4.0 KiB

2
examples/config-dev.yaml

@ -6,7 +6,7 @@ issuer: http://127.0.0.1:5556/dex
# The storage configuration determines where dex stores its state. Supported
# options include SQL flavors and Kubernetes third party resources.
#
# See the storage document at Documentation/storage.md for further information.
# See the documentation (https://dexidp.io/docs/storage/) for further information.
storage:
type: sqlite3
config:

3
examples/grpc-client/README.md

@ -1,6 +1,6 @@
# Running a Dex gRPC client
Using gRPC, a client application can directly call methods on a server application as if it was a local object. The schema for Dex's gRPC API calls is defined in [`api/api.proto`][api-proto]. [`client.go`][client] is an example client program that makes a bunch of API calls to the dex server. For further details on the Dex API refer [`Documentation/api.md`][api-docs].
Using gRPC, a client application can directly call methods on a server application as if it was a local object. The schema for Dex's gRPC API calls is defined in [`api/api.proto`][api-proto]. [`client.go`][client] is an example client program that makes a bunch of API calls to the dex server. For further details on the Dex API refer the [documentation][https://dexidp.io/docs/api/].
## Generating Credentials
@ -60,4 +60,3 @@ Run the following command to destroy all the credentials files that were created
```
[api-proto]: ../../api/api.proto
[client]: client.go
[api-docs]: ../../Documentation/api.md

Loading…
Cancel
Save