kineviz/graphxr-database-proxy repository overview

⁠GraphXR Database Proxy

A secure middleware that connects GraphXR⁠ to various backend databases with zero trust architecture.

⁠Features

• Zero Trust Security: Strict authentication and authorization at the proxy layer
• Direct Browser Connectivity: REST/GraphQL APIs for efficient data access
• Multi-Database Support: Spanner Graph, Neo4j, and more
• Open Source: Fully auditable and customizable
• Pure Python: Easy to deploy and maintain

⁠⚡ Quick Start for Spanner Graph

1. Run the following commands to start graphxr-database-proxy (requires uv⁠, node.js⁠)

git clone https://github.com/Kineviz/graphxr-database-proxy.git
cd graphxr-database-proxy
uv venv
source .venv/bin/activate # or .venv/bin/activate on Windows
uv pip install -e ".[ui]"
uv pip install -r requirements.txt
cd frontend && npm install && npm run build && cd -
graphxr-proxy --ui 

1. Visit http://localhost:9080/⁠
2. Click "Create New Project"
3. Project Name: "Test"
4. Database Type: "Google Cloud Spanner"
5. Authentication Type: "Service Account"
6. Upload the credential file you exported from GCP Console or gcloud CLI. Export Instructions⁠
7. Select "Instance ID" e.g. "demo"
8. Select "Database ID" e.g. "cymbal"
9. Select "Property Graph" e.g. "ECommerceGraph"
10. Click "Create"
11. For the new project, under Actions, copy the API URL. e.g. "http://localhost:9080/api/spanner/Test⁠"
12. Go back to GraphXR's Create Project wizard and paste the API URL into GraphXR for a project with a "Database Proxy" database type.

⁠Other ways to start graphxr-database-proxy

⁠Install

# Install from PyPI
pip install graphxr-database-proxy[ui]

# Or from source
git clone https://github.com/Kineviz/graphxr-database-proxy.git
cd graphxr-database-proxy
uv venv
source .venv/bin/activate # or .venv/bin/activate on Windows
uv pip install -e ".[ui]"
uv pip install -r requirements.txt
cd frontend && npm install && npm run build && cd -
pip install -e .[ui]

⁠Configure & Run

Option 1: Web UI (Recommended)

graphxr-proxy --ui

Option 2: Python Code

from graphxr_database_proxy import DatabaseProxy

proxy = DatabaseProxy()

service_account_json = {
    "type": "service_account",
    "project_id": "your-gcp-project-id",
    "private_key": "-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n",
    "client_email": "[email protected]",
    ...
}

project_id = proxy.add_project(
    project_name="project_name",
    database_type="spanner",
    project_id="gcp-project-id", 
    instance_id="spanner-instance-id",
    database_id="spanner-database-id",
    credentials=service_account_json,  
    graph_name="graph_name"  # Optional
)

proxy.start(
    host="0.0.0.0",     
    port=9080,          
    show_apis=True     
)

⁠🐳 Docker

docker run -d -p 9080:9080 \
--name graphxr-database-proxy \
-v ${HOME}/graphxr-database-proxy/config:/app/config \
kineviz/graphxr-database-proxy:latest

⁠🤝 Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

⁠📄 License

This project is licensed under the MIT License - see the LICENSE⁠ file for details.

⁠🆘 Support

• 🐛 Issue Tracker⁠
• 📧 Email: [email protected]⁠

Built with ❤️ by Kineviz⁠