mirror of
https://github.com/dograh-hq/dograh.git
synced 2026-06-07 07:55:16 +02:00
docs: update README.md
This commit is contained in:
parent
7df73beea3
commit
ea13492a89
2 changed files with 68 additions and 55 deletions
123
README.md
123
README.md
|
|
@ -1,41 +1,70 @@
|
|||
# Dograh AI
|
||||
|
||||
<h3 align="center">⭐ <strong>If you find value in this project, please STAR the Github repository to help others discover our FOSS platform!</strong></h3>
|
||||
**The open-source, self-hostable alternative to Vapi & Retell** — build production voice agents with a drag-and-drop workflow builder. From zero to a working bot in under 2 minutes.
|
||||
|
||||
<p align="center">
|
||||
<a href="https://docs.dograh.com">
|
||||
<img src="https://img.shields.io/badge/docs-https://docs.dograh.com-blue.svg" alt="Docs: https://docs.dograh.com">
|
||||
<a href="https://app.dograh.com">
|
||||
<img src="https://img.shields.io/badge/▶_Try_the_Cloud-app.dograh.com-2563eb?style=for-the-badge" alt="Try the Cloud">
|
||||
</a>
|
||||
<a href="https://deepwiki.com/dograh-hq/dograh">
|
||||
<img src="https://deepwiki.com/badge.svg" alt="Deepwiki: https://deepwiki.com/dograh-hq/dograh">
|
||||
</a>
|
||||
<a href="LICENSE">
|
||||
<img src="https://img.shields.io/badge/license-BSD%202--Clause-blue.svg" alt="License: BSD 2-Clause">
|
||||
|
||||
<a href="#-get-started">
|
||||
<img src="https://img.shields.io/badge/⚡_Self--host_in_60s-One_command-111827?style=for-the-badge" alt="Self-host in 60s">
|
||||
</a>
|
||||
|
||||
<a href="https://join.slack.com/t/dograh-community/shared_invite/zt-3czr47sw5-MSg1J0kJ7IMPOCHF~03auQ">
|
||||
<img src="https://img.shields.io/badge/chat-on%20Slack-4A154B?logo=slack" alt="Slack Community">
|
||||
</a>
|
||||
<a href="https://www.docker.com/">
|
||||
<img src="https://img.shields.io/badge/docker-ready-blue?logo=docker" alt="Docker Ready">
|
||||
<img src="https://img.shields.io/badge/💬_Join_Slack-Community-4A154B?style=for-the-badge&logo=slack" alt="Join Slack">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
**The open-source alternative to Vapi** - Dograh helps you build your own voice agents with an easy drag-and-drop workflow builder. It's the fastest way to build voice AI agents - from zero to working bot in under 2 minutes (our hard SLA standards).
|
||||
<p align="center">
|
||||
<a href="https://docs.dograh.com">📖 Docs</a> ·
|
||||
<a href="LICENSE">📜 BSD 2-Clause</a>
|
||||
</p>
|
||||
|
||||
- **100% open source**, self-hostable platform - no vendor lock-in, unlike proprietary solutions like Vapi
|
||||
- **Full control & transparency** - every line of code is open, with built-in AI testing personas and flexible LLM/TTS/STT integration
|
||||
- **Maintained by YC alumni and exit founders**, ensuring the future of voice AI stays open, not monopolized
|
||||
<p align="center">
|
||||
<img src="docs/images/hero.gif" alt="Dograh in action — build a workflow, launch a voice agent, talk to it" width="80%">
|
||||
</p>
|
||||
|
||||
## 🎥 Demo Video
|
||||
- **100% open source**, self-hostable — no vendor lock-in, unlike Vapi or Retell
|
||||
- **Full control & transparency** — every line of code is open, with flexible LLM / TTS / STT integration
|
||||
- **Maintained by YC alumni and exit founders**, committed to keeping voice AI open
|
||||
|
||||
## 🎥 Featured
|
||||
|
||||
<div align="center">
|
||||
<a href="https://www.youtube.com/watch?v=xD9JEvfCH9k">
|
||||
<img src="https://img.youtube.com/vi/xD9JEvfCH9k/maxresdefault.jpg" alt="Dograh featured by Better Stack" width="80%" style="border-radius: 8px; box-shadow: 0 4px 6px rgba(0, 0, 0, 0.1);">
|
||||
</a>
|
||||
<br>
|
||||
<em>Featured by <strong>Better Stack</strong> — a hands-on look at Dograh</em>
|
||||
</div>
|
||||
|
||||
<details>
|
||||
<summary>📺 Prefer a 2-minute product walkthrough? Click here.</summary>
|
||||
|
||||
<div align="center">
|
||||
<a href="https://youtu.be/9gPneyf9M9w">
|
||||
<img src="docs/images/video_thumbnail_1.png" alt="Watch Dograh AI Demo Video" width="80%" style="border-radius: 8px; box-shadow: 0 4px 6px rgba(0, 0, 0, 0.1);">
|
||||
<img src="docs/images/video_thumbnail_1.png" alt="Watch Dograh AI Demo Video" width="70%" style="border-radius: 8px; box-shadow: 0 4px 6px rgba(0, 0, 0, 0.1);">
|
||||
</a>
|
||||
<br>
|
||||
<em>Click to watch a 2-minute demo of Dograh AI in action</em>
|
||||
</div>
|
||||
|
||||
</details>
|
||||
|
||||
## ⚖️ Dograh vs Vapi vs Retell
|
||||
|
||||
An honest comparison on the axes that matter most to teams evaluating voice AI platforms.
|
||||
|
||||
| | **Dograh** | **Vapi** | **Retell** |
|
||||
|---|---|---|---|
|
||||
| **License** | BSD 2-Clause (open source) | Proprietary | Proprietary |
|
||||
| **Self-hostable** | ✅ Yes — one Docker command | ❌ SaaS only | ❌ SaaS only |
|
||||
| **Pricing** | Free (self-host) · usage-based (cloud) | Per-minute SaaS | Per-minute SaaS |
|
||||
| **Bring your own LLM / STT / TTS** | ✅ Any provider, or use Dograh's stack | Configurable within their integrations | Configurable within their integrations |
|
||||
| **Source-level customization** | ✅ Every line is yours to modify | ❌ Closed source | ❌ Closed source |
|
||||
| **Data residency** | Your infra, your rules | Their cloud | Their cloud |
|
||||
| **Vendor lock-in** | None | Full | Full |
|
||||
|
||||
|
||||
## 🚀 Get Started
|
||||
|
||||
##### Download and setup Dograh on your Local Machine
|
||||
|
|
@ -56,30 +85,17 @@ curl -o docker-compose.yaml https://raw.githubusercontent.com/dograh-hq/dograh/m
|
|||
|
||||
### 🎙️ Your First Voice Bot
|
||||
|
||||
1. **Open Dashboard**: Launch [http://localhost:3010](http://localhost:3010) on your browser
|
||||
2. **Choose Call Type**: Select **Inbound** or **Outbound** calling.
|
||||
3. **Name Your Bot**: Use a short two-word name (e.g., _Lead Qualification_).
|
||||
4. **Describe Use Case**: In 5–10 words (e.g., _Screen insurance form submissions for purchase intent_).
|
||||
5. **Launch**: Your bot is ready! Open the bot and click **Web Call** to talk to it.
|
||||
6. **No API Keys Needed**: We auto-generate Dograh API keys so you can start immediately. You can switch to your own keys anytime.
|
||||
7. **Default Access**: Includes Dograh’s own LLMs, STT, and TTS stack by default.
|
||||
8. **Bring Your Own Keys**: Optionally connect your own API keys for LLMs, STT, TTS, or telephony providers like Twilio.
|
||||
1. Open [http://localhost:3010](http://localhost:3010) in your browser.
|
||||
2. Pick **Inbound** or **Outbound**, name your bot (e.g. _Lead Qualification_), and describe the use case in 5–10 words (e.g. _Screen insurance form submissions for purchase intent_).
|
||||
3. Click **Web Call** — you're talking to your bot.
|
||||
|
||||
## Quick Summary
|
||||
|
||||
⚡ **Open-source alternative to Vapi** - 2-minute setup with hard SLA standards
|
||||
|
||||
- 🔧 **No vendor lock-in**: Self-hostable platform vs proprietary SaaS solutions
|
||||
- 🤖 **AI Testing Personas**: Test your bots with LoopTalk AI that mimics real customer interactions
|
||||
- 🔓 **100% Open Source**: Every line of code is open - no hidden logic, no black boxes (unlike Vapi)
|
||||
- 🔄 **Flexible Integration**: Bring your own LLM, TTS, or STT - or use Dograh's APIs
|
||||
- ☁️ **Deploy anywhere**: Self-host or use our hosted version at app.dograh.com
|
||||
> 🔑 **No API keys needed.** Dograh ships with auto-generated keys and its own LLM / TTS / STT stack. Connect your own keys for LLM, TTS, STT, or Telephony (e.g. Twilio, Vonage, Telnyx) anytime.
|
||||
|
||||
## Features
|
||||
|
||||
### Voice Capabilities
|
||||
|
||||
- Telephony: Built-in telephony integration like Twilio, Vonage, Vobiz, Cloudonix (easily add others)
|
||||
- Telephony: Built-in telephony integration like Twilio, Vonage, Vobiz, Cloudonix (easily add others), with support for transferring calls to human agents
|
||||
- Languages: English support (expandable to other languages)
|
||||
- Custom Models: Bring your own TTS/STT models
|
||||
- Real-time Processing: Low-latency voice interactions
|
||||
|
|
@ -93,13 +109,9 @@ curl -o docker-compose.yaml https://raw.githubusercontent.com/dograh-hq/dograh/m
|
|||
|
||||
### Testing & Quality
|
||||
|
||||
- LoopTalk (Beta): Create AI personas to test your voice agents
|
||||
- Workflow Testing: Test specific workflow IDs with automated calls
|
||||
- Real-world Simulation: AI personas that mimic actual customer behavior
|
||||
|
||||
## Architecture
|
||||
|
||||
Architecture diagram _(coming soon)_
|
||||
- **Test Mode**: Try your agent end-to-end before publishing, with no production calls or data affected
|
||||
- **In-Dashboard Web Calls**: Talk to your bot directly while building — no telephony setup required
|
||||
- **QA Node**: A built-in workflow node that analyzes prompt quality across your other nodes
|
||||
|
||||
## Deployment Options
|
||||
|
||||
|
|
@ -111,10 +123,6 @@ Refer [Local Setup](https://docs.dograh.com/contribution/setup)
|
|||
|
||||
For detailed deployment instructions including remote server setup with HTTPS, see our [Docker Deployment Guide](https://docs.dograh.com/deployment/docker).
|
||||
|
||||
### Production (Self-Hosted)
|
||||
|
||||
Production guide coming soon. [Drop in a message](https://join.slack.com/t/dograh-community/shared_invite/zt-3czr47sw5-MSg1J0kJ7IMPOCHF~03auQ) for assistance.
|
||||
|
||||
### Cloud Version
|
||||
|
||||
Visit [https://www.dograh.com](https://www.dograh.com/) for our managed cloud offering.
|
||||
|
|
@ -125,12 +133,11 @@ You can go to [https://docs.dograh.com](https://docs.dograh.com/) for our docume
|
|||
|
||||
## 🤝Community & Support
|
||||
|
||||
- GitHub Issues: Report bugs or request features
|
||||
- Slack: Our Slack community is not just for support — it’s the cornerstone of Dograh AI contributions. Here, you can:
|
||||
- Connect with maintainers and other contributors
|
||||
- Discuss issues and features before coding
|
||||
- Get help with setup and debugging
|
||||
- Stay up to date with contribution sprints
|
||||
> 👋 **Coming from the Better Stack video?** Drop your use case in our [pinned GitHub Discussion](https://github.com/orgs/dograh-hq/discussions/291) — we read every reply and the founders personally onboard early adopters.
|
||||
|
||||
- **Slack** — the cornerstone of Dograh AI contributions. Connect with maintainers, discuss features before coding, get help with setup, and stay current on contribution sprints.
|
||||
- **GitHub Discussions** — share use cases, ask questions, swap workflow recipes.
|
||||
- **GitHub Issues** — report bugs or request features.
|
||||
|
||||
👉 Join us → [Dograh Community Slack](https://join.slack.com/t/dograh-community/shared_invite/zt-3czr47sw5-MSg1J0kJ7IMPOCHF~03auQ)
|
||||
|
||||
|
|
@ -146,6 +153,12 @@ We love contributions! Dograh AI is 100% open source and we intend to keep it th
|
|||
- Push to the branch (git push origin feature/AmazingFeature)
|
||||
- Open a Pull Request
|
||||
|
||||
## ⭐ Star History
|
||||
|
||||
<a href="https://star-history.com/#dograh-hq/dograh&Date">
|
||||
<img src="https://api.star-history.com/svg?repos=dograh-hq/dograh&type=Date" alt="Dograh star history" width="80%">
|
||||
</a>
|
||||
|
||||
## 📄 License
|
||||
|
||||
Dograh AI is licensed under the [BSD 2-Clause License](LICENSE)- the same license as projects that were used in building Dograh AI, ensuring compatibility and freedom to use, modify, and distribute.
|
||||
|
|
|
|||
BIN
docs/images/hero.gif
Normal file
BIN
docs/images/hero.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.8 MiB |
Loading…
Add table
Add a link
Reference in a new issue