Skip to content

Latest commit

 

History

History
97 lines (60 loc) · 2.11 KB

README.md

File metadata and controls

97 lines (60 loc) · 2.11 KB
Raw

AgensGraphViewer

Web-based user interface that provides visualization of graph data stored in an AgensGraph database.

This is a sub-project of AgensGraph

Recommended Node Version & install module

  • Node version - 14.16.0
  • Node Module - pm2

Install latest pm2 with :

npm i pm2

pm2 is an NPM module to run the project in production mode.

Installing AgensGraphViewer

Extract the release .zip or .tar.gz package into your desired directory.

From the commandline, navigate to the directory agv-package.

  • Install the required node modules using:
npm run setup

How to start using AgensGraphViewer

AgensGraphViewer is a graphical user interface for AgensGraph, so it needs an AgensGraph server running on the background.

Tipically, this is done with the command

ag_ctl start [-D /path/created/by/initdb]

For the other settings or usage instructions, please follow AgensGraph's documentation.

Running AgensGraphViewer

  • Run AgenGraphViewer in production environment using :
pm2 start ecosystem.config.js --env release

This will start AgensGraphViewer on http://localhost:3000 if port 3000 is free.

To stop the process use the commands:

pm2 stop ag-viewer-release 
pm2 delete ag-viewer-release

Connect AgensGraphViewer to AgensGraph Database

Standard Connection Settings

  • Database type: AgensGraph
  • Connect URL: 127.0.0.1
  • Connect Port: 5432

Using the Docker image:

  • Pulling the image:
docker pull markgomer/agensgraphviewer
  • Run the container:
docker run --name agviewer -p 3000:3000 -d markgomer/agensgraphviewer:1.1.0

Then open the URL 127.0.0.1:3000 on your browser.

Tip: if your AgensGraph server is running on your host machine, the URL to connect to it should be "host.docker.internal".

For developers:

Fork this repository, then clone your fork

## install node modules
npm run setup
## start the development environment
npm run start