README.md

GraphRAG WebUI

A web interface for GraphRAG.

Requirements

• Ubuntu 24
  • Azure Virtual Machines
• Docker & Docker Compose
  • Install Docker Engine on Ubuntu
• Azure CLI

Install Docker & Docker Compose

sudo apt update -y
sudo snap install docker
sudo apt install docker-compose -y

Set Authentication (Optional)

If you want to set authentication, copy and set your config.yaml:

cp config.yaml.example config.yaml

Start App

bash start.sh

When the applications are started, you will have access to 3 URLs:

• Management App: http://localhost:9000/
  • OR http://{your-vm-ip}:9000/
• API Documentation: http://localhost:9002/docs
  • OR http://{your-vm-ip}:9002/docs

Update GraphRAG WebUI

bash update.sh

Make App as system Service

If you want to make the app as your service, run:

bash service.sh

Deploy to production environment

Before deploying the applications, run:

az login

Deploy API

bash deploy_api.sh