-
Notifications
You must be signed in to change notification settings - Fork 99
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
chore(website): remove config auth mode doc #300
Conversation
# Conflicts: # content/cn/docs/clients/restful-api/metrics.md # content/en/docs/clients/restful-api/metrics.md
然后详细的权限 API 调用和说明请参考 [Authentication-API](/docs/clients/restful-api/auth) 文档 | ||
|
||
#### ConfigAuthenticator 模式 | ||
|
||
`ConfigAuthenticator`模式是通过预先在配置文件中设置用户信息来支持用户认证,该实现是基于配置好的静态`tokens`来验证用户是否合法。下面是具体的配置流程(重启服务生效): | ||
|
||
在配置文件`gremlin-server.yaml`中配置`authenticator`及其`rest-server`文件路径: | ||
|
||
```yaml | ||
authentication: { | ||
authenticator: org.apache.hugegraph.auth.ConfigAuthenticator, | ||
authenticationHandler: org.apache.hugegraph.auth.WsAndHttpBasicAuthHandler, | ||
config: {tokens: conf/rest-server.properties} | ||
} | ||
``` | ||
|
||
在配置文件`rest-server.properties`中配置`authenticator`及其`tokens`信息: | ||
|
||
```properties | ||
auth.authenticator=org.apache.hugegraph.auth.ConfigAuthenticator | ||
auth.admin_token=token-value-a | ||
auth.user_tokens=[hugegraph1:token-value-1, hugegraph2:token-value-2] | ||
``` | ||
|
||
在配置文件`hugegraph{n}.properties`中配置`gremlin.graph`信息: | ||
|
||
```properties | ||
gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy | ||
``` |
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.
shall we mark them as outdated
& put them in a single space? (or just delete them? @javeme )
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.
shall we mark them as
outdated
& put them in a single space? (or just delete them? @javeme )
i think we just delete it; In the future the best method is do whole doc's version control overall,not mark the specific change;
and another way , we can record doc change log
, like current Hugegraph Release change log
cc @javeme
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.
Is the ConfigAuthenticator still available? I think we can delete this doc if NO or mark outdated if YES.
The version control of documents is the direction we need to move towards.
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.
shall we mark them as
outdated
& put them in a single space? (or just delete them? @javeme )i think we just delete it; In the future the best method is do whole doc's version control overall,not mark the specific change;
and another way , we can record
doc change log
, like current Hugegraph Releasechange log
cc @javeme
OK,just delete it for now
outdated doc should be visited by website tag/version function,record this as a important need(issue)
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.
THX
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.
better not use CN chars in filename~ u could enhance it in future PRs ~
* chore(website): add swagger ui auth doc 9f50f7d
No description provided.