Add comprehensive user manual

USER_MANUAL.md

@@ -0,0 +1,224 @@
+# vBot User Manual
+
+## Table of Contents
+1. [Overview](#overview)
+2. [System Requirements](#system-requirements)
+3. [Installation](#installation)
+4. [Configuration](#configuration)
+5. [Usage](#usage)
+6. [API Reference](#api-reference)
+7. [Troubleshooting](#troubleshooting)
+
+## Overview
+vBot is a multi-tenant system that provides AI-powered call analysis for Asterisk PBX systems. It processes phone conversations to provide transcription, summarization, and sentiment analysis using Hugging Face models.
+
+### Key Features
+- Multi-tenant support with secure API keys
+- Real-time call processing
+- Speech-to-text transcription
+- Call summarization
+- Sentiment analysis
+- Secure admin dashboard
+- RESTful API
+
+## System Requirements
+
+### Server Requirements
+- Python 3.8 or higher
+- MySQL 5.7 or higher
+- 4GB RAM minimum
+- 20GB storage minimum
+- CUDA-capable GPU (recommended for faster processing)
+
+### Client Requirements
+- Asterisk PBX system
+- Internet connectivity
+- curl command-line tool
+
+## Installation
+
+### 1. Deploy to Hugging Face Spaces
+1. Visit https://huggingface.co/spaces/iajitpanday/vBot
+2. Click "Use this Space"
+3. Choose your deployment settings
+4. Wait for the deployment to complete
+
+### 2. Configure Environment Variables
+In your Hugging Face Space settings, add the following environment variables:
+```bash
+JWT_SECRET=your-secure-secret-key
+ADMIN_USERNAME=your-admin-username
+ADMIN_PASSWORD=your-secure-password
+DATABASE_URL=mysql+pymysql://username:password@host:port/database
+```
+
+### 3. Database Setup
+1. Create a MySQL database
+2. The application will automatically create required tables on first run
+
+## Configuration
+
+### 1. Admin Setup
+1. Log in to the admin dashboard using your credentials
+2. Navigate to the Customers section
+3. Create new customers by providing:
+   - Company name
+   - Contact person name
+   - Email address
+4. Save the generated API key for each customer
+
+### 2. Asterisk Integration
+1. Copy the sample dialplan configuration:
+```ini
+[from-internal]
+exten => _X.,1,Answer()
+same => n,Set(CALLERID=${CALLERID(num)})
+same => n,Set(CALLED=${EXTEN})
+same => n,Record(/tmp/call-${UNIQUEID}.wav,0,30)
+same => n,System(curl -X POST "https://your-huggingface-space-url/api/v1/process-call" \
+    -H "api-key: YOUR_API_KEY" \
+    -H "caller-number: ${CALLERID}" \
+    -H "called-number: ${CALLED}" \
+    -F "file=@/tmp/call-${UNIQUEID}.wav")
+same => n,System(rm /tmp/call-${UNIQUEID}.wav)
+same => n,Dial(SIP/${EXTEN})
+same => n,Hangup()
+```
+
+2. Replace placeholders:
+   - `YOUR_API_KEY` with the customer's API key
+   - `your-huggingface-space-url` with your actual Space URL
+
+3. Add the dialplan to your Asterisk configuration:
+   - Copy to `/etc/asterisk/dialplan/`
+   - Include in `extensions.conf`
+   - Reload Asterisk dialplan
+
+## Usage
+
+### 1. Admin Dashboard
+1. Access the admin dashboard at `https://your-space-url/admin`
+2. Log in with admin credentials
+3. Manage customers and view call records
+
+### 2. Customer Integration
+1. Provide customers with their API key
+2. Share the Asterisk dialplan configuration
+3. Guide them through Asterisk integration
+
+### 3. Call Processing
+The system automatically:
+1. Records incoming calls
+2. Sends audio to the processing server
+3. Performs AI analysis
+4. Stores results in the database
+5. Cleans up temporary files
+
+## API Reference
+
+### Authentication
+- Admin: JWT token authentication
+- Customers: API key in header
+
+### Endpoints
+
+#### Admin Endpoints
+```
+POST /api/v1/token
+- Login to get admin token
+
+POST /api/v1/customers/
+- Create new customer
+- Requires admin token
+
+GET /api/v1/customers/
+- List all customers
+- Requires admin token
+
+GET /api/v1/customers/{customer_id}
+- Get customer details
+- Requires admin token
+
+DELETE /api/v1/customers/{customer_id}
+- Delete customer
+- Requires admin token
+```
+
+#### Customer Endpoints
+```
+POST /api/v1/process-call
+- Process call recording
+- Requires customer API key
+- Headers:
+  - api-key: Customer's API key
+  - caller-number: Caller's phone number
+  - called-number: Called number
+
+GET /api/v1/calls/{customer_id}
+- List customer's calls
+- Requires admin token
+```
+
+## Troubleshooting
+
+### Common Issues
+
+1. **API Key Invalid**
+   - Verify API key is correct
+   - Check if customer is active
+   - Ensure proper header format
+
+2. **Call Processing Failed**
+   - Check audio file format (WAV)
+   - Verify file size limits
+   - Check server logs
+
+3. **Database Connection Issues**
+   - Verify DATABASE_URL
+   - Check database credentials
+   - Ensure database is running
+
+4. **Asterisk Integration Problems**
+   - Verify dialplan syntax
+   - Check file permissions
+   - Test curl command manually
+
+### Support
+For additional support:
+1. Check the logs in your Hugging Face Space
+2. Contact system administrator
+3. Review error messages in Asterisk logs
+
+## Security Considerations
+
+1. **API Keys**
+   - Keep API keys secure
+   - Rotate keys periodically
+   - Use HTTPS only
+
+2. **Admin Access**
+   - Use strong passwords
+   - Enable 2FA if available
+   - Monitor access logs
+
+3. **Data Protection**
+   - Regular backups
+   - Encryption at rest
+   - Secure file handling
+
+## Maintenance
+
+1. **Regular Tasks**
+   - Monitor system resources
+   - Check error logs
+   - Update dependencies
+
+2. **Backup Procedures**
+   - Database backups
+   - Configuration backups
+   - Recovery testing
+
+3. **Updates**
+   - Monitor for security updates
+   - Test updates in staging
+   - Plan maintenance windows