Skip to content

README.md

Latest commit

 

History

History
85 lines (58 loc) · 3.43 KB

README.md

File metadata and controls

85 lines (58 loc) · 3.43 KB

Getting Started

Graph Explorer is distributed as a Docker image. The image includes the Graph Explorer web application and a proxy server that handles connections to your graph database.

Try It Out

The fastest way to try Graph Explorer is with the Air Routes sample. It launches Graph Explorer and a Gremlin Server pre-loaded with sample data using Docker Compose — no database setup or AWS account required.

Prerequisites

  • Docker installed on your machine

Steps

  1. Clone the repository 
    git clone https://github.com/aws/graph-explorer.git
  2. Navigate to the sample directory and start the containers 
    cd graph-explorer/samples/air_routes
docker compose up
  3. Open the browser and navigate to: http://localhost:8080/explorer

See the samples directory for more examples.

Examples

Local Docker Setup

The quickest way to get started with Graph Explorer is to use the official Docker image. You can find the latest version of the image on
Amazon's ECR Public Registry.

Note

Make sure to use the version of the image that does not include sagemaker in the tag.

Prerequisites

  • Docker installed on your machine
  • AWS CLI installed on your machine

Steps

  1. Authenticate with the Amazon ECR Public Registry. More information

    aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws

  2. Pull down the docker image

    docker pull public.ecr.aws/neptune/graph-explorer

  3. Create and run a docker container using the image

    docker run -p 80:80 -p 443:443 \
 --env HOST=localhost \
 --name graph-explorer \
 public.ecr.aws/neptune/graph-explorer

    The HOST environment variable is used for SSL certificates generation since HTTPS is the default. If you are hosting this on a public domain, you should replace HOST=localhost with your domain name.

  4. Open a browser and type in the URL of the Graph Explorer server instance

    https://localhost/explorer

  5. You will receive a warning as the SSL certificate used is self-signed. Since the application is set to use HTTPS by default and contains a self-signed certificate, you will need to add the Graph Explorer certificates to the trusted certificates directory and manually trust them. See the HTTPS Connections section.

  6. After completing the trusted certification step and refreshing the browser, you should now see the Connections UI. See below description on Connections UI to configure your first connection to Amazon Neptune.

Next Steps