owly

KO | EN

gitlite — search

#hacktoberfest #react #ai #typescript #golang #go #android #deep-learning #docker #java #nodejs #pytorch #security #openai

(★ 118)

AI-powered customer support agent with WhatsApp, Email & Phone channels

owly 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<a href="#features">Features</a> &middot;
 <a href="#screenshots">Screenshots</a> &middot;
 <a href="#quick-start">Quick Start</a> &middot;
 <a href="#configuration">Configuration</a> &middot;
 <a href="#api">API</a> &middot;
 <a href="#tech-stack">Tech Stack</a> &middot;
 <a href="docs/wiki/Home.md">Wiki</a> &middot;
 <a href="#roadmap">Roadmap</a>

---

## What is Owly?

Owly is a **self-hosted AI customer support agent** that small businesses and individuals can run on their own machines -- completely free. Connect your WhatsApp, Email, and Phone channels, add your business knowledge, and let the AI handle customer inquiries 24/7. Owly automatically identifies customers across channels -- someone who emails first and later calls gets a unified profile with full conversation history.

<table>
 <tr>
 <td width="25%" align="center">
 
 Zero Cost 
 No monthly fees. You only pay for AI API usage.
 
 </td>
 <td width="25%" align="center">
 
 Your Data, Your Server 
 Everything runs on your machine. Complete privacy.
 
 </td>
 <td width="25%" align="center">
 
 Multi-Channel 
 WhatsApp, Email, and Phone from a single dashboard.
 
 </td>
 <td width="25%" align="center">
 
 5-Minute Setup 
 Docker Compose or npm. Guided setup wizard.
 
 </td>
 </tr>
</table>

---

## Features

### Multi-Channel Support

Connect all your customer communication channels in one place.

<table>
 <tr>
 <td width="33%">
 <h4 align="center">WhatsApp</h4>
 Connect via QR code scan or Business API. Handles text, images, voice messages, and documents.
 </td>
 <td width="33%">
 <h4 align="center">Email</h4>
 IMAP/SMTP with any provider. Branded HTML templates with automatic thread tracking.
 </td>
 <td width="33%">
 <h4 align="center">Phone</h4>
 Twilio Voice with OpenAI Whisper (STT) and ElevenLabs (TTS) for natural voice conversations.
 </td>
 </tr>
</table>

<img src="docs/screenshots/12-channels.png" alt="Channel Management" width="100%" />
 
 Connect and manage all channels from one screen

### AI-Powered Conversations

Owly uses OpenAI GPT (extensible to Claude, Ollama) with your knowledge base to provide accurate, on-brand responses. During conversations, the AI can autonomously:

- **Create tickets** when customers report problems
- **Route issues** to the right department based on expertise matching
- **Send internal emails** to notify team members about urgent issues
- **Look up customer history** for context-aware support
- **Trigger webhooks** to notify external systems
- **Schedule follow-ups** for proactive customer care

<img src="docs/screenshots/03-conversations.png" alt="Conversations" width="100%" />
 
 Unified inbox with conversation thread and admin takeover

### Customer CRM & Cross-Channel Continuity

Every customer gets a unified profile across all channels -- conversations, notes, tags, and contact history in one place. Owly automatically resolves customer identity when someone switches channels (WhatsApp to Email to Phone), keeping the full context available to both the AI and your team.

<img src="docs/screenshots/04-customers.png" alt="Customer Management" width="100%" />
 
 Customer profiles with notes, tags, and cross-channel history

### Knowledge Base

Train your AI with your business information. Organize entries into categories, set priorities, and test responses before going live.

<table>
 <tr>
 <td width="50%">
 <img src="docs/screenshots/05-knowledge-base.png" alt="Knowledge Base Categories" />
 
 Categories with entry counts and color coding
 </td>
 <td width="50%">
 <img src="docs/screenshots/20-knowledge-detail.png" alt="Knowledge Base Entries" />
 
 Entries with priority levels and active toggles
 </td>
 </tr>
</table>

### Automation Engine

Automate repetitive tasks with rule-based automation, business hours, SLA tracking, and canned responses.

