You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by te...@apache.org on 2022/04/20 05:48:18 UTC

[pulsar] branch master updated: [Improve][doc] add broker config for Oauth2 (#15201)

This is an automated email from the ASF dual-hosted git repository.

technoboy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new 5604dd5a2ec [Improve][doc] add broker config for Oauth2 (#15201)
5604dd5a2ec is described below

commit 5604dd5a2ec2c27a699a30f8c24b38b62384d5d1
Author: Xiangying Meng <55...@users.noreply.github.com>
AuthorDate: Wed Apr 20 13:48:13 2022 +0800

    [Improve][doc] add broker config for Oauth2 (#15201)
---
 site2/docs/security-oauth2.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/site2/docs/security-oauth2.md b/site2/docs/security-oauth2.md
index 7bb12ee7206..654bd5c8e9b 100644
--- a/site2/docs/security-oauth2.md
+++ b/site2/docs/security-oauth2.md
@@ -195,6 +195,20 @@ This example shows how to configure OAuth2 authentication in Node.js client.
 ```
 > Note: The support for OAuth2 authentication is only available in Node.js client 1.6.2 and later versions.
 
+## Broker configuration
+To enable OAuth2 authentication in brokers, add the following parameters to the `broker.conf` or `standalone.conf` file.
+```properties
+# Configuration to enable authentication
+authenticationEnabled=true
+authenticationProviders=org.apache.pulsar.broker.authentication.AuthenticationProviderToken
+tokenPublicKey=/path/to/publicKey
+# Authentication settings of the broker itself. Used when the broker connects to other brokers,
+# either in same or other clusters
+brokerClientAuthenticationPlugin=org.apache.pulsar.client.impl.auth.oauth2.AuthenticationOAuth2
+brokerClientAuthenticationParameters={"privateKey":"/path/to/privateKey",\
+  "audience":"https://dev-kt-aa9ne.us.auth0.com/api/v2/","issuerUrl":"https://dev-kt-aa9ne.us.auth0.com"}
+```
+
 ## CLI configuration
 
 This section describes how to use Pulsar CLI tools to connect a cluster through OAuth2 authentication plugin.