Add more details about OpenID config for splinterd
Updates the splinterd man page to include more details about OpenID
OAuth configuration. Also updates the `--oauth-openid-url` CLI argument
and `OAUTH_OPENID_URL` environment variable to be in the proper
alphabetical location in the man page.
@@ -156,6 +156,10 @@ OPTIONS
`--oauth-client-secret OAUTH-CLIENT-SECRET`
: Specifies the client secret for the OAuth provider used by the REST API.
+`--oauth-openid-url OAUTH-OPENID-URL`
+: OpenID discovery document URL for the OAuth provider used by the REST API.
+ This option is required when `--oauth-provider openid` is used.
+
`--oauth-provider OAUTH-PROVIDER`
: Specifies the OAuth provider used by the REST API. Accepted values: `github`,
`openid`.
@@ -163,9 +167,6 @@ OPTIONS
`--oauth-redirect-url OAUTH-REDIRECT-URL`
: Redirect URL for the OAuth provider used by the REST API.
-`--oauth-openid-url OAUTH-OPENID-URL`
-: OpenID discovery document URL for the OAuth provider used by the REST API.
-
`--peers PEER-URL` `[,...]`
: Specifies one or more Splinter nodes that `splinterd` will automatically
connect to when it starts. The *PEER-URL* argument must specify another node's
@@ -322,7 +323,7 @@ Cylinder JWT authorization is enabled by default.
Biome credentials for the splinter REST API can be enabled using the
`--enable-biome` flag.
-The Splinter daemon provides 4 options for configuring OAuth for the REST API:
+The Splinter daemon provides 5 options for configuring OAuth for the REST API:
* `oauth-provider` for specifying the OAuth provider that splinterd will use to
get the client's identity. Currently, `github` and `openid` are supported.
@@ -336,8 +337,14 @@ The Splinter daemon provides 4 options for configuring OAuth for the REST API:
* `oauth-redirect-url` for specifying the endpoint that the OAuth provider will
redirect to when completing authentication.
-All 4 of the above arguments must be provided when using OAuth authorization. If
-some but not all of these arguments are provided, splinterd will fail to start.
+* `oauth-openid-url` for specifying the OpenID discovery document URL that will
+ be used to find the OAuth and OpenID endpoints for authentication. This option
+ is required if the `oauth-provider` option is set to `openid`; if a different
+ provider is configured, this option will have no effect.
+
+The first 4 of the above arguments (provider, client ID, client secret, and
+redirect URL) must be provided when using OAuth authorization. If some but not
+all of these 4 arguments are provided, splinterd will fail to start.
The client ID, client secret, and redirect URL must all be registered for an app
with the chosen provider. The client ID and secret are generated by the provider.
@@ -386,6 +393,10 @@ ENVIRONMENT VARIABLES
: Specifies the client secret for the OAuth provider used by the REST API. See
`--oauth-client-secret`.
+**OAUTH_OPENID_URL**
+: URL for the OpenID provider's discovery document used by the REST API. See
+ `--oauth-openid-url`.
+
**OAUTH_PROVIDER**
: Specifies the OAuth provider used by the REST API. See `--oauth-provider`.
@@ -393,10 +404,6 @@ ENVIRONMENT VARIABLES
: Redirect URL for the OAuth provider used by the REST API. See
`--oauth-redirect-url`.
-**OAUTH_OPENID_URL**
-: URL for the OpenID provider's discovery document used by the REST API. See
- `--oauth-openid-url`.
-
FILES
=====
