From ed6360b03905364390fdce206860383fec5f8fa8 Mon Sep 17 00:00:00 2001 From: aeneasr <3372410+aeneasr@users.noreply.github.com> Date: Sat, 3 Oct 2020 10:44:18 +0000 Subject: [PATCH] autogen(docs): generate cli docs --- docs/docs/cli/hydra-clients-create.md | 22 +++++++-------- docs/docs/cli/hydra-clients-delete.md | 7 +++-- docs/docs/cli/hydra-clients-get.md | 7 +++-- docs/docs/cli/hydra-clients-import.md | 29 +++++++++---------- docs/docs/cli/hydra-clients-list.md | 7 +++-- docs/docs/cli/hydra-clients-update.md | 20 ++++++------- docs/docs/cli/hydra-clients.md | 18 ++++++------ docs/docs/cli/hydra-keys-create.md | 4 +-- docs/docs/cli/hydra-keys-delete.md | 4 +-- docs/docs/cli/hydra-keys-get.md | 4 +-- docs/docs/cli/hydra-keys-import.md | 22 +++++++-------- docs/docs/cli/hydra-keys.md | 13 ++++----- docs/docs/cli/hydra-migrate-sql.md | 22 +++++++-------- docs/docs/cli/hydra-migrate.md | 7 ++--- docs/docs/cli/hydra-serve-admin.md | 33 +++++++++------------- docs/docs/cli/hydra-serve-all.md | 31 +++++++++------------ docs/docs/cli/hydra-serve-public.md | 34 ++++++++++------------- docs/docs/cli/hydra-serve.md | 37 +++++++++++-------------- docs/docs/cli/hydra-token-client.md | 16 +++++------ docs/docs/cli/hydra-token-delete.md | 4 +-- docs/docs/cli/hydra-token-flush.md | 4 +-- docs/docs/cli/hydra-token-introspect.md | 4 +-- docs/docs/cli/hydra-token-revoke.md | 4 +-- docs/docs/cli/hydra-token-user.md | 17 +++++------- docs/docs/cli/hydra-token.md | 20 ++++++------- docs/docs/cli/hydra-version.md | 8 ++---- docs/docs/cli/hydra.md | 16 +++++------ 27 files changed, 187 insertions(+), 227 deletions(-) diff --git a/docs/docs/cli/hydra-clients-create.md b/docs/docs/cli/hydra-clients-create.md index 8f74acec098..658601f56ed 100644 --- a/docs/docs/cli/hydra-clients-create.md +++ b/docs/docs/cli/hydra-clients-create.md @@ -9,25 +9,24 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra clients create Create a new OAuth 2.0 Client ### Synopsis -This command creates an OAuth 2.0 Client which can be used to perform various -OAuth 2.0 Flows like the Authorize Code, Implicit, Refresh flow. +This command creates an OAuth 2.0 Client which can be used to perform various OAuth 2.0 Flows like +the Authorize Code, Implicit, Refresh flow. + +ORY Hydra implements the OpenID Connect Dynamic Client registration specification. Most flags are supported by this command +as well. -ORY Hydra implements the OpenID Connect Dynamic Client registration -specification. Most flags are supported by this command as well. +Example: + hydra clients create -n "my app" -c http://localhost/cb -g authorization_code -r code -a core,foobar -Example: hydra clients create -n "my app" -c http://localhost/cb -g -authorization_code -r code -a core,foobar +To encrypt auto generated client secret, use "--pgp-key", "--pgp-key-url" or "--keybase" flag, for example: + hydra clients create -n "my app" -g client_credentials -r token -a core,foobar --keybase keybase_username -To encrypt auto generated client secret, use "--pgp-key", "--pgp-key-url" or -"--keybase" flag, for example: hydra clients create -n "my app" -g -client_credentials -r token -a core,foobar --keybase keybase_username ``` hydra clients create [flags] @@ -72,4 +71,5 @@ hydra clients create [flags] ### SEE ALSO -- [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients +* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients + diff --git a/docs/docs/cli/hydra-clients-delete.md b/docs/docs/cli/hydra-clients-delete.md index eebe04e8c8b..c1c93572134 100644 --- a/docs/docs/cli/hydra-clients-delete.md +++ b/docs/docs/cli/hydra-clients-delete.md @@ -9,7 +9,6 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra clients delete Delete an OAuth 2.0 Client @@ -18,7 +17,8 @@ Delete an OAuth 2.0 Client This command deletes one or more OAuth 2.0 Clients by their respective IDs. -Example: hydra clients delete client-1 client-2 client-3 +Example: + hydra clients delete client-1 client-2 client-3 ``` hydra clients delete [...] [flags] @@ -43,4 +43,5 @@ hydra clients delete [...] [flags] ### SEE ALSO -- [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients +* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients + diff --git a/docs/docs/cli/hydra-clients-get.md b/docs/docs/cli/hydra-clients-get.md index 187b214b5af..0db3ace955b 100644 --- a/docs/docs/cli/hydra-clients-get.md +++ b/docs/docs/cli/hydra-clients-get.md @@ -9,7 +9,6 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra clients get Get an OAuth 2.0 Client @@ -18,7 +17,8 @@ Get an OAuth 2.0 Client This command retrieves an OAuth 2.0 Clients by its ID. -Example: hydra clients get client-1 +Example: + hydra clients get client-1 ``` hydra clients get [flags] @@ -43,4 +43,5 @@ hydra clients get [flags] ### SEE ALSO -- [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients +* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients + diff --git a/docs/docs/cli/hydra-clients-import.md b/docs/docs/cli/hydra-clients-import.md index 3802012d400..7c4712acd38 100644 --- a/docs/docs/cli/hydra-clients-import.md +++ b/docs/docs/cli/hydra-clients-import.md @@ -1,8 +1,7 @@ --- id: hydra-clients-import title: hydra clients import -description: - hydra clients import Import OAuth 2.0 Clients from one or more JSON files +description: hydra clients import Import OAuth 2.0 Clients from one or more JSON files --- - ## hydra clients import Import OAuth 2.0 Clients from one or more JSON files ### Synopsis -This command reads in each listed JSON file and imports their contents as OAuth -2.0 Clients. +This command reads in each listed JSON file and imports their contents as OAuth 2.0 Clients. The format for the JSON file is: -{ "client_id": "...", "client_secret": "...", // ... all other fields of the -OAuth 2.0 Client model are allowed here } +{ + "client_id": "...", + "client_secret": "...", + // ... all other fields of the OAuth 2.0 Client model are allowed here +} + +Please be aware that this command does not update existing clients. If the client exists already, this command will fail. -Please be aware that this command does not update existing clients. If the -client exists already, this command will fail. +Example: + hydra clients import client-1.json -Example: hydra clients import client-1.json +To encrypt auto generated client secret, use "--pgp-key", "--pgp-key-url" or "--keybase" flag, for example: + hydra clients import client-1.json --keybase keybase_username -To encrypt auto generated client secret, use "--pgp-key", "--pgp-key-url" or -"--keybase" flag, for example: hydra clients import client-1.json --keybase -keybase_username ``` hydra clients import [...] [flags] @@ -60,4 +60,5 @@ hydra clients import [...] [flags] ### SEE ALSO -- [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients +* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients + diff --git a/docs/docs/cli/hydra-clients-list.md b/docs/docs/cli/hydra-clients-list.md index 94c5dd277e8..d61dd4bf3d4 100644 --- a/docs/docs/cli/hydra-clients-list.md +++ b/docs/docs/cli/hydra-clients-list.md @@ -9,7 +9,6 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra clients list List OAuth 2.0 Clients @@ -18,7 +17,8 @@ List OAuth 2.0 Clients This command list an OAuth 2.0 Clients. -Example: hydra clients list +Example: + hydra clients list ``` hydra clients list [flags] @@ -45,4 +45,5 @@ hydra clients list [flags] ### SEE ALSO -- [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients +* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients + diff --git a/docs/docs/cli/hydra-clients-update.md b/docs/docs/cli/hydra-clients-update.md index 8205d7e9ea5..5e9591f29b4 100644 --- a/docs/docs/cli/hydra-clients-update.md +++ b/docs/docs/cli/hydra-clients-update.md @@ -9,7 +9,6 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra clients update Update an entire OAuth 2.0 Client @@ -18,17 +17,15 @@ Update an entire OAuth 2.0 Client This command replaces an OAuth 2.0 Client by its ID. -Please be aware that this command replaces the entire client. To update only the -name, a full client should be provided, for example: hydra clients update -client-1 -n "my updated app" -c http://localhost/cb -g authorization_code -r -code -a core,foobar +Please be aware that this command replaces the entire client. +To update only the name, a full client should be provided, for example: + hydra clients update client-1 -n "my updated app" -c http://localhost/cb -g authorization_code -r code -a core,foobar + +If only the name flag (-n "my updated app") is provided, the all other fields are updated to their default values. -If only the name flag (-n "my updated app") is provided, the all other fields -are updated to their default values. +To encrypt auto generated client secret, use "--pgp-key", "--pgp-key-url" or "--keybase" flag, for example: + hydra clients update client-1 -n "my updated app" -g client_credentials -r token -a core,foobar --keybase keybase_username -To encrypt auto generated client secret, use "--pgp-key", "--pgp-key-url" or -"--keybase" flag, for example: hydra clients update client-1 -n "my updated app" --g client_credentials -r token -a core,foobar --keybase keybase_username ``` hydra clients update [flags] @@ -72,4 +69,5 @@ hydra clients update [flags] ### SEE ALSO -- [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients +* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients + diff --git a/docs/docs/cli/hydra-clients.md b/docs/docs/cli/hydra-clients.md index 644d9a59394..c30d0aeb20f 100644 --- a/docs/docs/cli/hydra-clients.md +++ b/docs/docs/cli/hydra-clients.md @@ -9,7 +9,6 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra clients Manage OAuth 2.0 Clients @@ -37,12 +36,11 @@ Manage OAuth 2.0 Clients ### SEE ALSO -- [hydra](hydra) - Run and manage ORY Hydra -- [hydra clients create](hydra-clients-create) - Create a new OAuth 2.0 Client -- [hydra clients delete](hydra-clients-delete) - Delete an OAuth 2.0 Client -- [hydra clients get](hydra-clients-get) - Get an OAuth 2.0 Client -- [hydra clients import](hydra-clients-import) - Import OAuth 2.0 Clients from - one or more JSON files -- [hydra clients list](hydra-clients-list) - List OAuth 2.0 Clients -- [hydra clients update](hydra-clients-update) - Update an entire OAuth 2.0 - Client +* [hydra](hydra) - Run and manage ORY Hydra +* [hydra clients create](hydra-clients-create) - Create a new OAuth 2.0 Client +* [hydra clients delete](hydra-clients-delete) - Delete an OAuth 2.0 Client +* [hydra clients get](hydra-clients-get) - Get an OAuth 2.0 Client +* [hydra clients import](hydra-clients-import) - Import OAuth 2.0 Clients from one or more JSON files +* [hydra clients list](hydra-clients-list) - List OAuth 2.0 Clients +* [hydra clients update](hydra-clients-update) - Update an entire OAuth 2.0 Client + diff --git a/docs/docs/cli/hydra-keys-create.md b/docs/docs/cli/hydra-keys-create.md index 3df8c2cbc9e..7b432528418 100644 --- a/docs/docs/cli/hydra-keys-create.md +++ b/docs/docs/cli/hydra-keys-create.md @@ -9,7 +9,6 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra keys create Create a new JSON Web Key Set @@ -43,4 +42,5 @@ hydra keys create [flags] ### SEE ALSO -- [hydra keys](hydra-keys) - Manage JSON Web Keys +* [hydra keys](hydra-keys) - Manage JSON Web Keys + diff --git a/docs/docs/cli/hydra-keys-delete.md b/docs/docs/cli/hydra-keys-delete.md index 99effb36dbb..555fb379946 100644 --- a/docs/docs/cli/hydra-keys-delete.md +++ b/docs/docs/cli/hydra-keys-delete.md @@ -9,7 +9,6 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra keys delete Delete a new JSON Web Key Set @@ -41,4 +40,5 @@ hydra keys delete [flags] ### SEE ALSO -- [hydra keys](hydra-keys) - Manage JSON Web Keys +* [hydra keys](hydra-keys) - Manage JSON Web Keys + diff --git a/docs/docs/cli/hydra-keys-get.md b/docs/docs/cli/hydra-keys-get.md index 56ee353b7ef..4528a439583 100644 --- a/docs/docs/cli/hydra-keys-get.md +++ b/docs/docs/cli/hydra-keys-get.md @@ -9,7 +9,6 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra keys get Get a new JSON Web Key Set @@ -41,4 +40,5 @@ hydra keys get [flags] ### SEE ALSO -- [hydra keys](hydra-keys) - Manage JSON Web Keys +* [hydra keys](hydra-keys) - Manage JSON Web Keys + diff --git a/docs/docs/cli/hydra-keys-import.md b/docs/docs/cli/hydra-keys-import.md index 7a216b7d423..d6835a6c2da 100644 --- a/docs/docs/cli/hydra-keys-import.md +++ b/docs/docs/cli/hydra-keys-import.md @@ -1,9 +1,7 @@ --- id: hydra-keys-import title: hydra keys import -description: - hydra keys import Imports cryptographic keys of any format to the JSON Web Key - Store +description: hydra keys import Imports cryptographic keys of any format to the JSON Web Key Store --- - ## hydra keys import Imports cryptographic keys of any format to the JSON Web Key Store @@ -20,15 +17,15 @@ Imports cryptographic keys of any format to the JSON Web Key Store This command allows you to import cryptographic keys to the JSON Web Key Store. -Currently supported formats are raw JSON Web Keys or PEM/DER encoded data. If -the JSON Web Key Set exists already, the imported keys will be added to that -set. Otherwise, a new set will be created. +Currently supported formats are raw JSON Web Keys or PEM/DER encoded data. If the JSON Web Key Set exists already, +the imported keys will be added to that set. Otherwise, a new set will be created. + +Please be aware that importing a private key does not automatically import its public key as well. -Please be aware that importing a private key does not automatically import its -public key as well. +Examples: + hydra keys import my-set ./path/to/jwk.json ./path/to/jwk-2.json + hydra keys import my-set ./path/to/rsa.key ./path/to/rsa.pub -Examples: hydra keys import my-set ./path/to/jwk.json ./path/to/jwk-2.json hydra -keys import my-set ./path/to/rsa.key ./path/to/rsa.pub ``` hydra keys import [ []]] [flags] @@ -54,4 +51,5 @@ hydra keys import [ []]] [flags] ### SEE ALSO -- [hydra keys](hydra-keys) - Manage JSON Web Keys +* [hydra keys](hydra-keys) - Manage JSON Web Keys + diff --git a/docs/docs/cli/hydra-keys.md b/docs/docs/cli/hydra-keys.md index e5b863fedf2..70a5e19578a 100644 --- a/docs/docs/cli/hydra-keys.md +++ b/docs/docs/cli/hydra-keys.md @@ -9,7 +9,6 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra keys Manage JSON Web Keys @@ -37,9 +36,9 @@ Manage JSON Web Keys ### SEE ALSO -- [hydra](hydra) - Run and manage ORY Hydra -- [hydra keys create](hydra-keys-create) - Create a new JSON Web Key Set -- [hydra keys delete](hydra-keys-delete) - Delete a new JSON Web Key Set -- [hydra keys get](hydra-keys-get) - Get a new JSON Web Key Set -- [hydra keys import](hydra-keys-import) - Imports cryptographic keys of any - format to the JSON Web Key Store +* [hydra](hydra) - Run and manage ORY Hydra +* [hydra keys create](hydra-keys-create) - Create a new JSON Web Key Set +* [hydra keys delete](hydra-keys-delete) - Delete a new JSON Web Key Set +* [hydra keys get](hydra-keys-get) - Get a new JSON Web Key Set +* [hydra keys import](hydra-keys-import) - Imports cryptographic keys of any format to the JSON Web Key Store + diff --git a/docs/docs/cli/hydra-migrate-sql.md b/docs/docs/cli/hydra-migrate-sql.md index 57dd2f9a228..95300527afe 100644 --- a/docs/docs/cli/hydra-migrate-sql.md +++ b/docs/docs/cli/hydra-migrate-sql.md @@ -9,28 +9,27 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra migrate sql Create SQL schemas and apply migration plans ### Synopsis -Run this command on a fresh SQL installation and when you upgrade Hydra to a new -minor version. For example, upgrading Hydra 0.7.0 to 0.8.0 requires running this -command. +Run this command on a fresh SQL installation and when you upgrade Hydra to a new minor version. For example, +upgrading Hydra 0.7.0 to 0.8.0 requires running this command. -It is recommended to run this command close to the SQL instance (e.g. same -subnet) instead of over the public internet. This decreases risk of failure and -decreases time required. +It is recommended to run this command close to the SQL instance (e.g. same subnet) instead of over the public internet. +This decreases risk of failure and decreases time required. -You can read in the database URL using the -e flag, for example: export DSN=... -hydra migrate sql -e +You can read in the database URL using the -e flag, for example: + export DSN=... + hydra migrate sql -e -### WARNING +### WARNING ### Before running this command on an existing database, create a back up! + ``` hydra migrate sql [flags] ``` @@ -52,4 +51,5 @@ hydra migrate sql [flags] ### SEE ALSO -- [hydra migrate](hydra-migrate) - Various migration helpers +* [hydra migrate](hydra-migrate) - Various migration helpers + diff --git a/docs/docs/cli/hydra-migrate.md b/docs/docs/cli/hydra-migrate.md index c0bf1789b97..11d2c2bee74 100644 --- a/docs/docs/cli/hydra-migrate.md +++ b/docs/docs/cli/hydra-migrate.md @@ -9,7 +9,6 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra migrate Various migration helpers @@ -33,6 +32,6 @@ Various migration helpers ### SEE ALSO -- [hydra](hydra) - Run and manage ORY Hydra -- [hydra migrate sql](hydra-migrate-sql) - Create SQL schemas and apply - migration plans +* [hydra](hydra) - Run and manage ORY Hydra +* [hydra migrate sql](hydra-migrate-sql) - Create SQL schemas and apply migration plans + diff --git a/docs/docs/cli/hydra-serve-admin.md b/docs/docs/cli/hydra-serve-admin.md index cb89ba659cb..f306eab837a 100644 --- a/docs/docs/cli/hydra-serve-admin.md +++ b/docs/docs/cli/hydra-serve-admin.md @@ -9,37 +9,30 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra serve admin Serves Administrative HTTP/2 APIs ### Synopsis -This command opens one port and listens to HTTP/2 API requests. The exposed API -handles administrative requests like managing OAuth 2.0 Clients, JSON Web Keys, -login and consent sessions, and others. +This command opens one port and listens to HTTP/2 API requests. The exposed API handles administrative +requests like managing OAuth 2.0 Clients, JSON Web Keys, login and consent sessions, and others. -This command is configurable using the same options available to "serve public" -and "serve all". +This command is configurable using the same options available to "serve public" and "serve all". -It is generally recommended to use this command only if you require granular -control over the administrative and public APIs. For example, you might want to -run different TLS certificates or CORS settings on the public and administrative -API. +It is generally recommended to use this command only if you require granular control over the administrative and public APIs. +For example, you might want to run different TLS certificates or CORS settings on the public and administrative API. -This command does not work with the "memory" database. Both services -(administrative, public) MUST use the same database connection to be able to -synchronize. +This command does not work with the "memory" database. Both services (administrative, public) MUST use the same database +connection to be able to synchronize. ## Configuration -ORY Hydra can be configured using environment variables as well as a -configuration file. For more information on configuration options, open the -configuration documentation: +ORY Hydra can be configured using environment variables as well as a configuration file. For more information +on configuration options, open the configuration documentation: + +>> https://github.com/ory/hydra/blob/undefined/docs/docs/reference/configuration.md << -> > https://github.com/ory/hydra/blob/undefined/docs/docs/reference/configuration.md -> > << ``` hydra serve admin [flags] @@ -64,5 +57,5 @@ hydra serve admin [flags] ### SEE ALSO -- [hydra serve](hydra-serve) - Parent command for starting public and - administrative HTTP/2 APIs +* [hydra serve](hydra-serve) - Parent command for starting public and administrative HTTP/2 APIs + diff --git a/docs/docs/cli/hydra-serve-all.md b/docs/docs/cli/hydra-serve-all.md index e335af8dd99..4ee1a0e9631 100644 --- a/docs/docs/cli/hydra-serve-all.md +++ b/docs/docs/cli/hydra-serve-all.md @@ -9,36 +9,31 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra serve all Serves both public and administrative HTTP/2 APIs ### Synopsis -Starts a process which listens on two ports for public and administrative HTTP/2 -API requests. +Starts a process which listens on two ports for public and administrative HTTP/2 API requests. -If you want more granular control (e.g. different TLS settings) over each API -group (administrative, public) you can run "serve admin" and "serve public" -separately. +If you want more granular control (e.g. different TLS settings) over each API group (administrative, public) you +can run "serve admin" and "serve public" separately. This command exposes a variety of controls via environment variables. You can -set environments using "export KEY=VALUE" (Linux/macOS) or "set KEY=VALUE" -(Windows). On Linux, you can also set environments by prepending key value -pairs: "KEY=VALUE KEY2=VALUE2 hydra" +set environments using "export KEY=VALUE" (Linux/macOS) or "set KEY=VALUE" (Windows). On Linux, +you can also set environments by prepending key value pairs: "KEY=VALUE KEY2=VALUE2 hydra" -All possible controls are listed below. This command exposes exposes command -line flags, which are listed below the controls section. +All possible controls are listed below. This command exposes exposes command line flags, which are listed below +the controls section. ## Configuration -ORY Hydra can be configured using environment variables as well as a -configuration file. For more information on configuration options, open the -configuration documentation: +ORY Hydra can be configured using environment variables as well as a configuration file. For more information +on configuration options, open the configuration documentation: + +>> https://github.com/ory/hydra/blob/undefined/docs/docs/reference/configuration.md << -> > https://github.com/ory/hydra/blob/undefined/docs/docs/reference/configuration.md -> > << ``` hydra serve all [flags] @@ -63,5 +58,5 @@ hydra serve all [flags] ### SEE ALSO -- [hydra serve](hydra-serve) - Parent command for starting public and - administrative HTTP/2 APIs +* [hydra serve](hydra-serve) - Parent command for starting public and administrative HTTP/2 APIs + diff --git a/docs/docs/cli/hydra-serve-public.md b/docs/docs/cli/hydra-serve-public.md index 0b765607a27..7e70fe2959f 100644 --- a/docs/docs/cli/hydra-serve-public.md +++ b/docs/docs/cli/hydra-serve-public.md @@ -9,37 +9,31 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra serve public Serves Public HTTP/2 APIs ### Synopsis -This command opens one port and listens to HTTP/2 API requests. The exposed API -handles requests coming from the public internet, like OAuth 2.0 Authorization -and Token requests, OpenID Connect UserInfo, OAuth 2.0 Token Revokation, and -OpenID Connect Discovery. +This command opens one port and listens to HTTP/2 API requests. The exposed API handles requests coming from +the public internet, like OAuth 2.0 Authorization and Token requests, OpenID Connect UserInfo, OAuth 2.0 Token Revokation, +and OpenID Connect Discovery. -This command is configurable using the same options available to "serve admin" -and "serve all". +This command is configurable using the same options available to "serve admin" and "serve all". -It is generally recommended to use this command only if you require granular -control over the privileged and public APIs. For example, you might want to run -different TLS certificates or CORS settings on the public and privileged API. +It is generally recommended to use this command only if you require granular control over the privileged and public APIs. +For example, you might want to run different TLS certificates or CORS settings on the public and privileged API. -This command does not work with the "memory" database. Both services -(privileged, public) MUST use the same database connection to be able to -synchronize. +This command does not work with the "memory" database. Both services (privileged, public) MUST use the same database +connection to be able to synchronize. ## Configuration -ORY Hydra can be configured using environment variables as well as a -configuration file. For more information on configuration options, open the -configuration documentation: +ORY Hydra can be configured using environment variables as well as a configuration file. For more information +on configuration options, open the configuration documentation: + +>> https://github.com/ory/hydra/blob/undefined/docs/docs/reference/configuration.md << -> > https://github.com/ory/hydra/blob/undefined/docs/docs/reference/configuration.md -> > << ``` hydra serve public [flags] @@ -64,5 +58,5 @@ hydra serve public [flags] ### SEE ALSO -- [hydra serve](hydra-serve) - Parent command for starting public and - administrative HTTP/2 APIs +* [hydra serve](hydra-serve) - Parent command for starting public and administrative HTTP/2 APIs + diff --git a/docs/docs/cli/hydra-serve.md b/docs/docs/cli/hydra-serve.md index 0200afc57f3..3240afeba22 100644 --- a/docs/docs/cli/hydra-serve.md +++ b/docs/docs/cli/hydra-serve.md @@ -1,8 +1,7 @@ --- id: hydra-serve title: hydra serve -description: - hydra serve Parent command for starting public and administrative HTTP/2 APIs +description: hydra serve Parent command for starting public and administrative HTTP/2 APIs --- - ## hydra serve Parent command for starting public and administrative HTTP/2 APIs ### Synopsis -ORY Hydra exposes two ports, a public and an administrative port. The public -port is responsible for handling requests from the public internet, such as the -OAuth 2.0 Authorize and Token URLs. The administrative port handles -administrative requests like creating OAuth 2.0 Clients, managing JSON Web Keys, -and managing User Login and Consent sessions. +ORY Hydra exposes two ports, a public and an administrative port. The public port is responsible +for handling requests from the public internet, such as the OAuth 2.0 Authorize and Token URLs. The administrative +port handles administrative requests like creating OAuth 2.0 Clients, managing JSON Web Keys, and managing User Login +and Consent sessions. -It is recommended to run "hydra serve all". If you need granular control over -CORS settings or similar, you may want to run "hydra serve admin" and "hydra -serve public" separately. +It is recommended to run "hydra serve all". If you need granular control over CORS settings or similar, you may +want to run "hydra serve admin" and "hydra serve public" separately. To learn more about each individual command, run: @@ -37,12 +33,11 @@ All sub-commands share command line flags and configuration options. ## Configuration -ORY Hydra can be configured using environment variables as well as a -configuration file. For more information on configuration options, open the -configuration documentation: +ORY Hydra can be configured using environment variables as well as a configuration file. For more information +on configuration options, open the configuration documentation: + +>> https://github.com/ory/hydra/blob/undefined/docs/docs/reference/configuration.md << -> > https://github.com/ory/hydra/blob/undefined/docs/docs/reference/configuration.md -> > << ### Options @@ -63,8 +58,8 @@ configuration documentation: ### SEE ALSO -- [hydra](hydra) - Run and manage ORY Hydra -- [hydra serve admin](hydra-serve-admin) - Serves Administrative HTTP/2 APIs -- [hydra serve all](hydra-serve-all) - Serves both public and administrative - HTTP/2 APIs -- [hydra serve public](hydra-serve-public) - Serves Public HTTP/2 APIs +* [hydra](hydra) - Run and manage ORY Hydra +* [hydra serve admin](hydra-serve-admin) - Serves Administrative HTTP/2 APIs +* [hydra serve all](hydra-serve-all) - Serves both public and administrative HTTP/2 APIs +* [hydra serve public](hydra-serve-public) - Serves Public HTTP/2 APIs + diff --git a/docs/docs/cli/hydra-token-client.md b/docs/docs/cli/hydra-token-client.md index b50406f6cab..60bb4ad5a61 100644 --- a/docs/docs/cli/hydra-token-client.md +++ b/docs/docs/cli/hydra-token-client.md @@ -1,9 +1,7 @@ --- id: hydra-token-client title: hydra token client -description: - hydra token client An exemplary OAuth 2.0 Client performing the OAuth 2.0 - Client Credentials Flow +description: hydra token client An exemplary OAuth 2.0 Client performing the OAuth 2.0 Client Credentials Flow --- - ## hydra token client An exemplary OAuth 2.0 Client performing the OAuth 2.0 Client Credentials Flow ### Synopsis -Performs the OAuth 2.0 Client Credentials Flow. This command will help you to -see if ORY Hydra has been configured properly. +Performs the OAuth 2.0 Client Credentials Flow. This command will help you to see if ORY Hydra has +been configured properly. -This command should not be used for anything else than manual testing or demo -purposes. The server will terminate on error and success. +This command should not be used for anything else than manual testing or demo purposes. The server will terminate on error +and success. ``` hydra token client [flags] @@ -51,4 +48,5 @@ hydra token client [flags] ### SEE ALSO -- [hydra token](hydra-token) - Issue and Manage OAuth2 tokens +* [hydra token](hydra-token) - Issue and Manage OAuth2 tokens + diff --git a/docs/docs/cli/hydra-token-delete.md b/docs/docs/cli/hydra-token-delete.md index d631eecd170..883ecb110c6 100644 --- a/docs/docs/cli/hydra-token-delete.md +++ b/docs/docs/cli/hydra-token-delete.md @@ -9,7 +9,6 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra token delete Deletes access tokens of a client @@ -42,4 +41,5 @@ hydra token delete [flags] ### SEE ALSO -- [hydra token](hydra-token) - Issue and Manage OAuth2 tokens +* [hydra token](hydra-token) - Issue and Manage OAuth2 tokens + diff --git a/docs/docs/cli/hydra-token-flush.md b/docs/docs/cli/hydra-token-flush.md index 4b28fd6a7fc..1f6637e47fb 100644 --- a/docs/docs/cli/hydra-token-flush.md +++ b/docs/docs/cli/hydra-token-flush.md @@ -9,7 +9,6 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra token flush Removes inactive access tokens from the database @@ -42,4 +41,5 @@ hydra token flush [flags] ### SEE ALSO -- [hydra token](hydra-token) - Issue and Manage OAuth2 tokens +* [hydra token](hydra-token) - Issue and Manage OAuth2 tokens + diff --git a/docs/docs/cli/hydra-token-introspect.md b/docs/docs/cli/hydra-token-introspect.md index 38f0480c39c..bc4f62446d0 100644 --- a/docs/docs/cli/hydra-token-introspect.md +++ b/docs/docs/cli/hydra-token-introspect.md @@ -9,7 +9,6 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra token introspect Introspect an access or refresh token @@ -44,4 +43,5 @@ hydra token introspect [flags] ### SEE ALSO -- [hydra token](hydra-token) - Issue and Manage OAuth2 tokens +* [hydra token](hydra-token) - Issue and Manage OAuth2 tokens + diff --git a/docs/docs/cli/hydra-token-revoke.md b/docs/docs/cli/hydra-token-revoke.md index 6d6c2a55872..b2d17c4e6e2 100644 --- a/docs/docs/cli/hydra-token-revoke.md +++ b/docs/docs/cli/hydra-token-revoke.md @@ -9,7 +9,6 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra token revoke Revoke an access or refresh token @@ -42,4 +41,5 @@ hydra token revoke [flags] ### SEE ALSO -- [hydra token](hydra-token) - Issue and Manage OAuth2 tokens +* [hydra token](hydra-token) - Issue and Manage OAuth2 tokens + diff --git a/docs/docs/cli/hydra-token-user.md b/docs/docs/cli/hydra-token-user.md index 3166c544711..29a6e216ae9 100644 --- a/docs/docs/cli/hydra-token-user.md +++ b/docs/docs/cli/hydra-token-user.md @@ -1,9 +1,7 @@ --- id: hydra-token-user title: hydra token user -description: - hydra token user An exemplary OAuth 2.0 Client performing the OAuth 2.0 - Authorize Code Flow +description: hydra token user An exemplary OAuth 2.0 Client performing the OAuth 2.0 Authorize Code Flow --- - ## hydra token user An exemplary OAuth 2.0 Client performing the OAuth 2.0 Authorize Code Flow ### Synopsis -Starts an exemplary web server that acts as an OAuth 2.0 Client performing the -Authorize Code Flow. This command will help you to see if ORY Hydra has been -configured properly. +Starts an exemplary web server that acts as an OAuth 2.0 Client performing the Authorize Code Flow. +This command will help you to see if ORY Hydra has been configured properly. -This command must not be used for anything else than manual testing or demo -purposes. The server will terminate on error and success. +This command must not be used for anything else than manual testing or demo purposes. The server will terminate on error +and success. ``` hydra token user [flags] @@ -59,4 +55,5 @@ hydra token user [flags] ### SEE ALSO -- [hydra token](hydra-token) - Issue and Manage OAuth2 tokens +* [hydra token](hydra-token) - Issue and Manage OAuth2 tokens + diff --git a/docs/docs/cli/hydra-token.md b/docs/docs/cli/hydra-token.md index 333ba62f62b..828f2c822e9 100644 --- a/docs/docs/cli/hydra-token.md +++ b/docs/docs/cli/hydra-token.md @@ -9,7 +9,6 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra token Issue and Manage OAuth2 tokens @@ -35,14 +34,11 @@ Issue and Manage OAuth2 tokens ### SEE ALSO -- [hydra](hydra) - Run and manage ORY Hydra -- [hydra token client](hydra-token-client) - An exemplary OAuth 2.0 Client - performing the OAuth 2.0 Client Credentials Flow -- [hydra token delete](hydra-token-delete) - Deletes access tokens of a client -- [hydra token flush](hydra-token-flush) - Removes inactive access tokens from - the database -- [hydra token introspect](hydra-token-introspect) - Introspect an access or - refresh token -- [hydra token revoke](hydra-token-revoke) - Revoke an access or refresh token -- [hydra token user](hydra-token-user) - An exemplary OAuth 2.0 Client - performing the OAuth 2.0 Authorize Code Flow +* [hydra](hydra) - Run and manage ORY Hydra +* [hydra token client](hydra-token-client) - An exemplary OAuth 2.0 Client performing the OAuth 2.0 Client Credentials Flow +* [hydra token delete](hydra-token-delete) - Deletes access tokens of a client +* [hydra token flush](hydra-token-flush) - Removes inactive access tokens from the database +* [hydra token introspect](hydra-token-introspect) - Introspect an access or refresh token +* [hydra token revoke](hydra-token-revoke) - Revoke an access or refresh token +* [hydra token user](hydra-token-user) - An exemplary OAuth 2.0 Client performing the OAuth 2.0 Authorize Code Flow + diff --git a/docs/docs/cli/hydra-version.md b/docs/docs/cli/hydra-version.md index 0aaa97d4668..3512b980b43 100644 --- a/docs/docs/cli/hydra-version.md +++ b/docs/docs/cli/hydra-version.md @@ -1,9 +1,7 @@ --- id: hydra-version title: hydra version -description: - hydra version Display this binary's version, build time and git hash of this - build +description: hydra version Display this binary's version, build time and git hash of this build --- - ## hydra version Display this binary's version, build time and git hash of this build @@ -39,4 +36,5 @@ hydra version [flags] ### SEE ALSO -- [hydra](hydra) - Run and manage ORY Hydra +* [hydra](hydra) - Run and manage ORY Hydra + diff --git a/docs/docs/cli/hydra.md b/docs/docs/cli/hydra.md index 4f5d47853fe..e7bcb238f31 100644 --- a/docs/docs/cli/hydra.md +++ b/docs/docs/cli/hydra.md @@ -9,7 +9,6 @@ This file is auto-generated. To improve this file please make your change against the appropriate "./cmd/*.go" file. --> - ## hydra Run and manage ORY Hydra @@ -28,11 +27,10 @@ Run and manage ORY Hydra ### SEE ALSO -- [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients -- [hydra keys](hydra-keys) - Manage JSON Web Keys -- [hydra migrate](hydra-migrate) - Various migration helpers -- [hydra serve](hydra-serve) - Parent command for starting public and - administrative HTTP/2 APIs -- [hydra token](hydra-token) - Issue and Manage OAuth2 tokens -- [hydra version](hydra-version) - Display this binary's version, build time and - git hash of this build +* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients +* [hydra keys](hydra-keys) - Manage JSON Web Keys +* [hydra migrate](hydra-migrate) - Various migration helpers +* [hydra serve](hydra-serve) - Parent command for starting public and administrative HTTP/2 APIs +* [hydra token](hydra-token) - Issue and Manage OAuth2 tokens +* [hydra version](hydra-version) - Display this binary's version, build time and git hash of this build +