Skip to content
This repository has been archived by the owner on Oct 15, 2023. It is now read-only.

Commit

Permalink
Update README for new compose configurations
Browse files Browse the repository at this point in the history
Signed-off-by: Bramford Horton <bram.horton@gmail.com>
  • Loading branch information
bramford committed Jul 17, 2019
1 parent d2bf8f2 commit 2290967
Showing 1 changed file with 21 additions and 9 deletions.
30 changes: 21 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,18 +45,30 @@ gremlin> :> g.V().values('name')

### Using Docker Compose

Start a JanusGraph Server instance using [`docker-compose.yml`](docker-compose.yml):
Two docker-compose configurations are available, each supports different storage backend configuration:

`docker-compose.yml` - Runs Janusgraph using only the Berkeley DB storage backend.
`docker-compose-cql-es.yml` - Runs Janusgraph server with Cassandra + CQL for storage and Elasticearch for indexing.

Start a JanusGraph Server instance using one of the above compose files:

```bash
docker-compose -f docker-compose.yml up
# BerkeleyDB
docker-compose up
# OR
# Cassandra + CQL and Elasticsearch
docker-compose -f docker-compose-cql-es.yml up
```

Start a JanusGraph container running Gremlin Console in the same network using
[`docker-compose.yml`](docker-compose.yml):
The compose configurations also include a JanusGraph container running Gremlin Console in the same network.
You can attach to the console and start using it:

```bash
docker-compose -f docker-compose.yml run --rm \
-e GREMLIN_REMOTE_HOSTS=janusgraph janusgraph ./bin/gremlin.sh
# BerkeleyDB
docker attach janusgraph-default-gremlin-console
# OR
# Cassandra + CQL and Elasticsearch
docker attach jce-gremlin-console
```

### Generate Config
Expand Down Expand Up @@ -90,9 +102,9 @@ The environment variables supported by the JanusGraph image are summarized below

The `JANUS_PROPS_TEMPLATE` environment variable is used to define the base JanusGraph
properties file. Values in the template properties file are used unless an alternate value
for a given property is provided in the environment. The common usage will be to specify
a template for the general environment (e.g., `cassandra-es`) and then provide additional
individual configuration to override/extend the template. The available templates depend
for a given property is provided in the environment. The common usage will be to specify
a template for the general environment (e.g., `cassandra-es`) and then provide additional
individual configuration to override/extend the template. The available templates depend
on the JanusGraph version (see [`conf/gremlin-server/janusgraph*.properties`][JG_TEMPLATES]).

| `JANUS_PROPS_TEMPLATE` | Supported Versions |
Expand Down

0 comments on commit 2290967

Please sign in to comment.