Skip to content

fix password in README.md for ./gradlew run #2572

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

Merged
dimas-b merged 1 commit into from
Sep 15, 2025
Merged

fix password in README.md for ./gradlew run #2572

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Apache Polaris is built using Gradle with Java 21+ and Docker 27+.
- `./gradlew build` - To build and run tests. Make sure Docker is running, as the integration tests depend on it.
- `./gradlew assemble` - To skip tests.
- `./gradlew check` - To run all checks, including unit tests and integration tests.
- `./gradlew run` - To run the Polaris server locally; the server is reachable at localhost:8181. This is also suitable for running regression tests, or for connecting with Spark. Set your own credentials by specifying system property `./gradlew run -Dpolaris.bootstrap.credentials=POLARIS,root,secret` where:
- `./gradlew run` - To run the Polaris server locally; the server is reachable at localhost:8181. This is also suitable for running regression tests, or for connecting with Spark. Set your own credentials by specifying system property `./gradlew run -Dpolaris.bootstrap.credentials=POLARIS,root,s3cr3t` where:
Copy link
Contributor Author

@dimas-b dimas-b Sep 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cf.

polaris/runtime/server/build.gradle.kts

Line 81 in b6e247d

"-Dpolaris.bootstrap.credentials=POLARIS,root,s3cr3t",

Copy link
Contributor

@flyrain flyrain Sep 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was changed to secret by #2558. I think using secret instead of s3cr3t makes more sense. The command here is to show how to set your own credentials. This part is only required when a custom credential needed Dpolaris.bootstrap.credentials=POLARIS,root,s3cr3t, without it, the default value is still root, s3cr3t.

Another reason to use secret is that the follow doc says that:

root is the CLIENT_ID
secret is the CLIENT_SECRET

Copy link
Contributor Author

@dimas-b dimas-b Sep 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, apparently I misinterpreted 🤦 will revert momentarily

Copy link
Contributor Author

@dimas-b dimas-b Sep 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#2576

- `POLARIS` is the realm
- `root` is the CLIENT_ID
- `secret` is the CLIENT_SECRET
Expand Down