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

chore(doc): update hugegraph doc about install #316

Merged
merged 23 commits into from
Jan 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
a35bbeb
feat(website): add metric api doc
SunnyBoy-WYH Oct 28, 2023
dfca306
feat(website): add metric api doc,format doc
SunnyBoy-WYH Oct 29, 2023
77b8e31
feat(website): add metric api doc,format doc
SunnyBoy-WYH Nov 5, 2023
27cf698
feat(website): add metric api doc,format doc
SunnyBoy-WYH Nov 6, 2023
f1159fc
feat(website): add metric api doc,format doc
SunnyBoy-WYH Nov 6, 2023
1ed62cb
chore(website): remove config auth model doc
SunnyBoy-WYH Nov 23, 2023
e68f6ef
Merge branch 'master' into doc-metric
SunnyBoy-WYH Nov 23, 2023
6dc7eea
chore(website): remove config auth model doc
SunnyBoy-WYH Nov 23, 2023
4df6f8d
chore(website): add swagger ui auth doc
SunnyBoy-WYH Nov 29, 2023
ba5cf24
Merge branch 'master' into doc-metric
SunnyBoy-WYH Dec 21, 2023
b001bd6
chore(website): fix link path
SunnyBoy-WYH Dec 21, 2023
6171668
chore(website): update outdated description
SunnyBoy-WYH Dec 21, 2023
ecfe7fc
chore(website): update outdated description
SunnyBoy-WYH Dec 21, 2023
44211f3
chore(website): update outdated description
SunnyBoy-WYH Dec 21, 2023
0f26ec7
Apply suggestions from code review
imbajin Dec 21, 2023
3103f96
chore(website): update auth mode description
SunnyBoy-WYH Dec 26, 2023
ebaa5af
Merge remote-tracking branch 'origin/doc-metric' into doc-metric
SunnyBoy-WYH Dec 26, 2023
6105951
Merge branch 'master' into doc-metric
SunnyBoy-WYH Dec 27, 2023
3667773
chore(website): update install description
SunnyBoy-WYH Dec 27, 2023
3496ae1
chore(website): update outdated description
SunnyBoy-WYH Jan 1, 2024
d758163
chore(website): update outdated description
SunnyBoy-WYH Jan 1, 2024
ad684c2
chore(website): update outdated description
SunnyBoy-WYH Jan 1, 2024
bce9eb2
Apply suggestions from code review
imbajin Jan 2, 2024
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
22 changes: 22 additions & 0 deletions content/cn/docs/config/config-authentication.md
SunnyBoy-WYH marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,25 @@ gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
### 自定义用户认证系统

如果需要支持更加灵活的用户系统,可自定义 authenticator 进行扩展,自定义 authenticator 实现接口`org.apache.hugegraph.auth.HugeAuthenticator`即可,然后修改配置文件中`authenticator`配置项指向该实现。


### 基于鉴权模式启动

在鉴权配置完成后,需在首次执行 `init-store.sh` 时命令行中输入 `admin` 密码 (非 docker 部署模式下)

如果基于 docker 镜像部署或者已经初始化 HugeGraph 并需要转换为鉴权模式,需要删除相关图数据并重新启动 HugeGraph,若图已有业务数据,暂时**无法直接转换**鉴权模式 (对于该功能的改进/支持将在下个版本中发布)。

```bash
# stop the hugeGraph firstly
bin/stop-hugegraph.sh

# delete the store data (here we use the default path for rocksdb)
rm -rf rocksdb-data/

# init store again
bin/init-store.sh

# start hugeGraph again
bin/start-hugegraph.sh

```
2 changes: 2 additions & 0 deletions content/cn/docs/quickstart/hugegraph-server.md
SunnyBoy-WYH marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,8 @@ HugeGraphServer 启动时会连接后端存储并尝试检查后端存储版本

由于各种后端所需的配置(hugegraph.properties)及启动步骤略有不同,下面逐一对各后端的配置及启动做介绍。

如果想要使用 HugeGraph 鉴权模式,在后面正式启动 Server 之前应按照 [Server 鉴权配置](https://hugegraph.apache.org/cn/docs/config/config-authentication/) 进行配置。

##### 5.1.1 RocksDB

<details>
Expand Down
23 changes: 23 additions & 0 deletions content/en/docs/config/config-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,26 @@ For detailed API calls and explanations regarding permissions, please refer to t
If you need to support a more flexible user system, you can customize the authenticator for extension.
Simply implement the `org.apache.hugegraph.auth.HugeAuthenticator` interface with your custom authenticator,
and then modify the `authenticator` configuration item in the configuration file to point to your implementation.

### Switching authentication mode

After the authentication configuration completed, enter the **admin password** on the **command line** when executing `init store. sh` for the first time. (For non-Docker mode)

If deployed based on Docker image or if HugeGraph has already been initialized and needs to be converted to authentication mode,
relevant graph data needs to be deleted and HugeGraph needs to be restarted. If there is already business data in the diagram,
it is temporarily **not possible** to directly convert the authentication mode (improvements/support for this feature will be released in the next version).

```bash
# stop the hugeGraph firstly
bin/stop-hugegraph.sh

# delete the store data (here we use the default path for rocksdb)
rm -rf rocksdb-data/

# init store again
bin/init-store.sh

# start hugeGraph again
bin/start-hugegraph.sh

```
2 changes: 2 additions & 0 deletions content/en/docs/quickstart/hugegraph-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,8 @@ If you need to access HugeGraphServer externally, please modify the `restserver.

Since the configuration (hugegraph.properties) and startup steps required by various backends are slightly different, the following will introduce the configuration and startup of each backend one by one.

If you want to use HugeGraph authentication mode, you should follow the [Server Authentication Configuration](https://hugegraph.apache.org/docs/config/config-authentication/) configuration before you start Server later.

##### 5.1.1 Memory

<details>
Expand Down