diff --git a/README.md b/README.md index afc2bfb88f..f15dcbaea0 100644 --- a/README.md +++ b/README.md @@ -32,8 +32,12 @@ Billions of vertices and edges can be easily stored into and queried from HugeGr ### 1. Docker Way +> Note: 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). + +> Note: Recommand to use `release tag`(like `1.0.0`) for the stable version. Use `latest` tag to experience the newest functions in development. + We can use `docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph` to quickly start an inner -HugeGraph server with `RocksDB` in backgrounds. (Use `release tag`(like `1.0.0`) for the stable version) +HugeGraph server with `RocksDB` in backgrounds. Optional: diff --git a/hugegraph-server/Dockerfile b/hugegraph-server/Dockerfile index 47dc411c6e..45a725786d 100644 --- a/hugegraph-server/Dockerfile +++ b/hugegraph-server/Dockerfile @@ -47,6 +47,7 @@ RUN set -x \ procps \ curl \ lsof \ + vim \ && apt-get clean \ && rm -rf /var/lib/apt/lists/* diff --git a/hugegraph-server/hugegraph-dist/README.md b/hugegraph-server/hugegraph-dist/README.md index 1aedb37bbe..d5e0b89f10 100644 --- a/hugegraph-server/hugegraph-dist/README.md +++ b/hugegraph-server/hugegraph-dist/README.md @@ -1,5 +1,9 @@ # Deploy Hugegraph server with docker +> Note: 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). + +> Note: Recommand to use `release tag`(like `1.0.0`) for the stable version. Use `latest` tag to experience the newest functions in development. + ## 1. Deploy We can use docker to quickly start an inner HugeGraph server with RocksDB in background. @@ -18,7 +22,7 @@ We can use docker to quickly start an inner HugeGraph server with RocksDB in bac graph: image: hugegraph/hugegraph ports: - - 18080:8080 + - 8080:8080 ``` ## 2. Create Sample Graph on Server Startup @@ -46,7 +50,7 @@ If you want to customize the pre-loaded data, please mount the the groovy script volumes: - /path/to/yourscript:/hugegraph/scripts/example.groovy ports: - - 18080:8080 + - 8080:8080 ``` 3. Using start-hugegraph.sh diff --git a/hugegraph-server/hugegraph-dist/docker/docker-entrypoint.sh b/hugegraph-server/hugegraph-dist/docker/docker-entrypoint.sh index e1fad4a9ff..ce7541c71f 100644 --- a/hugegraph-server/hugegraph-dist/docker/docker-entrypoint.sh +++ b/hugegraph-server/hugegraph-dist/docker/docker-entrypoint.sh @@ -21,4 +21,4 @@ ./bin/init-store.sh -./bin/start-hugegraph.sh -d false -j "$JAVA_OPTS" -g zgc +./bin/start-hugegraph.sh -j "$JAVA_OPTS" -g zgc diff --git a/hugegraph-server/hugegraph-dist/docker/scripts/detect-storage.groovy b/hugegraph-server/hugegraph-dist/docker/scripts/detect-storage.groovy index df57ade988..0c1a3e5ddb 100644 --- a/hugegraph-server/hugegraph-dist/docker/scripts/detect-storage.groovy +++ b/hugegraph-server/hugegraph-dist/docker/scripts/detect-storage.groovy @@ -18,7 +18,7 @@ import org.apache.hugegraph.HugeFactory import org.apache.hugegraph.dist.RegisterUtil -// register all the backend to avoid changes if docker needs to support othre backend +// register all the backend to avoid changes if needs to support othre backend RegisterUtil.registerPlugins() RegisterUtil.registerRocksDB() RegisterUtil.registerCassandra()