Update documentation for FreePBX integration

README.md

@@ -11,7 +11,7 @@ pinned: false
 
 # vBot - Intelligent Call Analysis System
 
-vBot is a distributed call analysis system where a central server ONLY handles AI-powered transcription and analysis, while each customer maintains their own complete infrastructure (Asterisk, database, web server) and receives results via webhooks.
+vBot is a distributed call analysis system where a central server ONLY handles AI-powered transcription and analysis, while each customer maintains their own complete infrastructure (FreePBX, database, web server) and receives results via webhooks.
 
 ## System Architecture
 
@@ -27,9 +27,9 @@ vBot is a distributed call analysis system where a central server ONLY handles A
 
 ### Customer Infrastructure (Remote)
 Each customer maintains their own complete system:
-- Asterisk PBX server for call handling
-- MySQL database for storing call records
-- Web server (Apache/Nginx) for webhook handling
+- FreePBX server (includes Asterisk, web server, and database)
+- MySQL database (included with FreePBX)
+- Web server (Apache included with FreePBX)
 - SSL certificate for secure webhooks
 - Complete control over their data and infrastructure
 - Full ownership of their call recordings
@@ -43,20 +43,21 @@ Each customer maintains their own complete system:
 - Sentiment analysis and keyword extraction
 - Modern admin interface for customer management
 - Webhook-based result delivery
+- Seamless FreePBX integration
 
 ## System Requirements
 
 ### Central Server (vBot)
 - Python 3.8 or higher
-- Hugging Face Space (for deployment)
-- No database required (only manages customer accounts)
+- MySQL 5.7 or higher
+- Hugging Face Space deployment
 
 ### Customer Infrastructure
-- Asterisk PBX server
-- Web server (Apache/Nginx)
+- FreePBX 16 or higher
 - PHP 7.4 or higher
-- MySQL 5.7 or higher
-- SSL certificate (for secure webhooks)
+- MySQL 5.7 or higher (included with FreePBX)
+- Apache web server (included with FreePBX)
+- SSL certificate for secure webhooks
 
 ## Quick Start
 
@@ -72,23 +73,34 @@ Each customer maintains their own complete system:
    - `API_BASE_URL`: The base URL of your vBot API
 
 ### Customer Setup
-1. Clone the repository:
+1. Install FreePBX:
+   - Download and install FreePBX 16 or higher
+   - Complete the FreePBX setup wizard
+   - Ensure the system is properly configured
+
+2. Clone the repository:
    ```bash
    git clone https://huggingface.co/spaces/iajitpanday/vBot
    cd vBot
    ```
 
-2. Install the customer webhook package:
+3. Install the customer webhook package:
    ```bash
    cd customer_webhook
    composer install
    cp config/config.example.php config/config.php
    ```
 
-3. Configure the webhook package:
-   - Update `config/config.php` with your database details
+4. Configure the webhook package:
+   - Update `config/config.php` with your FreePBX database details
    - Set the vBot API URL and your API key
-   - Configure your web server (Apache/Nginx) to serve the webhook endpoint
+   - Configure FreePBX to use the webhook endpoint
+
+5. Configure FreePBX:
+   - Enable call recording in FreePBX
+   - Set up the recording path
+   - Configure the webhook endpoint in FreePBX
+   - Set up SSL for secure webhook communication
 
 ## Admin Setup (Central Server)
 

SETUP_GUIDE.md

@@ -342,21 +342,106 @@ This guide provides detailed instructions for setting up both the central vBot s
    - `SECRET_KEY`: A secure random string for JWT token generation
    - `API_BASE_URL`: The base URL of your vBot API
 
