From 890fbf81a5015d712139927b9cb9a0ae27d8a54f Mon Sep 17 00:00:00 2001 From: Bobby Warner Date: Tue, 18 Feb 2025 23:40:40 -0600 Subject: [PATCH 1/3] Update wording in README --- README.md | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index eaa95d5683..8a70a5b7ba 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ hugegraph-logo -

A graph database that supports more than 10 billion data, high performance and scalability

+

A graph database that supports more than 10 billion vertices & edges, high performance and scalability

@@ -15,15 +15,15 @@ ## What is Apache HugeGraph? -[HugeGraph](https://hugegraph.apache.org/) is a fast-speed 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 ability. -As compliance to [Apache TinkerPop 3](https://tinkerpop.apache.org/) framework, various complicated graph queries can be -achieved through [Gremlin](https://tinkerpop.apache.org/gremlin.html)(a powerful graph traversal language). +[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 -- Compliance to [Apache TinkerPop 3](https://tinkerpop.apache.org/), support [Gremlin](https://tinkerpop.apache.org/gremlin.html) & [Cypher](https://en.wikipedia.org/wiki/Cypher) language +- 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 - Schema Metadata Management, including VertexLabel, EdgeLabel, PropertyKey and IndexLabel - Multi-type Indexes, supporting exact query, range query and complex conditions combination query - Plug-in Backend Store Driver Framework, support `RocksDB`/`HStore`, `HBase`, `Cassandra/ScyllaDB`, and `MySQL/Postgre` now and easy to add another backend store driver if needed @@ -32,27 +32,31 @@ achieved through [Gremlin](https://tinkerpop.apache.org/gremlin.html)(a powerful ## Quick Start -### 1. Docker Way (Convenient for Test) +### 1. Docker -We can use `docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph:1.3.0` to quickly start an inner -HugeGraph server with `RocksDB` (in backgrounds) for **test/dev**. -You can visit [doc page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#3-deploy) or +Use Docker to quickly start a HugeGraph server with `RocksDB` (in the background) for **testing or development**: + +``` +docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph:1.5.0 +``` + +Please visit [doc page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#3-deploy) or the [README](hugegraph-server/hugegraph-dist/docker/README.md) for more details. ([Docker Compose](./hugegraph-server/hugegraph-dist/docker/example)) > Note: > -> 1. The docker image of hugegraph is a convenience release, but not **official distribution** artifacts. You can find more details from [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub). +> 1. The Docker image of HugeGraph is a convenience release, but not **official distribution** artifacts. 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. -### 2. Download Way +### 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) to download the latest release package and start the server. -### 3. Source Building Way +### 3. Build From Source -Visit [Source Building 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 From e23eff3a31fe83c38d9a86f225ef90c1249a1a04 Mon Sep 17 00:00:00 2001 From: Bobby Warner Date: Wed, 19 Feb 2025 20:05:54 -0600 Subject: [PATCH 2/3] Resolve feedback --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8a70a5b7ba..a287a51c2c 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ achieved through the powerful [Gremlin](https://tinkerpop.apache.org/gremlin.htm ## Quick Start -### 1. Docker +### 1. Docker (For Test) Use Docker to quickly start a HugeGraph server with `RocksDB` (in the background) for **testing or development**: @@ -47,7 +47,7 @@ the [README](hugegraph-server/hugegraph-dist/docker/README.md) for more details. > > 1. The Docker image of HugeGraph is a convenience release, but not **official distribution** artifacts. 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. +> 2. Recommend to use `release tag` (like `1.5.0`/`1.7.0`) for the stable version. Use `latest` tag to experience the newest functions in development. ### 2. Download From 1f890d6f8bc588b55a851cb8decefff5c6931ba2 Mon Sep 17 00:00:00 2001 From: imbajin Date: Thu, 20 Feb 2025 12:52:20 +0800 Subject: [PATCH 3/3] Update README.md --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a287a51c2c..80e5186dd8 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,9 @@ achieved through the powerful [Gremlin](https://tinkerpop.apache.org/gremlin.htm Use Docker to quickly start a HugeGraph server with `RocksDB` (in the background) for **testing or development**: ``` +# (Optional) +# 1. add "-e PASSWORD=xxx" to enable 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 ``` @@ -44,16 +47,16 @@ Please visit [doc page](https://hugegraph.apache.org/docs/quickstart/hugegraph-s the [README](hugegraph-server/hugegraph-dist/docker/README.md) for more details. ([Docker Compose](./hugegraph-server/hugegraph-dist/docker/example)) > Note: -> > 1. The Docker image of HugeGraph is a convenience release, but not **official distribution** artifacts. 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.5.0`/`1.7.0`) for the stable version. Use `latest` tag to experience the newest functions in development. +> 2. Recommend to use `release tag` (like `1.5.0`/`1.x.0`) for the stable version. Use `latest` tag to experience the newest functions in development. ### 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) 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. + ### 3. Build From Source Visit [Build From Source Page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#33-source-code-compilation) and follow the