Skip to content

Commit

Permalink
[#2042] improvement(doc): Unify the style of configuration options (#…
Browse files Browse the repository at this point in the history
…2043)

<!--
1. Title: [#<issue>] <type>(<scope>): <subject>
   Examples:
     - "[#123] feat(operator): support xxx"
     - "[#233] fix: check null before access result in xxx"
     - "[MINOR] refactor: fix typo in variable name"
     - "[MINOR] docs: fix typo in README"
     - "[#255] test: fix flaky test NameOfTheTest"
   Reference: https://www.conventionalcommits.org/en/v1.0.0/
2. If the PR is unfinished, please mark this PR as draft.
-->

### What changes were proposed in this pull request?

Unify the style of configuration options

### Why are the changes needed?

Fix: #2042 

### Does this PR introduce _any_ user-facing change?

No.

### How was this patch tested?

Just doc.

Co-authored-by: Heng Qin <qqtt@123.com>
  • Loading branch information
qqqttt123 and Heng Qin authored Feb 4, 2024
1 parent 801df01 commit a9dd794
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,11 +146,11 @@ You can follow the steps to set up an OAuth mode Gravitino server.
6. You can refer to the [Configurations](gravitino-server-config.md) and append the configurations to the conf/gravitino.conf.

```text
gravitino.authenticator oauth
gravitino.authenticator.oauth.serviceAudience test
gravitino.authenticator.oauth.defaultSignKey <the default signing key>
gravitino.authenticator.oauth.tokenPath /oauth2/token
gravitino.authenticator.oauth.serverUri http://localhost:8177
gravitino.authenticator = oauth
gravitino.authenticator.oauth.serviceAudience = test
gravitino.authenticator.oauth.defaultSignKey = <the default signing key>
gravitino.authenticator.oauth.tokenPath = /oauth2/token
gravitino.authenticator.oauth.serverUri = http://localhost:8177
```

7. Open [the URL of Gravitino server](http://localhost:8090) and login in with clientId `test`, clientSecret `test`, and scope `test`.
Expand Down Expand Up @@ -258,11 +258,11 @@ Configuration doesn't support resolving environment variables, so you should rep
Then, You can start the Gravitino server.

```text
gravitino.server.webserver.host localhost
gravitino.server.webserver.enableHttps true
gravitino.server.webserver.keyStorePath ${JAVA_HOME}/localhost.jks
gravitino.server.webserver.keyStorePassword localhost
gravitino.server.webserver.managerPassword localhost
gravitino.server.webserver.host = localhost
gravitino.server.webserver.enableHttps = true
gravitino.server.webserver.keyStorePath = ${JAVA_HOME}/localhost.jks
gravitino.server.webserver.keyStorePassword = localhost
gravitino.server.webserver.managerPassword = localhost
```

6. Request the Gravitino server
Expand Down

0 comments on commit a9dd794

Please sign in to comment.