<table>
 <tr>
 <td width="50%">
 <img src="docs/screenshots/07-automation.png" alt="Automation Rules" />
 
 Auto-route, auto-tag, auto-reply, keyword alerts
 </td>
 <td width="50%">
 <img src="docs/screenshots/06-canned-responses.png" alt="Canned Responses" />
 
 Quick reply templates with shortcuts
 </td>
 </tr>
</table>

<table>
 <tr>
 <td width="50%">
 <img src="docs/screenshots/08-business-hours.png" alt="Business Hours" />
 
 Weekly schedule with timezone and offline messages
 </td>
 <td width="50%">
 <img src="docs/screenshots/11-sla-rules.png" alt="SLA Rules" />
 
 Response time targets per channel and priority
 </td>
 </tr>
</table>

### Team & Ticket Management

Organize your team into departments, track issues with a full ticket system, and monitor performance.

<table>
 <tr>
 <td width="50%">
 <img src="docs/screenshots/09-team.png" alt="Team Management" />
 
 Departments, members, expertise, and availability
 </td>
 <td width="50%">
 <img src="docs/screenshots/10-tickets.png" alt="Ticket System" />
 
 Priority levels, assignments, and status tracking
 </td>
 </tr>
</table>

### Analytics & Insights

Monitor your support performance with charts, metrics, and team performance tracking.

<img src="docs/screenshots/14-analytics.png" alt="Analytics Dashboard" width="100%" />
 
 Conversation trends, channel breakdown, ticket distribution, and satisfaction scores

### Administration & API

Manage users, API keys, webhooks, and explore the full REST API with interactive documentation.

<table>
 <tr>
 <td width="50%">
 <img src="docs/screenshots/16-admin.png" alt="Administration" />
 
 Multi-admin with roles and API key management
 </td>
 <td width="50%">
 <img src="docs/screenshots/17-api-docs.png" alt="API Documentation" />
 
 Interactive API docs with live request testing
 </td>
 </tr>
</table>

### Dark Mode

Full dark theme with persistent preference, applied across all 19 pages.

<img src="docs/screenshots/19-dark-mode.png" alt="Dark Mode" width="100%" />
 
 Dark mode dashboard with consistent styling across all components

### More Features

<table>
 <tr>
 <td width="50%">
 <img src="docs/screenshots/18-settings.png" alt="Settings" />
 
 6-tab settings: General, AI, Voice, Phone, Email, WhatsApp
 </td>
 <td width="50%">
 <img src="docs/screenshots/13-webhooks.png" alt="Webhooks" />
 
 Webhook management with payload preview and testing
 </td>
 </tr>
</table>

---

## Quick Start

### Prerequisites

- **Node.js** 20+
- **PostgreSQL** 16+

### Option 1: npm

```bash
# Clone the repository
git clone https://github.com/hsperus/owly.git
cd owly

# Install dependencies
npm install

# Set up environment
cp .env.example .env
# Edit .env with your database URL and API keys

# Run database migrations
npx prisma migrate dev

# (Optional) Load sample data with a default admin account
npm run db:seed
# Default login: username=admin, password=admin123

# Start the development server
npm run dev
```

### Option 2: Docker Compose

```bash
git clone https://github.com/hsperus/owly.git
cd owly

cp .env.example .env
# Edit .env with your API keys

docker compose up -d
```

