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.

Sign up for GitHub

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

doc: README.md tiny improve #2331

Merged
merged 2 commits into from
Oct 23, 2023
Merged

doc: README.md tiny improve #2331

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81908af
doc: doc optimize about docker compose
aroundabout Oct 20, 2023
f7bc161
doc: doc optimize about docker compose
aroundabout Oct 22, 2023
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
6 changes: 2 additions & 4 deletions hugegraph-dist/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ We can use docker to quickly start an inner HugeGraph server with RocksDB in bac

2. Using docker compose

We can also use `docker-compose up -d`. The `docker-compose.yaml` is below:
Additionally, if we want to manage other Hugegraph-related instances with `server` in a single file, we can also use docker-compose for deployment. (Certainly we can only deploy server without other instance) We can also use `docker-compose up -d`. The `docker-compose.yaml` is below:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Hugegraph-related => HugeGraph-related.
  • "(Certainly we can only deploy server without other instance)" -- move to the first line? like "Certainly We can deploy server without other instances. Additionally we can also ...".
  • To deploy HugeGraph-related instances via docker-compose up -d.
  • "is below" => "is as below"


```yaml
version: '3'
Expand All @@ -27,16 +27,14 @@ If you want to **pre-load** some (test) data or graphs in container(by default),

If you want to customize the pre-loaded data, please mount the the groovy scripts (not necessary).



1. Using docker run

Use `docker run -itd --name=graph -p 18080:8080 -e PRELOAD=true -v /path/to/yourScript:/hugegraph/scripts/example.groovy hugegraph/hugegraph`
to start hugegraph server.

2. Using docker compose

We can also use `docker-compose up -d` to quickly start. The `docker-compose.yaml` is below:
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-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'
Expand Down
Loading