-## Step 2: Customer Setup
-1. Clone the vBot repository:
+## Step 2: Customer Setup (FreePBX)
+1. Install FreePBX:
+   - Download FreePBX 16 or higher
+   - Follow the installation guide
+   - Complete the setup wizard
+   - Ensure all components are properly configured
+
+2. Configure FreePBX:
+   - Enable call recording in FreePBX Admin
+   - Set up recording paths
+   - Configure recording formats
+   - Set up SSL certificates
+
+3. Install the customer webhook package:
    ```bash
    git clone https://huggingface.co/spaces/iajitpanday/vBot
-   cd vBot
-   ```
-
-2. Set up the customer webhook package:
-   ```bash
-   cd customer_webhook
+   cd vBot/customer_webhook
    composer install
    cp config/config.example.php config/config.php
    ```
 
-3. Configure the webhook package:
-   - Update `config/config.php` with your database details
+4. Configure the webhook package:
+   - Update `config/config.php` with FreePBX database details
    - Set the vBot API URL and your API key
-   - Configure your web server (Apache/Nginx) to serve the webhook endpoint 
+   - Configure the webhook endpoint
+
+5. Set up FreePBX integration:
+   - Configure FreePBX to use the webhook endpoint
+   - Set up recording post-processing
+   - Configure SSL for secure communication
+
+## Step 3: Testing
+1. Test FreePBX recording:
+   - Make a test call
+   - Verify recording is created
+   - Check recording quality
+
+2. Test webhook integration:
+   - Monitor webhook delivery
+   - Verify data format
+   - Check error handling
+
+3. Test API connection:
+   - Verify API key authentication
+   - Test call processing
+   - Check result delivery
+
+## Step 4: Production Deployment
+1. Security:
+   - Enable SSL for all communications
+   - Set up proper firewall rules
+   - Configure secure API keys
+   - Implement rate limiting
+
+2. Performance:
+   - Optimize FreePBX recording settings
+   - Configure proper storage
+   - Set up monitoring
+   - Implement backup strategy
+
+3. Monitoring:
+   - Set up FreePBX monitoring
+   - Monitor webhook delivery
+   - Track API usage
+   - Monitor system resources
+
+## Step 5: Maintenance
+1. Regular Tasks:
+   - Monitor system logs
+   - Check recording storage
+   - Verify webhook delivery
+   - Update security certificates
+
+2. Backup:
+   - Backup FreePBX configuration
+   - Backup recordings
+   - Backup webhook configuration
+   - Test restore procedures
+
+3. Updates:
+   - Keep FreePBX updated
+   - Update webhook package
+   - Update SSL certificates
+   - Test updates in staging
+
+## Troubleshooting
+1. Common Issues:
+   - Recording not created
+   - Webhook delivery failed
+   - API connection issues
+   - Performance problems
+
+2. Solutions:
+   - Check FreePBX logs
+   - Verify webhook configuration
+   - Test API connection
+   - Monitor system resources
+
+3. Support:
+   - Contact support
+   - Submit issues
+   - Check documentation
+   - Join community forums 

USER_MANUAL.md

@@ -1,59 +1,142 @@
 # vBot User Manual
 
 ## Introduction
-
-Welcome to the vBot User Manual. This guide will help you understand and use the vBot system effectively. vBot is a distributed call analysis system where the central server handles transcription and analysis, while you maintain your own infrastructure and receive results via webhooks.
+vBot is an intelligent call analysis system that provides real-time transcription, summarization, and sentiment analysis for phone calls. This manual will guide you through setting up and using the system with FreePBX.
 
 ## Getting Started
 
 ### Installation
-1. Clone the main vBot repository:
-   ```bash
-   git clone https://huggingface.co/spaces/iajitpanday/vBot
-   cd vBot
-   ```
+1. Install FreePBX:
+   - Download and install FreePBX 16 or higher
+   - Complete the FreePBX setup wizard
+   - Ensure the system is properly configured
 
 2. Install the customer webhook package:
    ```bash
-   cd customer_webhook
+   git clone https://huggingface.co/spaces/iajitpanday/vBot
+   cd vBot/customer_webhook
    composer install
-   ```
-
-3. Copy the example configuration:
-   ```bash
    cp config/config.example.php config/config.php
    ```
 
