Skip to content

Commit

Permalink
chore(auth): update auth config doc for re-init (#320)
Browse files Browse the repository at this point in the history
* Update content/cn/docs/config/config-authentication.md

---------

Co-authored-by: imbajin <jin@apache.org> 195d175
  • Loading branch information
imbajin committed Jan 11, 2024
1 parent 22d2c94 commit b7e49e3
Show file tree
Hide file tree
Showing 13 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion cn/docs/_print/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1830,7 +1830,7 @@
</span></span><span style=display:flex><span># 如果是分开部署 GraphServer 和 AuthServer,还需要指定下面的配置,地址填写 AuthServer 的 IP:RPC 端口
</span></span><span style=display:flex><span>#auth.remote_url=127.0.0.1:8899,127.0.0.1:8898,127.0.0.1:8897
</span></span></code></pre></div><p>其中,<code>graph_store</code>配置项是指使用哪一个图来存储用户信息,如果存在多个图的话,选取任意一个均可。</p><p>在配置文件<code>hugegraph{n}.properties</code>中配置<code>gremlin.graph</code>信息:</p><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-fallback data-lang=fallback><span style=display:flex><span>gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
</span></span></code></pre></div><p>然后详细的权限 API 调用和说明请参考 <a href=/docs/clients/restful-api/auth>Authentication-API</a> 文档。</p><h3 id=自定义用户认证系统>自定义用户认证系统</h3><p>如果需要支持更加灵活的用户系统,可自定义 authenticator 进行扩展,自定义 authenticator 实现接口<code>org.apache.hugegraph.auth.HugeAuthenticator</code>即可,然后修改配置文件中<code>authenticator</code>配置项指向该实现。</p><h3 id=基于鉴权模式启动>基于鉴权模式启动</h3><p>在鉴权配置完成后,需在首次执行 <code>init-store.sh</code> 时命令行中输入 <code>admin</code> 密码 (非 docker 部署模式下)</p><p>如果基于 docker 镜像部署或者已经初始化 HugeGraph 并需要转换为鉴权模式,需要删除相关图数据并重新启动 HugeGraph,若图已有业务数据,暂时<strong>无法直接转换</strong>鉴权模式 (对于该功能的改进/支持将在下个版本中发布)。</p><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-bash data-lang=bash><span style=display:flex><span><span style=color:#8f5902;font-style:italic># stop the hugeGraph firstly</span>
</span></span></code></pre></div><p>然后详细的权限 API 调用和说明请参考 <a href=/docs/clients/restful-api/auth>Authentication-API</a> 文档。</p><h3 id=自定义用户认证系统>自定义用户认证系统</h3><p>如果需要支持更加灵活的用户系统,可自定义 authenticator 进行扩展,自定义 authenticator 实现接口<code>org.apache.hugegraph.auth.HugeAuthenticator</code>即可,然后修改配置文件中<code>authenticator</code>配置项指向该实现。</p><h3 id=基于鉴权模式启动>基于鉴权模式启动</h3><p>在鉴权配置完成后,需在首次执行 <code>init-store.sh</code> 时命令行中输入 <code>admin</code> 密码 (非 docker 部署模式下)</p><p>如果基于 docker 镜像部署或者已经初始化 HugeGraph 并需要转换为鉴权模式,需要删除相关图数据并重新启动 HugeGraph,若图已有业务数据,暂时<strong>无法直接转换</strong>鉴权模式 (对于该功能的改进将在下个版本发布,修改方式可参考 <a href=https://github.com/apache/incubator-hugegraph/pull/2411>PR 2411</a>)。</p><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-bash data-lang=bash><span style=display:flex><span><span style=color:#8f5902;font-style:italic># stop the hugeGraph firstly</span>
</span></span><span style=display:flex><span>bin/stop-hugegraph.sh
</span></span><span style=display:flex><span>
</span></span><span style=display:flex><span><span style=color:#8f5902;font-style:italic># delete the store data (here we use the default path for rocksdb)</span>
Expand Down
2 changes: 1 addition & 1 deletion cn/docs/config/_print/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@
</span></span><span style=display:flex><span># 如果是分开部署 GraphServer 和 AuthServer,还需要指定下面的配置,地址填写 AuthServer 的 IP:RPC 端口
</span></span><span style=display:flex><span>#auth.remote_url=127.0.0.1:8899,127.0.0.1:8898,127.0.0.1:8897
</span></span></code></pre></div><p>其中,<code>graph_store</code>配置项是指使用哪一个图来存储用户信息,如果存在多个图的话,选取任意一个均可。</p><p>在配置文件<code>hugegraph{n}.properties</code>中配置<code>gremlin.graph</code>信息:</p><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-fallback data-lang=fallback><span style=display:flex><span>gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
</span></span></code></pre></div><p>然后详细的权限 API 调用和说明请参考 <a href=/docs/clients/restful-api/auth>Authentication-API</a> 文档。</p><h3 id=自定义用户认证系统>自定义用户认证系统</h3><p>如果需要支持更加灵活的用户系统,可自定义 authenticator 进行扩展,自定义 authenticator 实现接口<code>org.apache.hugegraph.auth.HugeAuthenticator</code>即可,然后修改配置文件中<code>authenticator</code>配置项指向该实现。</p><h3 id=基于鉴权模式启动>基于鉴权模式启动</h3><p>在鉴权配置完成后,需在首次执行 <code>init-store.sh</code> 时命令行中输入 <code>admin</code> 密码 (非 docker 部署模式下)</p><p>如果基于 docker 镜像部署或者已经初始化 HugeGraph 并需要转换为鉴权模式,需要删除相关图数据并重新启动 HugeGraph,若图已有业务数据,暂时<strong>无法直接转换</strong>鉴权模式 (对于该功能的改进/支持将在下个版本中发布)。</p><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-bash data-lang=bash><span style=display:flex><span><span style=color:#8f5902;font-style:italic># stop the hugeGraph firstly</span>
</span></span></code></pre></div><p>然后详细的权限 API 调用和说明请参考 <a href=/docs/clients/restful-api/auth>Authentication-API</a> 文档。</p><h3 id=自定义用户认证系统>自定义用户认证系统</h3><p>如果需要支持更加灵活的用户系统,可自定义 authenticator 进行扩展,自定义 authenticator 实现接口<code>org.apache.hugegraph.auth.HugeAuthenticator</code>即可,然后修改配置文件中<code>authenticator</code>配置项指向该实现。</p><h3 id=基于鉴权模式启动>基于鉴权模式启动</h3><p>在鉴权配置完成后,需在首次执行 <code>init-store.sh</code> 时命令行中输入 <code>admin</code> 密码 (非 docker 部署模式下)</p><p>如果基于 docker 镜像部署或者已经初始化 HugeGraph 并需要转换为鉴权模式,需要删除相关图数据并重新启动 HugeGraph,若图已有业务数据,暂时<strong>无法直接转换</strong>鉴权模式 (对于该功能的改进将在下个版本发布,修改方式可参考 <a href=https://github.com/apache/incubator-hugegraph/pull/2411>PR 2411</a>)。</p><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-bash data-lang=bash><span style=display:flex><span><span style=color:#8f5902;font-style:italic># stop the hugeGraph firstly</span>
</span></span><span style=display:flex><span>bin/stop-hugegraph.sh
</span></span><span style=display:flex><span>
</span></span><span style=display:flex><span><span style=color:#8f5902;font-style:italic># delete the store data (here we use the default path for rocksdb)</span>
Expand Down
8 changes: 4 additions & 4 deletions cn/docs/config/config-authentication/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion cn/docs/config/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1540,7 +1540,7 @@
&lt;p>如果需要支持更加灵活的用户系统,可自定义 authenticator 进行扩展,自定义 authenticator 实现接口&lt;code>org.apache.hugegraph.auth.HugeAuthenticator&lt;/code>即可,然后修改配置文件中&lt;code>authenticator&lt;/code>配置项指向该实现。&lt;/p>
&lt;h3 id="基于鉴权模式启动">基于鉴权模式启动&lt;/h3>
&lt;p>在鉴权配置完成后,需在首次执行 &lt;code>init-store.sh&lt;/code> 时命令行中输入 &lt;code>admin&lt;/code> 密码 (非 docker 部署模式下)&lt;/p>
&lt;p>如果基于 docker 镜像部署或者已经初始化 HugeGraph 并需要转换为鉴权模式,需要删除相关图数据并重新启动 HugeGraph,若图已有业务数据,暂时&lt;strong>无法直接转换&lt;/strong>鉴权模式 (对于该功能的改进/支持将在下个版本中发布)。&lt;/p>
&lt;p>如果基于 docker 镜像部署或者已经初始化 HugeGraph 并需要转换为鉴权模式,需要删除相关图数据并重新启动 HugeGraph,若图已有业务数据,暂时&lt;strong>无法直接转换&lt;/strong>鉴权模式 (对于该功能的改进将在下个版本发布,修改方式可参考 &lt;a href="https://github.com/apache/incubator-hugegraph/pull/2411">PR 2411&lt;/a>)。&lt;/p>
&lt;div class="highlight">&lt;pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;">&lt;code class="language-bash" data-lang="bash">&lt;span style="display:flex;">&lt;span>&lt;span style="color:#8f5902;font-style:italic"># stop the hugeGraph firstly&lt;/span>
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span>bin/stop-hugegraph.sh
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span>
Expand Down
2 changes: 1 addition & 1 deletion cn/docs/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7128,7 +7128,7 @@ HugeGraph Toolchain 版本:toolchain-1.0.0&lt;/p>
&lt;p>如果需要支持更加灵活的用户系统,可自定义 authenticator 进行扩展,自定义 authenticator 实现接口&lt;code>org.apache.hugegraph.auth.HugeAuthenticator&lt;/code>即可,然后修改配置文件中&lt;code>authenticator&lt;/code>配置项指向该实现。&lt;/p>
&lt;h3 id="基于鉴权模式启动">基于鉴权模式启动&lt;/h3>
&lt;p>在鉴权配置完成后,需在首次执行 &lt;code>init-store.sh&lt;/code> 时命令行中输入 &lt;code>admin&lt;/code> 密码 (非 docker 部署模式下)&lt;/p>
&lt;p>如果基于 docker 镜像部署或者已经初始化 HugeGraph 并需要转换为鉴权模式,需要删除相关图数据并重新启动 HugeGraph,若图已有业务数据,暂时&lt;strong>无法直接转换&lt;/strong>鉴权模式 (对于该功能的改进/支持将在下个版本中发布)。&lt;/p>
&lt;p>如果基于 docker 镜像部署或者已经初始化 HugeGraph 并需要转换为鉴权模式,需要删除相关图数据并重新启动 HugeGraph,若图已有业务数据,暂时&lt;strong>无法直接转换&lt;/strong>鉴权模式 (对于该功能的改进将在下个版本发布,修改方式可参考 &lt;a href="https://github.com/apache/incubator-hugegraph/pull/2411">PR 2411&lt;/a>)。&lt;/p>
&lt;div class="highlight">&lt;pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;">&lt;code class="language-bash" data-lang="bash">&lt;span style="display:flex;">&lt;span>&lt;span style="color:#8f5902;font-style:italic"># stop the hugeGraph firstly&lt;/span>
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span>bin/stop-hugegraph.sh
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span>
Expand Down
2 changes: 1 addition & 1 deletion cn/sitemap.xml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/_print/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1846,7 +1846,7 @@
Simply implement the <code>org.apache.hugegraph.auth.HugeAuthenticator</code> interface with your custom authenticator,
and then modify the <code>authenticator</code> configuration item in the configuration file to point to your implementation.</p><h3 id=switching-authentication-mode>Switching authentication mode</h3><p>After the authentication configuration completed, enter the <strong>admin password</strong> on the <strong>command line</strong> when executing <code>init store. sh</code> for the first time. (For non-Docker mode)</p><p>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 <strong>not possible</strong> to directly convert the authentication mode (improvements/support for this feature will be released in the next version).</p><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-bash data-lang=bash><span style=display:flex><span><span style=color:#8f5902;font-style:italic># stop the hugeGraph firstly</span>
it is temporarily <strong>not possible</strong> to directly convert the authentication mode (improvements/support for this feature will be released in the next version. Could refer <a href=https://github.com/apache/incubator-hugegraph/pull/2411>PR 2411</a>).</p><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-bash data-lang=bash><span style=display:flex><span><span style=color:#8f5902;font-style:italic># stop the hugeGraph firstly</span>
</span></span><span style=display:flex><span>bin/stop-hugegraph.sh
</span></span><span style=display:flex><span>
</span></span><span style=display:flex><span><span style=color:#8f5902;font-style:italic># delete the store data (here we use the default path for rocksdb)</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/config/_print/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@
Simply implement the <code>org.apache.hugegraph.auth.HugeAuthenticator</code> interface with your custom authenticator,
and then modify the <code>authenticator</code> configuration item in the configuration file to point to your implementation.</p><h3 id=switching-authentication-mode>Switching authentication mode</h3><p>After the authentication configuration completed, enter the <strong>admin password</strong> on the <strong>command line</strong> when executing <code>init store. sh</code> for the first time. (For non-Docker mode)</p><p>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 <strong>not possible</strong> to directly convert the authentication mode (improvements/support for this feature will be released in the next version).</p><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-bash data-lang=bash><span style=display:flex><span><span style=color:#8f5902;font-style:italic># stop the hugeGraph firstly</span>
it is temporarily <strong>not possible</strong> to directly convert the authentication mode (improvements/support for this feature will be released in the next version. Could refer <a href=https://github.com/apache/incubator-hugegraph/pull/2411>PR 2411</a>).</p><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-bash data-lang=bash><span style=display:flex><span><span style=color:#8f5902;font-style:italic># stop the hugeGraph firstly</span>
</span></span><span style=display:flex><span>bin/stop-hugegraph.sh
</span></span><span style=display:flex><span>
</span></span><span style=display:flex><span><span style=color:#8f5902;font-style:italic># delete the store data (here we use the default path for rocksdb)</span>
Expand Down
Loading

0 comments on commit b7e49e3

Please sign in to comment.