Skip to content

Support

Getting help with GreenGovRAG

Community Support

GitHub Issues

The primary support channel is GitHub Issues:

GitHub Issues

Before Creating an Issue

  1. Search existing issues to avoid duplicates
  2. Check documentation (you're reading it!)
  3. Review troubleshooting guide: User Guide > Troubleshooting
  4. Check discussions for Q&A: GitHub Discussions

Creating a Good Issue

Include:

For Bug Reports:

  • GreenGovRAG version (greengovrag-cli --version)
  • Python version (python --version)
  • Operating system (Linux, macOS, Windows)
  • Deployment type (Docker, AWS, Azure, local)
  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Error messages and logs
  • Relevant configuration (redact secrets!)

Example Bug Report: 

**GreenGovRAG Version**: 0.1.0
**Python**: 3.12.0
**OS**: Ubuntu 22.04
**Deployment**: Docker Compose

**Steps to Reproduce**:
1. Run `docker-compose up`
2. Query API: `curl -X POST http://localhost:8000/api/query -d '{"query": "test"}'`
3. Observe error

**Expected**: 200 OK with answer
**Actual**: 500 Internal Server Error

**Error Log**:
ERROR: Qdrant connection timeout 
**Configuration**:
```env
VECTOR_STORE_TYPE=qdrant
QDRANT_URL=http://qdrant:6333

**For Feature Requests**:
- Clear use case description
- Why existing features don't meet the need
- Proposed solution (optional)
- Alternatives considered (optional)

**Example Feature Request**:
```markdown
**Feature**: Support for Victoria's Planning & Environment Act

**Use Case**: Users in Victoria need to query state-specific planning legislation, but currently only NSW and SA are supported.

**Proposed Solution**: Add VIC legislation parser in `backend/green_gov_rag/etl/sources/vic_legislation.py`

**Alternatives**: Manual document upload (not ideal for updates)

GitHub Discussions

For questions, ideas, and general discussion:

GitHub Discussions

Categories:

  • Q&A: Ask questions
  • Ideas: Propose new features
  • Show and Tell: Share your use cases
  • General: Everything else

Professional Support

For commercial deployments, custom integrations, or dedicated support:

Email: contact@sundeep.id.au

Services offered:

  • Custom document source development
  • Deployment assistance (AWS, Azure, on-premises)
  • Performance tuning and optimization
  • Integration with existing systems
  • Training and workshops
  • SLA-based support contracts

Documentation

Official Documentation

Video Tutorials

Coming soon! Subscribe to updates:

  • YouTube: TBD
  • Newsletter: TBD

Blog Posts

Coming soon! Follow for updates:

Common Issues

Installation Problems

Issue: pip install fails with dependency conflicts

Solution: 

# Use Python 3.12+ in virtual environment
python3.12 -m venv venv
source venv/bin/activate
pip install --upgrade pip
pip install -e .[dev]

Issue: Docker Compose fails with port conflicts

Solution: 

# Change ports in docker-compose.yml
services:
  backend:
    ports:
      - "8001:8000"  # Use 8001 instead of 8000

Database Issues

Issue: pgvector extension not found

Solution: 

# Rebuild database container
docker-compose down -v
docker-compose up postgres
# Wait for initialization, then:
docker-compose up backend

Issue: Connection pool exhausted

Solution: 

# Increase pool size in .env
DATABASE_POOL_SIZE=50
DATABASE_MAX_OVERFLOW=20

Vector Store Issues

Issue: Qdrant connection timeout

Solution: 

# Check Qdrant is running
docker ps | grep qdrant

# Check connection URL
curl http://localhost:6333/health

Issue: FAISS index not found

Solution: 

# Re-run ETL pipeline
greengovrag-cli etl run-pipeline

LLM Provider Issues

Issue: OpenAI API rate limit exceeded

Solution: 

# Use gpt-5-mini instead of gpt-5
LLM_MODEL=gpt-5-mini

# Or reduce concurrent requests
API_RATE_LIMIT=10/minute

Issue: Azure OpenAI deployment not found

Solution: 

# Verify deployment name matches model
az cognitiveservices account deployment list \
  --name your-openai-resource \
  --resource-group your-rg

# Update .env
AZURE_OPENAI_DEPLOYMENT=<correct-deployment-name>

Response Times

GitHub Issues:

  • Bug reports: 1-3 business days
  • Feature requests: 1-7 business days
  • Questions: 1-5 business days

Professional Support (paid):

  • Critical issues: 4 hours (business hours)
  • High priority: 1 business day
  • Normal priority: 3 business days

Note: These are targets, not guarantees. Response times may vary.

Contributing

Help improve GreenGovRAG!

Ways to Contribute

  1. Report bugs via GitHub Issues
  2. Suggest features via GitHub Discussions
  3. Fix bugs via Pull Requests
  4. Add documentation via Pull Requests
  5. Answer questions in Discussions
  6. Share use cases in Show and Tell

See Contributor Guide for details.

Recognition

Contributors are listed in:

Communication Channels

Official Channels

  • GitHub Issues: Bug reports, feature requests
  • GitHub Discussions: Questions, ideas, general discussion
  • Email: contact@sundeep.id.au (professional support)

Unofficial Channels

None at this time. We recommend using official channels to ensure:

  • Searchable history
  • Proper tracking
  • Transparency

Code of Conduct

GreenGovRAG follows the Contributor Covenant Code of Conduct.

Summary:

  • Be respectful and inclusive
  • Welcome diverse perspectives
  • Focus on constructive feedback
  • No harassment or discrimination

Reporting: contact@sundeep.id.au

Security Issues

DO NOT report security vulnerabilities via public GitHub Issues.

Email: contact@sundeep.id.au with subject "SECURITY"

Response time: 24-48 hours (expedited for critical issues)

See Security Policy for details.

Roadmap

See GitHub Projects for:

  • Planned features
  • Current priorities
  • Release schedule

Upvote features you'd like to see in GitHub Discussions!

Stay Updated

Resources

External Resources

  • LangChain: RAG framework
  • LlamaIndex: Alternative RAG framework
  • Haystack: NLP framework with RAG support
  • Weaviate: Vector database
  • Chroma: Vector database

Acknowledgments

Thank you to:

  • All contributors
  • Open-source community
  • Australian government for open data
  • Users providing feedback

Last Updated: 2025-11-22

Need Help?