chore: rename the docs directory
Signed-off-by: Mark Sagi-Kazar <mark.sagikazar@gmail.com>
|
@ -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)
|
[![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)
|
[![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.
|
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.
|
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.
|
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.
|
||||||
|
|
||||||
|
|
Before Width: | Height: | Size: 88 KiB After Width: | Height: | Size: 88 KiB |
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 29 KiB |
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 21 KiB |
Before Width: | Height: | Size: 8 KiB After Width: | Height: | Size: 8 KiB |
Before Width: | Height: | Size: 1.4 KiB After Width: | Height: | Size: 1.4 KiB |
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 1.5 KiB |
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 1.5 KiB |
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
Before Width: | Height: | Size: 4 KiB After Width: | Height: | Size: 4 KiB |
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
Before Width: | Height: | Size: 4 KiB After Width: | Height: | Size: 4 KiB |
|
@ -6,7 +6,7 @@ issuer: http://127.0.0.1:5556/dex
|
||||||
# The storage configuration determines where dex stores its state. Supported
|
# The storage configuration determines where dex stores its state. Supported
|
||||||
# options include SQL flavors and Kubernetes third party resources.
|
# 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:
|
storage:
|
||||||
type: sqlite3
|
type: sqlite3
|
||||||
config:
|
config:
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Running a Dex gRPC client
|
# 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
|
## Generating Credentials
|
||||||
|
|
||||||
|
@ -60,4 +60,3 @@ Run the following command to destroy all the credentials files that were created
|
||||||
```
|
```
|
||||||
[api-proto]: ../../api/api.proto
|
[api-proto]: ../../api/api.proto
|
||||||
[client]: client.go
|
[client]: client.go
|
||||||
[api-docs]: ../../Documentation/api.md
|
|
||||||
|
|