-4. Edit the configuration file with your database and vBot API details.
+3. Configure FreePBX:
+   - Enable call recording in FreePBX Admin
+   - Set up recording paths
+   - Configure recording formats
+   - Set up SSL certificates
 
-### 1. System Requirements
+4. Configure the webhook package:
+   - Update `config/config.php` with FreePBX database details
+   - Set the vBot API URL and your API key
+   - Configure the webhook endpoint
 
-Your infrastructure needs:
-- Asterisk PBX server
-- Web server (Apache/Nginx)
-- MySQL database
+### 1. System Requirements
+- FreePBX 16 or higher
+- PHP 7.4 or higher
+- MySQL 5.7 or higher (included with FreePBX)
+- Apache web server (included with FreePBX)
 - SSL certificate for secure webhooks
 
-### 2. Initial Setup
-
-1. Contact vBot support to create your account
-2. Receive your API key
-3. Set up your infrastructure:
-   - Configure Asterisk
-   - Set up web server
-   - Create database
-   - Deploy webhook handler
-
-### 3. Accessing Your Account
-
-1. Log in to the vBot admin interface:
-   - URL: `https://vbot-server.com/admin`
-   - Use your credentials
-
-2. View your account details:
-   - Company information
-   - API key
-   - Usage statistics
+### 2. FreePBX Configuration
+1. Recording Settings:
+   - Enable call recording
+   - Set recording format (WAV recommended)
+   - Configure recording paths
+   - Set up recording retention
+
+2. Webhook Integration:
+   - Configure webhook endpoint
+   - Set up SSL for secure communication
+   - Configure post-processing
+   - Test webhook delivery
+
+3. Security Settings:
+   - Enable SSL
+   - Configure firewall rules
+   - Set up API key authentication
+   - Implement rate limiting
+
+### 3. Using the System
+1. Making Calls:
+   - Use FreePBX to make/receive calls
+   - Recordings are automatically created
+   - Results are sent via webhook
+
+2. Viewing Results:
+   - Access results through webhook
+   - View transcriptions
+   - Check sentiment analysis
+   - Review call summaries
+
+3. Managing Recordings:
+   - Access through FreePBX interface
+   - Download recordings
+   - Manage storage
+   - Set retention policies
+
+### 4. Troubleshooting
+1. Common Issues:
+   - Recording not created
+   - Webhook delivery failed
+   - API connection issues
+   - Performance problems
+
+2. Solutions:
+   - Check FreePBX logs
+   - Verify webhook configuration
+   - Test API connection
+   - Monitor system resources
+
+3. Support:
+   - Contact support
+   - Submit issues
+   - Check documentation
+   - Join community forums
+
+### 5. Best Practices
+1. Security:
+   - Keep FreePBX updated
+   - Use strong passwords
+   - Enable SSL
+   - Regular backups
+
+2. Performance:
+   - Monitor system resources
+   - Optimize recording settings
+   - Manage storage
+   - Regular maintenance
+
+3. Maintenance:
+   - Regular updates
+   - Monitor logs
+   - Check storage
+   - Backup configuration
+
+### 6. Updates and Maintenance
+1. System Updates:
+   - Keep FreePBX updated
+   - Update webhook package
+   - Update SSL certificates
+   - Test updates in staging
+
+2. Regular Tasks:
+   - Monitor system logs
+   - Check recording storage
+   - Verify webhook delivery
+   - Update security certificates
+
+3. Backup:
+   - Backup FreePBX configuration
+   - Backup recordings
+   - Backup webhook configuration
+   - Test restore procedures
+
+### 7. Support
+For additional support:
+- Email: support@example.com
+- Phone: +1-XXX-XXX-XXXX
+- Documentation: https://docs.example.com
+- Community: https://community.example.com
 
 ## Admin Interface