Skip to content
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

[Bug] Enhance the HTTP Auth desc #390

Open
1 task done
MayMistery opened this issue Feb 10, 2025 · 2 comments
Open
1 task done

[Bug] Enhance the HTTP Auth desc #390

MayMistery opened this issue Feb 10, 2025 · 2 comments
Labels
bug Something isn't working

Comments

@MayMistery
Copy link

Bug Type (问题类型)

gremlin (结果不合预期)

Before submit

  • 我已经确认现有的 IssuesFAQ 中没有相同 / 重复问题 (I have confirmed and searched that there are no similar problems in the historical issue and documents)

Environment (环境信息)

Image The description regarding the use of Authorization in the official documentation is quite misleading. The term "HTTP plaintext format" is ambiguous. Furthermore, neither the official website documentation nor the Docker Hub documentation specifies that the default user is "admin". This lack of information is particularly inconvenient for users deploying via Docker.

Expected & Actual behavior (期望与实际表现)

It would be better to use the example "Authorization: Basic base64(admin:xxxx)" instead, add the default user part in doc.

Vertex/Edge example (问题点 / 边数据举例)

Schema [VertexLabel, EdgeLabel, IndexLabel] (元数据结构)

@MayMistery MayMistery added the bug Something isn't working label Feb 10, 2025
Copy link

dosubot bot commented Feb 10, 2025

Hello, @MayMistery! I'm here to help you with any bugs, questions, or contributions you might have for HugeGraph. Let's get to the bottom of this issue together!

To address the issues raised regarding the HugeGraph documentation:

  1. Clarify Default User: The documentation should clearly specify that the default super administrator user is "admin". This information is crucial, especially for users deploying HugeGraph via Docker.

  2. Improve HTTP Basic Authentication Example: The example for HTTP Basic Authentication should be updated to use the correct format with base64 encoding. Instead of using "Authorization: Basic admin xxxx", it should be presented as:

    GET http://localhost:8080/graphs/hugegraph/schema/vertexlabels
    Authorization: Basic YWRtaW46eHh4eA==

    Here, YWRtaW46eHh4eA== is the base64 encoding of admin:xxxx. A note should be included to explain how to generate this base64 string [1].

These changes will help make the documentation more user-friendly and reduce confusion, especially for new users.

To continue talking to Dosu, mention @dosu.


Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Other

@imbajin
Copy link
Member

imbajin commented Feb 11, 2025

@MayMistery thanks for the suggestion

Could u also submit a PR for it (in https://github.com/apache/incubator-hugegraph-doc repo)

@imbajin imbajin transferred this issue from apache/incubator-hugegraph Feb 11, 2025
@imbajin imbajin changed the title [Bug] describe the main problem [Bug] Enhance the HTTP Auth desc Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants