Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

OAuth2/client: doc-nit: add note about running a client in a conainer #8324

Merged
merged 1 commit into from
Apr 12, 2024
Merged

OAuth2/client: doc-nit: add note about running a client in a conainer #8324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 10 additions & 4 deletions api/client/src/main/java/org/projectnessie/client/NessieConfigConstants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,10 +303,16 @@ public final class NessieConfigConstants {

/**
* Config property name ({@value #CONF_NESSIE_OAUTH2_AUTHORIZATION_CODE_FLOW_WEB_PORT}) for the
* OAuth2 authentication provider. The port used for the internal web server that listens for the
* authorization code callback. This is only used if the grant type to use is {@value
* #CONF_NESSIE_OAUTH2_GRANT_TYPE_AUTHORIZATION_CODE}. Optional; if not present, a random port
* will be used.
* OAuth2 authentication provider.
*
* <p>When running a client inside a container make sure to specify a port and forward the port to
* the container host.
*
* <p>The port used for the internal web server that listens for the authorization code callback.
* This is only used if the grant type to use is {@value
* #CONF_NESSIE_OAUTH2_GRANT_TYPE_AUTHORIZATION_CODE}.
*
* <p>Optional; if not present, a random port will be used.
*/
public static final String CONF_NESSIE_OAUTH2_AUTHORIZATION_CODE_FLOW_WEB_PORT =
"nessie.authentication.oauth2.auth-code-flow.web-port";
Expand Down
10 changes: 7 additions & 3 deletions api/client/src/main/java/org/projectnessie/client/auth/oauth2/OAuth2AuthenticatorConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,9 +312,13 @@ default Duration getAuthorizationCodeFlowTimeout() {
}

/**
* The port to use for the local web server that listens for the authorization code. Optional. If
* not set or set to zero, a random port from the dynamic client port range will be used. Only
* relevant when using the {@link GrantType#AUTHORIZATION_CODE} grant type.
* The port to use for the local web server that listens for the authorization code.
*
* <p>When running a client inside a container make sure to specify a port and forward the port to
* the container host.
*
* <p>If not set or set to zero, a random port from the dynamic client port range will be used.
* Only relevant when using the {@link GrantType#AUTHORIZATION_CODE} grant type.
*
* @see NessieConfigConstants#CONF_NESSIE_OAUTH2_AUTHORIZATION_CODE_FLOW_WEB_PORT
*/
Expand Down