Open [http://localhost:3000](http://localhost:3000) -- the setup wizard will guide you through the initial configuration.

<img src="docs/screenshots/01-login.png" alt="Login Page" width="500" />
 
 Clean login page with Owly branding

---

## Configuration

All configuration is done through the admin dashboard -- no config files to edit after initial setup:

| Setting | Location | Description |
|---------|----------|-------------|
| Business profile | Settings > General | Name, description, welcome message, tone |
| AI provider | Settings > AI Configuration | OpenAI / Claude / Ollama, model, API key |
| Voice | Settings > Voice | ElevenLabs API key and voice selection |
| Phone | Settings > Phone | Twilio Account SID, auth token, phone number |
| Email | Settings > Email | SMTP and IMAP server configuration |
| WhatsApp | Channels > WhatsApp | QR code scan or Business API |
| Team | Team | Departments, members, expertise areas |
| SLA | SLA Rules | Response and resolution time targets |
| Schedule | Business Hours | Weekly availability and offline messages |
| Automation | Automation | Auto-route, auto-tag, auto-reply rules |
| Templates | Canned Responses | Pre-written reply templates |
| Integrations | Webhooks | External service connections |

---

## API

Owly provides a full REST API with **OpenAPI 3.0 spec** at `/api/openapi.json`. Interactive documentation with live testing is available at `/api-docs` in the dashboard. All list endpoints are paginated (max 100/page) with standardized response format.

```bash
# Send a message and get AI response
curl -X POST http://localhost:3000/api/chat \
  -H "Content-Type: application/json" \
  -d '{"message": "What are your business hours?", "channel": "api"}'

# Response:
# {"conversationId": "...", "response": "We are open Monday to Friday, 9 AM to 6 PM..."}
```

```bash
# Health check (database, OpenAI, memory, uptime)
curl http://localhost:3000/api/health
# {"status": "ok", "version": "0.2.1", "services": {"database": "connected", "openai": "reachable"}, ...}
```

Every API response includes enterprise headers: `X-Request-Id`, `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-API-Version`.

<details>
<summary>View all endpoints</summary>

| Method | Endpoint | Description |
|--------|----------|-------------|
| `POST` | `/api/chat` | Send message, get AI response |
| `GET` `POST` | `/api/conversations` | List or create conversations |
| `GET` `PUT` `DELETE` | `/api/conversations/:id` | Manage a conversation |
| `POST` | `/api/conversations/:id/messages` | Add message (admin takeover) |
| `POST` | `/api/conversations/:id/satisfaction` | Rate conversation (1-5) |
| `POST` | `/api/conversations/:id/notes` | Add internal note |
| `GET` `POST` | `/api/customers` | List or create customers |
| `GET` `PUT` `DELETE` | `/api/customers/:id` | Manage a customer |
| `GET` | `/api/customers/:id/conversations` | Cross-channel conversation timeline |
| `GET` `POST` | `/api/tickets` | List or create tickets |
| `GET` `PUT` `DELETE` | `/api/tickets/:id` | Manage a ticket |
| `GET` `POST` | `/api/knowledge/categories` | Knowledge categories |
| `GET` `POST` | `/api/knowledge/entries` | Knowledge entries |
| `POST` | `/api/knowledge/test` | Test AI with a question |
| `GET` `PUT` | `/api/settings` | Application settings |
| `GET` | `/api/analytics?period=7d` | Analytics data |
| `GET` | `/api/export?type=conversations&format=csv` | Export (CSV/JSON) |
| `GET` `POST` | `/api/automation` | Automation rules |
| `GET` `PUT` | `/api/business-hours` | Business hours config |
| `GET` `POST` | `/api/sla` | SLA rules |
| `GET` `POST` | `/api/canned-responses` | Canned responses |
| `GET` `POST` | `/api/webhooks` | Webhook management |
| `POST` | `/api/webhooks/test` | Test a webhook |
| `GET` `POST` | `/api/webhooks/:id/deliveries` | Delivery log and retry |
| `GET` `POST` | `/api/admin/users` | Admin user management |
| `GET` `POST` | `/api/admin/api-keys` | API key management |
| `GET` | `/api/activity` | Activity audit log |
| `GET` | `/api/health` | Health check |
| `GET` | `/api/openapi.json` | OpenAPI 3.0 specification |

</details>

---

## Tech Stack

| Layer | Technology |
|-------|-----------|
| **Framework** | Next.js 16 (App Router) |
| **Language** | TypeScript 5 |
| **Database** | PostgreSQL 16 + Prisma 7 |
| **UI** | Tailwind CSS 4 + Radix UI |
| **AI** | OpenAI GPT (extensible to Claude, Ollama) |
| **Voice TTS** | ElevenLabs |
| **Voice STT** | OpenAI Whisper |
| **Phone** | Twilio Voice API |
| **WhatsApp** | whatsapp-web.js |
| **Auth** | JWT + bcrypt (12 rounds) |
| **Validation** | Zod schemas on all endpoints |
| **Testing** | Vitest (274 tests) |
| **Charts** | Pure CSS/SVG (zero dependencies) |
| **Deployment** | Docker Compose / Kubernetes (Helm) |

---

## Project Structure

```
owly/
├── prisma/                  # Database schema, migrations, seed
├── public/                  # Static assets (logo)
├── docs/
│   ├── screenshots/         # UI screenshots (20 images)
│   └── wiki/                # Full documentation (25 pages)
├── helm/owly/               # Kubernetes Helm chart
│   ├── Chart.yaml
│   ├── values.yaml
│   └── templates/           # K8s manifests (deployment, service, ingress, hpa, etc.)
├── src/
│   ├── app/
│   │   ├── (auth)/          # Login, setup wizard
│   │   ├── (dashboard)/     # 19 dashboard pages
│   │   └── api/             # 60+ REST API endpoints
│   ├── components/
│   │   ├── layout/          # Sidebar, header
│   │   └── ui/              # 12 reusable components
│   └── lib/
│       ├── ai/              # AI engine, tools, types
│       ├── channels/        # WhatsApp, email, phone
│       ├── customer-resolver.ts  # Cross-channel identity resolution
│       ├── errors.ts        # Standardized error responses
│       ├── logger.ts        # Structured logging
│       ├── pagination.ts    # Shared pagination helper
│       ├── rate-limit.ts    # Rate limiting
│       ├── security.ts      # XSS/CRLF protection, secret masking
│       ├── validations.ts   # Zod input schemas
│       ├── webhook-delivery.ts   # Retry logic + HMAC signatures
│       └── hooks/           # Theme hook
├── tests/                   # 228 tests (unit, API, security)
├── docker-compose.yml
├── Dockerfile               # Multi-stage, non-root, healthcheck
└── .env.example
```

---

## Documentation

Full documentation is available in the [Wiki](docs/wiki/Home.md):

- [Installation Guide](docs/wiki/Installation-Guide.md)
- [Setup Wizard](docs/wiki/Setup-Wizard.md)
- [Quick Start Tutorial](docs/wiki/Quick-Start-Tutorial.md)
- [API Reference](docs/wiki/API-Reference.md)
- [AI Tool System](docs/wiki/AI-Tool-System.md)
- [Architecture](docs/wiki/Architecture.md)

---

## Deployment

### Docker Compose (recommended for most users)

```bash
docker compose up -d
```

### Kubernetes (Helm)

```bash
helm install owly helm/owly \
  --set database.host=your-postgres-host \
  --set database.password=your-password \
  --set secrets.jwtSecret=$(openssl rand -hex 32) \
  --set secrets.openaiApiKey=sk-... \
  --set ingress.enabled=true \
  --set ingress.hosts[0].host=support.yourdomain.com
```

The Helm chart includes startup/liveness/readiness probes, horizontal pod autoscaling, Ingress with TLS, PersistentVolumeClaim for WhatsApp sessions, and init container for database migrations. See [`helm/owly/values.yaml`](helm/owly/values.yaml) for all options.

---

## Roadmap

- [x] Cross-channel customer identity resolution
- [x] Kubernetes Helm chart
- [x] OpenAPI 3.0 specification
- [x] Webhook delivery retry with HMAC signatures
- [x] Pagination on all list endpoints
- [x] Standardized error responses with request tracing
- [ ] Embeddable live chat widget for customer websites
- [ ] WebSocket real-time updates
- [ ] Vector embeddings for semantic knowledge search
- [ ] Role-based access control (RBAC)
- [ ] Telegram, Instagram, SMS channels
- [ ] Shopify / WooCommerce integration
- [ ] Mobile admin (PWA)
- [ ] Multi-tenant / white-label

---

## Contributing

Contributions are welcome! See the [Contributing Guide](docs/wiki/Contributing.md) for details.

```bash
# Fork, clone, and create a branch
git checkout -b feature/your-feature

# Make changes and commit
git commit -m 'feat: add your feature'

# Push and open a PR
git push origin feature/your-feature
```

---

## License

MIT License - see [LICENSE](LICENSE) for details.

---

<img src="public/owly.png" alt="Owly" width="48" height="48" /> 
 Owly -- AI Customer Support, Enterprise Grade 
 Built with Next.js 16, TypeScript, PostgreSQL, and OpenAI

owly

owly 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

owly

owly 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README