https://github.com/theodoreniu/graphrag_webui
A web interface for GraphRAG. 🚀
https://github.com/theodoreniu/graphrag_webui
graphrag llm rag
Last synced: 8 months ago
JSON representation
A web interface for GraphRAG. 🚀
- Host: GitHub
- URL: https://github.com/theodoreniu/graphrag_webui
- Owner: theodoreniu
- Created: 2024-12-25T04:10:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-26T05:09:59.000Z (about 1 year ago)
- Last Synced: 2025-07-07T18:58:02.619Z (12 months ago)
- Topics: graphrag, llm, rag
- Language: Python
- Homepage:
- Size: 1.18 MB
- Stars: 8
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GraphRAG WebUI 🙋
A web interface for [GraphRAG](https://github.com/microsoft/graphrag).
Our team members:
- [@Shuang](https://github.com/Shuang-MS)
- [@Tron](https://github.com/tron19920125)
- [@Alfred](https://github.com/alfredzouang)
## Cloud Resources
To deploy and run this solution, the following resources need to be activated:
- [Azure Virtual Machines](https://portal.azure.com/#browse/Microsoft.Compute%2FVirtualMachines)
- [AI Search](https://portal.azure.com/#view/Microsoft_Azure_ProjectOxford/CognitiveServicesHub/~/CognitiveSearch)
- [Azure OpenAI](https://portal.azure.com/#view/Microsoft_Azure_ProjectOxford/CognitiveServicesHub/~/OpenAI)
- [Document intelligence](https://portal.azure.com/#view/Microsoft_Azure_ProjectOxford/CognitiveServicesHub/~/FormRecognizer)
## Requirements
- Ubuntu 24
- [Azure Virtual Machines](https://portal.azure.com/#browse/Microsoft.Compute%2FVirtualMachines)
- Docker & Docker Compose
- [Install Docker Engine on Ubuntu](https://docs.docker.com/engine/install/ubuntu/)
- [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli)
## Install Docker & Docker Compose
```bash
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:
```bash
cp config.yaml.example config.yaml
```
## Start App
```bash
bash start.sh
```
When the applications are started, you will have access to 2 URLs:
- Management App:
- OR
- API Documentation:
- OR
## Update GraphRAG WebUI
```bash
bash update.sh
```
## Make App as system Service
If you want to make the app as your service, run:
```bash
bash service.sh
```
## Deploy to production environment
Before deploying the applications, run:
```bash
az login
```
### Deploy API
You need copy env file and update first.
```bash
cp .env.example .env
```
Deploy API:
```bash
bash deploy_api.sh
```