Skip to content

Commit

Permalink
Neo4j docs: mention docker option
Browse files Browse the repository at this point in the history
refs #32
  • Loading branch information
dhimmel committed Jun 21, 2020
1 parent fa6182b commit a95ae76
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions hetnet/neo4j/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,32 @@ This adds source/target metanode awareness to relationship types and [enables](h

## Neo4j setup instructions

Download and extract Neo4j 3.0 Community Edition [from Neo4j](http://neo4j.com/download/other-releases/ "Neo4j Releases").
Make sure the Neo4j server is stopped. Navigate to the `data/databases` directory inside the Neo4j directory and run:
### Importing the database

Download and extract Neo4j Community Edition version 3.* [from Neo4j](http://neo4j.com/download/other-releases/ "Neo4j Releases").
Make sure the Neo4j server is stopped.
Navigate to the `data/databases` directory inside the Neo4j directory and run:

```sh
# Backup graph.db directory if it exists
if [ -d "graph.db" ]; then
mv graph.db graph.db.backup_`date +%F`
mv graph.db graph.db.backup_$(date +%F)
fi

# Download and extract graph.db for Hetionet v1.0
curl --location https://github.com/hetio/hetionet/raw/master/hetnet/neo4j/hetionet-v1.0.db.tar.bz2 | tar --extract --bzip2
```

If curl throws an error related to SSL or certificates, you can add the `--insecure` argument to `curl` to allow connections to SSL sites without certs.
If curl throws an error related to SSL or certificates,
you can add the `--insecure` argument to `curl` to allow connections to SSL sites without certs.

The above commands should create a `graph.db` directory inside `data`. You should now be able to power up your Neo4j server.
The above commands should create a `graph.db` directory inside `data`.
You should now be able to power up your Neo4j server.
Once the server is running you can access the browser at http://localhost:7474/.
Delete the `graph.db` directory to uninstall Hetionet as the default Neo4j database.

### Via docker

While the docker image is primarily designed to serve the production instance available at <https://neo4j.het.io>,
it can also be used to launch the database locally.
See command in the [`docker`](docker#running-the-docker) directory README for more information.

0 comments on commit a95ae76

Please sign in to comment.