Ctrl K
ring2all.com

Telephony Servers Module Documentation

Table of Contents

  1. Module Overview (Technical)
  2. Module Overview (Commercial/Business)
  3. Module Overview (End User/Administrator)
  4. Configuration Sections
  5. Settings Reference
  6. Common Scenarios & Examples
  7. Limitations & Important Notes
  8. Troubleshooting Tips
  9. Glossary

---

1. Module Overview (Technical)

What Are Telephony Servers?

Telephony Servers is a FreeSWITCH server management module that configures connections to one or more telephony servers. It supports SSH authentication (password or key-based) and periodic health monitoring.

Architecture

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│            Telephony Servers Architecture                      │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Ring2All Admin Panel                                           │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Telephony Servers Module                          │   │
│  │                                                          │   │
│  │  Server Entry:                                           │   │
│  │  ├─ Name: FS Node 01                                    │   │
│  │  ├─ Host: 192.168.1.100                                 │   │
│  │  ├─ SSH Port: 22                                        │   │
│  │  ├─ SSH User: root                                      │   │
│  │  ├─ Auth: SSH Key (auto-generated)                      │   │
│  │  ├─ Monitoring: Enabled                                 │   │
│  │  └─ Health Check: 30 seconds                            │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ SSH Connection                                         │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        FreeSWITCH Server                                 │   │
│  │                                                          │   │
│  │  ├─ Execute fs_cli commands                             │   │
│  │  ├─ Deploy configuration files                          │   │
│  │  ├─ Retrieve status information                         │   │
│  │  └─ Restart services                                    │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Health Monitoring                                      │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Server Status                                     │   │
│  │                                                          │   │
│  │  ├─ Online / Offline                                    │   │
│  │  ├─ FreeSWITCH version                                  │   │
│  │  ├─ Telephony status                                    │   │
│  │  └─ Last seen timestamp                                 │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Key Tables

TablePurpose
public.telephony_serversServer configurations

Key Files

FileDescription
modules/telephonyServers/Frontend module
---

2. Module Overview (Commercial/Business)

Business Value

Telephony Servers provides multi-server management:

Without Telephony ServersWith Telephony Servers
Single serverMultiple servers
Manual SSHAutomated connection
Password authKey-based security
No monitoringHealth checks

Use Cases

  1. Multi-Server Cluster

- Manage multiple FreeSWITCH nodes

- Distributed architecture

  1. Remote Servers

- Cloud-hosted telephony

- Geographically distributed

  1. Server Monitoring

- Uptime tracking

- Status dashboard

  1. Secure Access

- SSH key authentication

- Passwordless operation

Feature Highlights

FeatureBenefit
Multi-ServerManage cluster
SSH Key AuthSecure, automated
Auto Key InstallOne-click setup
Health ChecksMonitor uptime
Status DisplayOnline/Offline/Error
Quick ListFast server switching
---

3. Module Overview (End User/Administrator)

What Can You Do?

  • Add telephony servers
  • Configure SSH connection details
  • Generate and install SSH keys
  • Enable/disable monitoring
  • Set health check intervals
  • View server status
  • Check FreeSWITCH version

Telephony Servers Interface

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Telephony Servers                                  │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Manage FreeSWITCH servers and connections                     │
│                                                                 │
│  [+ Add Server]                                                 │
│                                                                 │
│  [🔍 Search servers...]                                         │
│                                                                 │
│  ┌───────────────────────────────────────────────────────────┐  │
│  │ Server Name   │ Host          │ Status  │ Version │ Mon  │  │
│  ├───────────────┼───────────────┼─────────┼─────────┼──────┤  │
│  │ FS Node 01    │ 192.168.1.100 │ ●Online │ 1.10.9  │ ✓    │  │
│  │ FS Node 02    │ 192.168.1.101 │ ●Online │ 1.10.9  │ ✓    │  │
│  │ Backup Server │ 10.0.0.50     │ ○Offline│ -       │ ✓    │  │
│  │ Dev Server    │ dev.local     │ ●Online │ 1.10.7  │ ☐    │  │
│  └───────────────────────────────────────────────────────────┘  │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Add/Edit Server

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Add Telephony Server                               │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  ▼ Basic Information                                            │
│                                                                 │
│  Server Name: [FS Node 01                    ]                 │
│    Friendly name for identifying this server                    │
│                                                                 │
│  Description: [Production telephony node     ]                 │
│    Optional description                                         │
│                                                                 │
│  Host (IP or domain): [192.168.1.100         ]                 │
│    Server IP address or DNS hostname                            │
│                                                                 │
│  SSH Port: [22                               ]                 │
│    Default port is 22                                           │
│                                                                 │
│  SSH Username: [root                         ]                 │
│    User account for SSH access                                  │
│                                                                 │
│  SSH Password: [••••••••                     ]                 │
│    Leave blank for key-based authentication                     │
│                                                                 │
│  ──────────────────────────────────────────────────────────────│
│                                                                 │
│  ▼ SSH Key Authentication                                       │
│                                                                 │
│  [🔑 Generate & install SSH key]                                │
│    Create and deploy a unique SSH key for this server          │
│                                                                 │
│  Status: SSH key installed on the server.                      │
│                                                                 │
│  ──────────────────────────────────────────────────────────────│
│                                                                 │
│  Enable Monitoring: ✓                                          │
│    Enable periodic health checks for this server               │
│                                                                 │
│  Health Check Interval: [30                  ] seconds         │
│    Time interval between monitoring checks                      │
│                                                                 │
│  [Save] [Cancel]                                                │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

