Ring2All Documentation Portal

Comprehensive Documentation for the Ring2All Enterprise PBX Platform

Live Documentation •

Quick Start •

Table of Contents

---

📖 About

This repository contains the complete documentation for the Ring2All Softswitch Platform - a modern, enterprise-grade IP-PBX system built on FreeSWITCH with a powerful Node.js/React administration interface.

The documentation portal is built with PHP and features:

• 🎨 Modern glassmorphism UI design
• 🌙 Dark/Light theme support
• 🔍 Full-text search
• 🤖 AI-powered assistant
• 📱 Fully responsive design

---

🚀 Quick Start

# Clone the repository
git clone https://github.com/rodrigocuadra/ring2all.git

# Navigate to the directory
cd docs-portal

# Start with PHP built-in server (development)
php -S localhost:8000

# Or deploy to Apache/Nginx

---

📚 Table of Contents

Introduction

• Getting Started
• Navigation
• Concepts
• Dashboard

Installation

• Overview
• Single Server
• Distributed Overview
• PostgreSQL Cluster
• File Server Cluster
• Admin Server
• Portal Server
• Switchboard Server
• Telephony Server
• HAProxy Setup

---

PBX

Extensions

• Extensions
• Hot Desking
• Bulk Modification
• Extension Status

Applications

• Conferences
• Direct Dial
• Direct Route
• Paging & Intercom
• Custom Applications
• Feature Codes
• Pickup Groups
• Parking Lots
• Speed Dialing
• Voicemail Broadcast
• Call Back
• DISA
• PIN List
• Dynamic Destination

Class of Service

• Class Management
• Feature Categories
• Dial Restriction Rules
• Customer Codes
• Authorization Codes
• Route Selections

Call Center

• Ring Groups
• Agents
• Queues
• Priority Routing
• Queue VIP
• Callback Profiles

Calls Routing

• Gateways
• Outbound Routes
• Inbound Routes
• Dynamic Routing

Incoming Call Tools

• IVR
• Time Groups
• Time Conditions
• Announcements
• Languages
• Call Flows
• CID Modifiers
• Caller ID Lookup
• Authentication Codes

SMS Messaging

• Providers
• Numbers
• Routes
• Messages
• Settings
• Opt-outs

Tools

• PBX CLI
• Blacklist
• Log File Viewer
• Weak Password
• Phonebooks

Emergency Calls

• Emergency Numbers
• Dispatchable Locations

Virtual Faxes

• Fax Devices
• Fax Sending
• Fax Viewer

---

Reports

CDR Reports

• CDR Filters
• Call Detail Records

PBX Reports

• Active Calls
• SIP Endpoints

IVR Reports

• IVR Statistics

Call Center Reports

• Queue Callback Report

System Reports

• Audit Logs
• Change History
• Security Logs
• User Activity

---

Settings

Technology Settings

• SIP Profiles
• Device Profiles
• Gateway Profiles
• Dial Profiles

PBX Settings

• General Settings
• System Variables
• Conference Profiles
• Queue Profiles
• ESL Users
• Log Settings
• CDR Configuration

Voice Prompts

• PBX Voice Guide
• Music on Hold
• Recording Management

Provisioning

• Vendors
• Device Models
• Server Settings
• Security Settings
• Templates
• Devices

Integrations

• CRM Integrations

---

Admin

Administration

• Users
• Role Profiles
• Log Profiles
• Application Keys

System Settings

• Telephony Servers
• System Misc
• Branding
• Email Settings
• Email Templates
• Certificates
• HTTP/HTTPS Server

Multi-Tenant

• Tenants
• Domains

Firewall

• Firewall Settings
• Access Control
• Services
• Rules
• Geo Firewall

Network

• Network Configuration
• OpenVPN Server
• OpenVPN Client

Maintenance

• Backup & Restore
• Cron Profiles
• System Cleanup
• Custom Tasks

AI Integration

• Providers
• AI Profiles
• AI Agents
• AI Agent Call History

---

Apps

User Portal

• Overview
• Dashboard
• Settings

Switchboard

• Overview
• Console

---

🏗️ Project Structure

docs-portal/
├── assets/
│   ├── css/           # Stylesheets
│   ├── js/            # JavaScript
│   └── images/        # Images and icons
├── content/           # Markdown documentation
│   ├── introduction/
│   ├── installation/
│   ├── pbx/
│   ├── reports/
│   ├── settings/
│   ├── admin/
│   └── apps/
├── includes/          # PHP includes
│   ├── functions.php
│   ├── header.php
│   ├── sidebar.php
│   └── markdown.php
├── screenshots/       # Module screenshots
├── config.php         # Configuration
├── index.php          # Entry point
├── menu.php           # Navigation structure
└── README.md          # This file

---

🛠️ Technology Stack

📄 License

Copyright © 2024 Ring2All LLC. All rights reserved.

---

🤝 Contributing

Contributions are welcome! Please read our contributing guidelines before submitting a pull request.

---

Made with ❤️ by the Ring2All Team