Update documentation for vBot-2.1

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 (FreePBX, 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) and receives results via webhooks.
 
 ## System Architecture
 
@@ -27,9 +27,8 @@ vBot is a distributed call analysis system where a central server ONLY handles A
 
 ### Customer Infrastructure (Remote)
 Each customer maintains their own complete system:
-- FreePBX server (includes Asterisk, web server, and database)
+- FreePBX server (includes Asterisk, Apache 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
@@ -56,7 +55,6 @@ Each customer maintains their own complete system:
 - 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
 
 ## Quick Start

SETUP_GUIDE.md

@@ -60,93 +60,41 @@ This guide provides detailed instructions for setting up both the central vBot s
 
 ## Customer Infrastructure Setup
 
-### 1. Asterisk Server Setup
+### 1. FreePBX Setup
 
-1. Install Asterisk:
-   ```bash
-   sudo apt update
-   sudo apt install asterisk
-   ```
-
-2. Configure dialplan:
-   ```ini
-   [from-internal]
-   exten => _X.,1,Answer()
-   same => n,Record(/tmp/calls/${UNIQUEID}.wav,0,0)
-   same => n,Set(CALL_ID=${UNIQUEID})
-   same => n,Set(CALLER=${CALLERID(num)})
-   same => n,Set(CALLED=${EXTEN})
-   same => n,AGI(agi://localhost:4573/process_call)
-   same => n,Hangup()
-   ```
-
-3. Configure AGI script:
-   ```bash
-   sudo nano /etc/asterisk/agi-bin/process_call
-   ```
-   ```bash
-   #!/bin/bash
-   CALL_ID=$1
-   CALLER=$2
-   CALLED=$3
-   
-   curl -X POST https://vbot-server.com/api/process-call \
-     -H "X-API-Key: your_api_key" \
-     -H "Content-Type: multipart/form-data" \
-     -F "file=@/tmp/calls/${CALL_ID}.wav" \
-     -H "caller_number=${CALLER}" \
-     -H "called_number=${CALLED}"
-   ```
-
-4. Set permissions:
-   ```bash
-   sudo chmod +x /etc/asterisk/agi-bin/process_call
-   sudo chown asterisk:asterisk /etc/asterisk/agi-bin/process_call
-   ```
-
-5. Restart Asterisk:
-   ```bash
-   sudo systemctl restart asterisk
-   ```
+1. Install FreePBX:
+   - Download FreePBX 16 or higher
+   - Follow the installation guide
+   - Complete the setup wizard
+   - Ensure all components are properly configured
 
-### 2. Web Server Setup
+2. Configure FreePBX:
+   - Enable call recording in FreePBX Admin
+   - Set up recording paths
+   - Configure recording formats
+   - Set up SSL certificates
 
-1. Install Apache:
+3. Install the customer webhook package:
    ```bash
-   sudo apt install apache2 php php-mysql
-   ```
-
-2. Configure virtual host:
-   ```apache
-   <VirtualHost *:80>
-       ServerName your-domain.com
-       DocumentRoot /var/www/html/vbot-webhook
-       
-       <Directory /var/www/html/vbot-webhook>
-           Options Indexes FollowSymLinks
-           AllowOverride All
-           Require all granted
-       </Directory>
-       
-       ErrorLog ${APACHE_LOG_DIR}/vbot-error.log
-       CustomLog ${APACHE_LOG_DIR}/vbot-access.log combined
-   </VirtualHost>
+   git clone https://huggingface.co/spaces/iajitpanday/vBot
+   cd vBot/customer_webhook
+   composer install
+   cp config/config.example.php config/config.php
    ```
 
-3. Enable SSL:
-   ```bash
-   sudo apt install certbot python3-certbot-apache
-   sudo certbot --apache -d your-domain.com
-   ```
+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
 
-### 3. Database Setup
+5. Set up FreePBX integration:
+   - Configure FreePBX to use the webhook endpoint
+   - Set up recording post-processing
+   - Configure SSL for secure communication
 
-1. Install MySQL:
-   ```bash
-   sudo apt install mysql-server
-   ```
+### 2. Database Setup
 
-2. Create database:
+1. Create database:
    ```sql
    CREATE DATABASE vbot_calls;
    USE vbot_calls;
@@ -165,22 +113,16 @@ This guide provides detailed instructions for setting up both the central vBot s
    );
    ```
 
-3. Create database user:
+2. Create database user:
    ```sql
    CREATE USER 'vbot_user'@'localhost' IDENTIFIED BY 'your_password';
    GRANT ALL PRIVILEGES ON vbot_calls.* TO 'vbot_user'@'localhost';
    FLUSH PRIVILEGES;
    ```
 
-### 4. Webhook Handler Setup
+### 3. Webhook Handler Setup
 
-1. Download webhook handler:
-   ```bash
-   git clone https://huggingface.co/spaces/iajitpanday/vBot/customer_webhook
-   sudo cp -r customer_webhook/* /var/www/html/vbot-webhook/
-   ```
-
-2. Configure webhook handler:
+1. Configure webhook handler:
    ```bash
    sudo cp /var/www/html/vbot-webhook/config/config.example.php /var/www/html/vbot-webhook/config/config.php
    sudo nano /var/www/html/vbot-webhook/config/config.php
@@ -198,13 +140,13 @@ This guide provides detailed instructions for setting up both the central vBot s
    ];
    ```
 
-3. Set permissions:
+2. Set permissions:
    ```bash
    sudo chown -R www-data:www-data /var/www/html/vbot-webhook
    sudo chmod -R 755 /var/www/html/vbot-webhook
    ```
 
-### 5. Testing Setup
+### 4. Testing Setup
 
 1. Test webhook endpoint:
    ```bash
@@ -256,7 +198,7 @@ This guide provides detailed instructions for setting up both the central vBot s
 
 1. Log Monitoring:
    ```bash
-   # Asterisk logs
+   # FreePBX logs
    tail -f /var/log/asterisk/messages
    
    # Webhook logs
@@ -303,7 +245,7 @@ This guide provides detailed instructions for setting up both the central vBot s
    cd /var/www/html/vbot-webhook
    git pull
    
-   # Update Asterisk
+   # Update FreePBX
    sudo apt update
    sudo apt upgrade
    ```
@@ -321,7 +263,7 @@ This guide provides detailed instructions for setting up both the central vBot s
    # Check webhook logs
    tail -f /var/log/apache2/vbot-error.log
    
-   # Check Asterisk CLI
+   # Check FreePBX CLI
    sudo asterisk -rx "core show version"
    
    # Test database connection
@@ -332,116 +274,4 @@ This guide provides detailed instructions for setting up both the central vBot s
    - Check documentation
    - Review logs
    - Contact support
-   - Submit issues 
-
-## Step 1: Deploy to Hugging Face Spaces
-1. Create a Hugging Face account if you don't have one
-2. Create a new Space
-3. Configure environment variables:
-   - `DATABASE_URL`: Your MySQL database connection string
-   - `SECRET_KEY`: A secure random string for JWT token generation
-   - `API_BASE_URL`: The base URL of your vBot API
-
-## 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/customer_webhook
-   composer install
-   cp config/config.example.php config/config.php
-   ```
-
-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
-
-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 
+   - Submit issues