Repository navigation
docs(config): document auth.admin_pa_file #526
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.
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
Closed
Closed
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Important: the fallback half of the version note added in 877f8f4 is wrong for part of the range it names. The earlier request on 5d97063 to say that
auth.admin_pastill has to be set was checked against master only, not the release tags, and it does not hold for them:auth.admin_paexists only from 1.7.0, and 1.7.0 reads it on the PD startup path only.Evidence, apache/hugegraph release tags:
git grep admin_pa <tag>finds nothing, soauth.admin_pais as unknown there asauth.admin_pa_file(at 1.5.0HugeConfig.addPropertyDirectlogs the sameThe config option '{}' is redundantwarning for it). The admin password comes from theinit-store.shprompt (StandardAuthenticator.initAdminUser()callsinputPassword()), or fromauth.admin_tokenon the memory backend (GraphManager.java:439-441at 1.5.0).ServerOptions.ADMIN_PAis inGraphManager.loadMetaFromPD()(GraphManager.java:364). On the memory backend, the only non-persistent one,checkBackendVersionOrExitstill runsinitAdminUser(config.get(ServerOptions.AUTH_ADMIN_TOKEN))(GraphManager.java:1614-1616), andauth.admin_tokendefaults to the public162f7848-0b6d-4faf-b557-3a0797869c55(ServerOptions.java:487). That path moved toauth.admin_pain a93cc218d (#2927, 2026-01-04), which no release tag contains.So on 1.7.0 with the memory backend and auth on, an operator who follows this row and sets
auth.admin_pastill gets an admin whose password is theauth.admin_tokenvalue. The sentence is right for 1.7.0 with PD (hstore).Requested change: in this row and the CN row (
content/cn/docs/config/config-option.md:72), replace the fallback sentence with what the releases do, for example: "Versions after 1.7.0 only. A 1.7.0 or earlier Server ignores this key, logging only a warning, and creates admin as before: from theinit-store.shprompt on local persistent backends, fromauth.admin_pa(defaultpa) on 1.7.0 with PD (hstore), and fromauth.admin_token(public default) on the memory backend.auth.admin_padoes not exist before 1.7.0." In the two properties comments (content/en/docs/config/config-authentication.md:103,content/cn/docs/config/config-authentication.md:98), keep "older Servers ignore this key" and point to the option table instead of "still need auth.admin_pa". In the two hstore paragraphs (content/en/docs/config/config-backend-hstore.md:183,content/cn/docs/config/config-backend-hstore.md:151), change "1.7.0 or earlier" / "1.7.0 及更早版本" to 1.7.0, since those paragraphs are about PD.