Skip to content

Launching PuppyGraph in Docker

Summary

In this tutorial, you will:

  • Launch a PuppyGraph Docker container;
  • Explore an example graph using PuppyGraph Web UI.

Prerequisites

Docker Installation

Please ensure that docker is available. The installation can be verified by running:

docker version

See https://www.docker.com/get-started/ for more details on Docker.

PuppyGraph provides docker images for both amd64 and arm64 architecture.

PuppyGraph provides docker images for both amd64 and arm64 architecture. By default docker pulls the image based on host machine's architecture. However, environment variables likeDOCKER_DEFAULT_PLATFORM could override its default behavior.

If there is a mismatch, you will see warnings as follows when running PuppyGraph in Docker:

request platform(Linux/amd64) doesn’t match detected platform(Linux/arm64/v8)

Hardware

The host machine needs to have minimum 10 GB of available disk space.

It is recommended to have at least 8GB RAM for the Docker container.

Start a PuppyGraph Container

Run the command below to start a PuppyGraph Docker container. This command will also download the PuppyGraph image if it hasn't been downloaded previously.

docker run -p 8081:8081 -p 8182:8182 -p 7687:7687 -d --name puppy --rm --pull=always puppygraph/puppygraph:stable

Access the PuppyGraph

Access the PuppyGraph Web UI at http://localhost:8081.

Sign in to PuppyGraph with the username (puppygraph) and default password (puppygraph123).

PuppyGraph Sign-In Page

PuppyGraph Sign-In Page

At times, the PuppyGraph initialization might still be underway, and the Schema page will display a prompt. Please refresh the page to see if the server is ready.

PuppyGraph Server Pending Page

PuppyGraph Server Pending Page

Once the server is ready, the schema page will appear as follows.

PuppyGraph Schema Welcome Page

PuppyGraph Schema Welcome Page

Explore the Example Graph

In this tutorial, we'll be utilizing the demo data supplied by PuppyGraph. Click on Use example schema/data, and the UI will show that loading is underway.

PuppyGraph Schema Loading in Progress

PuppyGraph Schema Loading in Progress

Once the schema is loaded, the page visualizes the schema of the graph.

PuppyGraph Schema Loaded

PuppyGraph Schema Loaded

PuppyGraph features a dashboard, enabling you to quickly access essential information from the graph right away.

The default tiles on the dashboard count the total number of nodes / edges and also display the sample data from the graph.

PuppyGraph Dashboard

PuppyGraph Dashboard

Cleaning up

To sign out, click on the button located in the top right corner.

Sign Out

Sign Out

Run the following command to stop and clean up the container.

docker stop puppy