(incubator-hugegraph) branch master updated: docs: enhance docker instruction with auth opened graph (#2881)

[jin]

This is an automated email from the ASF dual-hosted git repository.

jin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph.git


The following commit(s) were added to refs/heads/master by this push:
     new c0220c78b docs: enhance docker instruction with auth opened graph 
(#2881)
c0220c78b is described below

commit c0220c78b48821ff4130646ed78e3b7f56f9f29a
Author: Tsukilc <153273766+tsuk...@users.noreply.github.com>
AuthorDate: Thu Sep 25 16:59:34 2025 +0800

    docs: enhance docker instruction with auth opened graph (#2881)
---
 README.md                                        | 34 ++++++++++------------
 hugegraph-server/hugegraph-dist/docker/README.md | 37 ++++++++++++------------
 2 files changed, 34 insertions(+), 37 deletions(-)

diff --git a/README.md b/README.md
index f1b3923a7..dd50a8591 100644
--- a/README.md
+++ b/README.md
@@ -15,12 +15,11 @@
 
 ## What is Apache HugeGraph?
 
-[HugeGraph](https://hugegraph.apache.org/) is a fast and highly-scalable 
[graph database](https://en.wikipedia.org/wiki/Graph_database). 
-Billions of vertices and edges can be easily stored into and queried from 
HugeGraph due to its excellent OLTP capabilities. 
-HugeGraph is compliant with the [Apache TinkerPop 
3](https://tinkerpop.apache.org/) framework allowing complicated graph queries 
to be 
+[HugeGraph](https://hugegraph.apache.org/) is a fast and highly-scalable 
[graph database](https://en.wikipedia.org/wiki/Graph_database).
+Billions of vertices and edges can be easily stored into and queried from 
HugeGraph due to its excellent OLTP capabilities.
+HugeGraph is compliant with the [Apache TinkerPop 
3](https://tinkerpop.apache.org/) framework allowing complicated graph queries 
to be
 achieved through the powerful 
[Gremlin](https://tinkerpop.apache.org/gremlin.html) graph traversal language.
 
-
 ## Features
 
 - Compliant to [Apache TinkerPop 3](https://tinkerpop.apache.org/), supports 
[Gremlin](https://tinkerpop.apache.org/gremlin.html) & 
[Cypher](https://en.wikipedia.org/wiki/Cypher) language
@@ -30,7 +29,6 @@ achieved through the powerful 
[Gremlin](https://tinkerpop.apache.org/gremlin.htm
 - Integration with `Flink/Spark/HDFS`, and friendly to connect other big data 
platforms
 - Complete graph ecosystem (including both in/out-memory `Graph Computing` + 
`Graph Visualization & Tools` + `Graph Learning & AI`, see 
[here](#3-build-from-source))
 
-
 ## Quick Start
 
 ### 1. Docker (For Test)
@@ -39,9 +37,9 @@ Use Docker to quickly start a HugeGraph server with `RocksDB` 
(in the background
 
 ```
 # (Optional) 
-# 1. add "-e PASSWORD=xxx" to enable the auth system
+# 1. remove "-e PASSWORD=xxx" to disable the auth system
 # 2. add "-e PRELOAD=true" to auto-load a sample graph
-docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph:1.5.0
+docker run -itd --name=graph -e PASSWORD=xxx -p 8080:8080 
hugegraph/hugegraph:1.5.0
 ```
 
 Please visit [doc 
page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#3-deploy) 
or
@@ -53,20 +51,21 @@ the 
[README](hugegraph-server/hugegraph-dist/docker/README.md) for more details.
 
 ### 2. Download
 
-Visit [Download Page](https://hugegraph.apache.org/docs/download/download/) 
and refer the 
[doc](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#32-download-the-binary-tar-tarball)
 
+Visit [Download Page](https://hugegraph.apache.org/docs/download/download/) 
and refer the 
[doc](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#32-download-the-binary-tar-tarball)
 to download the latest release package and start the server.
 
-**Note:** if you want to use it in the production environment or expose it to 
the public network, must enable the 
[AuthSystem](https://hugegraph.apache.org/docs/config/config-authentication/) 
to ensure safe. 
+**Note:** if you want to use it in the production environment or expose it to 
the public network, must enable the 
[AuthSystem](https://hugegraph.apache.org/docs/config/config-authentication/) 
to ensure safe.
 
 ### 3. Build From Source
 
-Visit [Build From Source 
Page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#33-source-code-compilation)
 and follow the 
+Visit [Build From Source 
Page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#33-source-code-compilation)
 and follow the
 steps to build the source code and start the server.
 
 The project [doc page](https://hugegraph.apache.org/docs/) contains more 
information on HugeGraph
 and provides detailed documentation for users. (Structure / Usage / API / 
Configs...)
 
 And here are links of other **HugeGraph** component/repositories:
+
 1. [hugegraph-toolchain](https://github.com/apache/hugegraph-toolchain) (graph 
tools 
**[loader](https://github.com/apache/hugegraph-toolchain/tree/master/hugegraph-loader)/[dashboard](https://github.com/apache/hugegraph-toolchain/tree/master/hugegraph-hubble)/[tool](https://github.com/apache/hugegraph-toolchain/tree/master/hugegraph-tools)/[client](https://github.com/apache/hugegraph-toolchain/tree/master/hugegraph-client)**)
 2. [hugegraph-computer](https://github.com/apache/hugegraph-computer) 
(integrated **graph computing** system)
 3. [hugegraph-ai](https://github.com/apache/incubator-hugegraph-ai) 
(integrated **Graph AI/LLM/KG** system)
@@ -76,30 +75,27 @@ And here are links of other **HugeGraph** 
component/repositories:
 
 HugeGraph is licensed under [Apache 2.0 License](LICENSE).
 
-
 ## Contributing
 
-- Welcome to contribute to HugeGraph, please see [`How to 
Contribute`](CONTRIBUTING.md) & 
[Guidelines](https://hugegraph.apache.org/docs/contribution-guidelines/) for 
more information.  
-- Note: It's recommended to use [GitHub Desktop](https://desktop.github.com/) 
to greatly simplify the PR and commit process.  
+- Welcome to contribute to HugeGraph, please see [`How to 
Contribute`](CONTRIBUTING.md) & 
[Guidelines](https://hugegraph.apache.org/docs/contribution-guidelines/) for 
more information.
+- Note: It's recommended to use [GitHub Desktop](https://desktop.github.com/) 
to greatly simplify the PR and commit process.
 - Thank you to all the people who already contributed to HugeGraph!
 
 [![contributors 
graph](https://contrib.rocks/image?repo=apache/hugegraph)](https://github.com/apache/incubator-hugegraph/graphs/contributors)
 
-
 ## Thanks
 
-HugeGraph relies on the [TinkerPop](http://tinkerpop.apache.org) framework, we 
refer to the storage structure of Titan and the schema definition of DataStax. 
+HugeGraph relies on the [TinkerPop](http://tinkerpop.apache.org) framework, we 
refer to the storage structure of Titan and the schema definition of DataStax.
 Thanks to TinkerPop, thanks to Titan, thanks to DataStax. Thanks to all other 
organizations or authors who contributed to the project.
 
-You are welcome to contribute to HugeGraph, 
+You are welcome to contribute to HugeGraph,
 and we are looking forward to working with you to build an excellent 
open-source community.
 
-
 ## Contact Us
 
 - [GitHub Issues](https://github.com/apache/hugegraph/issues): Feedback on 
usage issues and functional requirements (quick response)
- - Feedback Email: 
[d...@hugegraph.apache.org](mailto:d...@hugegraph.apache.org) 
([subscriber](https://hugegraph.apache.org/docs/contribution-guidelines/subscribe/)
 only)
- - WeChat public account: Apache HugeGraph, welcome to scan this QR code to 
follow us.
+- Feedback Email: 
[d...@hugegraph.apache.org](mailto:d...@hugegraph.apache.org) 
([subscriber](https://hugegraph.apache.org/docs/contribution-guidelines/subscribe/)
 only)
+- WeChat public account: Apache HugeGraph, welcome to scan this QR code to 
follow us.
 
  <img 
src="https://github.com/apache/hugegraph-doc/blob/master/assets/images/wechat.png?raw=true";
 alt="QR png" width="300"/>
 
diff --git a/hugegraph-server/hugegraph-dist/docker/README.md 
b/hugegraph-server/hugegraph-dist/docker/README.md
index 5fac10de5..6d1b6ad89 100644
--- a/hugegraph-server/hugegraph-dist/docker/README.md
+++ b/hugegraph-server/hugegraph-dist/docker/README.md
@@ -1,9 +1,9 @@
 # Deploy Hugegraph server with docker
 
 > Note:
-> 
+>
 > 1. The docker image of hugegraph is a convenience release, not official 
 > distribution artifacts from ASF. You can find more details from [ASF Release 
 > Distribution 
 > Policy](https://infra.apache.org/release-distribution.html#dockerhub).
-> 
+>
 > 2. Recommend to use `release tag` (like `1.3.0`/`1.5.0`) for the stable 
 > version. Use `latest` tag to experience the newest functions in development.
 
 ## 1. Deploy
@@ -12,11 +12,11 @@ We can use docker to quickly start an inner HugeGraph 
server with RocksDB in the
 
 1. Using docker run
 
-    Use `docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph:1.3.0` 
to start hugegraph server.
+   Use `docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph:1.3.0` 
to start hugegraph server.
 
 2. Using docker compose
 
-    Certainly we can only deploy server without other instance. Additionally, 
if we want to manage other HugeGraph-related instances with `server` in a 
single file, we can deploy HugeGraph-related instances via `docker-compose up 
-d`.  The `docker-compose.yaml` is as below:
+   Certainly we can only deploy server without other instance. Additionally, 
if we want to manage other HugeGraph-related instances with `server` in a 
single file, we can deploy HugeGraph-related instances via `docker-compose up 
-d`. The `docker-compose.yaml` is as below:
 
     ```yaml
     version: '3'
@@ -35,12 +35,12 @@ If you want to customize the preloaded data, please mount 
the groovy scripts (no
 
 1. Using docker run
 
-    Use `docker run -itd --name=graph -p 8080:8080 -e PRELOAD=true -v 
/path/to/script:/hugegraph-server/scripts/example.groovy 
hugegraph/hugegraph:1.3.0`
-    to start hugegraph server.
+   Use `docker run -itd --name=graph -p 8080:8080 -e PRELOAD=true -v 
/path/to/script:/hugegraph-server/scripts/example.groovy 
hugegraph/hugegraph:1.3.0`
+   to start hugegraph server.
 
-2. Using docker compose 
+2. Using docker compose
 
-    We can also use `docker-compose up -d` to quickly start. The 
`docker-compose.yaml` is below. 
[example.groovy](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/src/assembly/static/scripts/example.groovy)
 is a pre-defined script. If needed, we can mount a new `example.groovy` to 
preload different data:
+   We can also use `docker-compose up -d` to quickly start. The 
`docker-compose.yaml` is below. 
[example.groovy](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/src/assembly/static/scripts/example.groovy)
 is a pre-defined script. If needed, we can mount a new `example.groovy` to 
preload different data:
 
     ```yaml
     version: '3'
@@ -57,17 +57,17 @@ If you want to customize the preloaded data, please mount 
the groovy scripts (no
 
 3. Using start-hugegraph.sh
 
-    If you deploy HugeGraph server without docker, you can also pass arguments 
using `-p`, like this: `bin/start-hugegraph.sh -p true`.
+   If you deploy HugeGraph server without docker, you can also pass arguments 
using `-p`, like this: `bin/start-hugegraph.sh -p true`.
 
 ## 3. Enable Authentication
 
 1. Using docker run
 
-    Use `docker run -itd --name=graph -p 8080:8080 -e AUTH=true -e 
PASSWORD=123456 hugegraph/hugegraph:1.3.0` to enable the authentication and set 
the password with `-e AUTH=true -e PASSWORD=123456`.
+   Use `docker run -itd --name=graph -p 8080:8080 -e AUTH=true -e PASSWORD=xxx 
hugegraph/hugegraph:1.3.0` to enable the authentication and set the password 
with `-e AUTH=true -e PASSWORD=xxx`.
 
 2. Using docker compose
 
-    Similarly, we can set the environment variables in the docker-compose.yaml:
+   Similarly, we can set the environment variables in the docker-compose.yaml:
 
     ```yaml
     version: '3'
@@ -79,37 +79,38 @@ If you want to customize the preloaded data, please mount 
the groovy scripts (no
           - 8080:8080
         environment:
           - AUTH=true
-          - PASSWORD=123456
+          - PASSWORD=xxx
     ```
 
 ## 4. Running Open-Telemetry-Collector
 
 > CAUTION:
-> 
+>
 > The `docker-compose-trace.yaml` utilizes `Grafana` and `Grafana-Tempo`, both 
 > of them are licensed under 
 > [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.en.html), you should be 
 > aware of and use them with caution. Currently, we mainly provide this 
 > template for everyone to **test**
 >
+
 1. Start Open-Telemetry-Collector
 
     ```bash
     cd hugegraph-server/hugegraph-dist/docker/example
     docker-compose -f docker-compose-trace.yaml -p hugegraph-trace up -d
     ```
-   
+
 2. Active Open-Telemetry-Agent
 
     ```bash
     ./start-hugegraph.sh -y true
     ```
-   
+
 3. Stop Open-Telemetry-Collector
 
     ```bash
     cd hugegraph-server/hugegraph-dist/docker/example
     docker-compose -f docker-compose-trace.yaml -p hugegraph-trace stop
     ```
-   
+
 4. References
 
-   - [What is 
OpenTelemetry](https://opentelemetry.io/docs/what-is-opentelemetry/)
+    - [What is 
OpenTelemetry](https://opentelemetry.io/docs/what-is-opentelemetry/)
 
-   - [Tempo in 
Grafana](https://grafana.com/docs/tempo/latest/getting-started/tempo-in-grafana/)
+    - [Tempo in 
Grafana](https://grafana.com/docs/tempo/latest/getting-started/tempo-in-grafana/)