Metadata-Version: 2.2
Name: graphrag_webui
Version: 1.2.0
Summary: A web interface for GraphRAG.
Home-page: https://github.com/theodoreniu/graphrag_webui
Author: Theodoree
Author-email: theodore.niu@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: click
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# GraphRAG WebUI

A web interface for [GraphRAG](https://github.com/microsoft/graphrag).

## 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 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
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 Test App

```bash
bash deploy_test.sh
```

### Deploy API

```bash
bash deploy_api.sh
```
