Skip to content

PuppyGraph Web UI

PuppyGraph provides a web-based User Interface (UI) for graph management and visualization.

This guide introduces the main features of the PuppyGraph Web UI. See also PuppyGraph CLI for command-line interface (CLI) usage.

To use the UI, please ensure your browser meets the System Requirements.

Login

The Login page asks for the username and password.

The default username is puppygraph, while the default password varies:

  • The value of the PUPPYGRAPH_PASSWORD environment variable for instances launched from Docker
  • EC2 Instance ID for instances launched from PuppyGraph Professional AMI in AWS Marketplace
  • Compute Engine Instance Id for instances launched from PuppyGraph Professional VM in Google Cloud Marketplace
Logging

Logging

Schema

The Schema page is the default page after login. It provides different methods of modeling a graph.

  • Create Graph Schema: Create a schema using the interactive tool
  • Upload Graph Schema JSON: Upload a schema file in JSON format
  • Use example schema/data: Load the example graph
Schema Page

Schema Page

After a schema is uploaded, the Schema page shows the visualized graph schema as well as the JSON schema (folded by default).

Schema Page with a Loaded Schema

Schema Page with a Loaded Schema

Query

The Query page features a suite of tools that enables graph querying on the web UI.





See Querying for more details.

Visualize

The Visualize page contains an interactive explorer to view the graph.


See Graph Explorer for more details.

Dashboard

The Dashboard page contains a customizable dashboard to enhance your data visualization and sharing capabilities.


See Dashboard for more details.

Settings

The Settings page allows you to manage your account and configure the system settings.


The UI Preferences section allows you to customize the UI settings. You can turn off the visualization on the graph canvas to reduce resource usage.

The Local Cache section displays locally cached data on PuppyGraph. You can refresh the cache for individual nodes or edges, or refresh the entire cache. To learn more about the local cache, see Locally Cached Graph Data.

The Cluster Management section displays the cluster information, including the cluster status and the list of nodes in the cluster. To learn how to set up a PuppyGraph cluster, see Cluster Deployment.

The Server Management section allows you to restart the current node. This is helpful when running PuppyGraph in a single-node mode for quick testing. You can also download the server logs for troubleshooting.

The Password section allows you to change your password for the admin account.