SSH Key Generation

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              SSH Key Authentication                             │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  [🔑 Generate & install SSH key]                                │
│                                                                 │
│  Status: ✓ SSH key installed on the server.                   │
│                                                                 │
│  ────────────────────────────────────────────────────────────── │
│                                                                 │
│  SSH key installed on the server                               │
│  The SSH key is ready for secure authentication.                │
│                                                                 │
│  Test the connection:                                           │
│  ssh root@192.168.1.100                                        │
│                                                                 │
│  No additional steps are required.                              │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Quick Tips

TIP
SSH Keys: Use key-based auth for automated operations.
TIP
Monitoring: Enable to track server uptime.
NOTE
Local Server: Local servers cannot be deleted.

---

4. Configuration Sections

Basic Information

FieldDescription
Server NameIdentifier (e.g., "FS Node 01")
DescriptionPurpose notes
HostIP or hostname
SSH PortSSH port (default 22)
SSH UsernameLogin user
SSH PasswordOptional password

SSH Key Authentication

FieldDescription
Generate & InstallCreate and deploy SSH key
StatusKey installation status

Monitoring

FieldDescription
Enable MonitoringPeriodic health checks
Health Check IntervalSeconds between checks
---

5. Settings Reference

Server Status Values

StatusIconDescription
Online● GreenServer responding
Offline○ GrayNot reachable
Error● RedConnection error
Unknown○ GrayNot checked

SSH Authentication Methods

MethodUse Case
PasswordInitial setup
SSH KeyProduction (recommended)

Health Check Intervals

IntervalUse Case
30 secHigh availability
60 secStandard monitoring
300 secLow priority servers
---

6. Common Scenarios & Examples

Scenario 1: Add Production Server

  1. Click "Add Server"
  2. Name = "FS Prod 01"
  3. Host = production server IP
  4. SSH Port = 22
  5. SSH Username = root
  6. Click "Generate & install SSH key"
  7. Enable Monitoring
  8. Health Check = 30 seconds
  9. Save

Scenario 2: Manual SSH Key

  1. Add server with password first
  2. Generate SSH key
  3. If auto-install fails, copy key
  4. Manually add to server's authorized_keys
  5. Clear password field
  6. Save

Scenario 3: Disable Monitoring

  1. Edit server
  2. Uncheck "Enable Monitoring"
  3. Save
  4. Server won't be health-checked

Scenario 4: Change Health Interval

  1. Edit server
  2. Set Health Check Interval = 60
  3. Save
  4. Checks now every 60 seconds

---

7. Limitations & Important Notes

Technical Notes

NOTE
Network Access: Server must be reachable from admin panel.
NOTE
SSH Access: User needs appropriate permissions.
WARNING
Local Server: Cannot be deleted (system server).

Best Practices

  1. Use SSH Keys: More secure than passwords
  2. Enable Monitoring: Track uptime
  3. Descriptive Names: "FS-Prod-US-East-01"
  4. Dedicated User: Use non-root when possible
  5. Firewall Rules: Allow SSH from admin panel

SSH Key Benefits

BenefitDescription
SecurityNo password exposure
AutomationPasswordless scripts
RotationEasy key replacement
AuditTrack key usage
---

8. Troubleshooting Tips

Common Issues

SymptomPossible CauseSolution
Offline statusServer downCheck server
SSH connection failedWrong credentialsVerify user/password
Key install failedSSH blockedCheck firewall
Can't deleteLocal serverLocal cannot be deleted

Test SSH Connection

Bash
# Test SSH manually
ssh -p 22 root@192.168.1.100

# Test with verbose output
ssh -v root@192.168.1.100

# Test key authentication
ssh -i /path/to/key root@192.168.1.100

Check Server Status

Sql
SELECT 
  name,
  host,
  ssh_port,
  status,
  last_seen,
  monitoring_enabled
FROM public.telephony_servers
ORDER BY name;

FreeSWITCH Status

Bash
# Check FreeSWITCH is running
systemctl status freeswitch

# Check version
fs_cli -x "version"

---

9. Glossary

TermDefinition
Telephony ServerFreeSWITCH host
SSHSecure Shell protocol
SSH KeyPublic/private key pair
Health CheckPeriodic status verification
ClusterMultiple connected servers
fs_cliFreeSWITCH command line
---

Lua Script Status ℹ️

Infrastructure Module

ComponentStatus
Telephony Serversℹ️ Server management - no Lua handler required
Telephony Servers is an infrastructure management module. It configures connections to FreeSWITCH servers. No Lua handlers are used - SSH connectivity is handled by the backend service.

---

Documentation last updated: January 2026
AI Assistant

👋 Hello! I'm your Ring2All documentation assistant. I can help you find information about configuring and using the Ring2All PBX platform.

How can I help you today?