The following content only applies to FreePBX and PBXact platforms
Softphones - Sangoma Desktop phone Setup Wizard
Overview
The Sangoma Desktop Phone Setup Wizard is a tool designed for system administrators to configure necessary system prerequisites and enable Sangoma Desktop for multiple users quickly and efficiently. This step-by-step wizard simplifies the process, reducing manual efforts and ensuring that users are onboarded with minimal time and effort.
By following the outlined steps, administrators can efficiently configure the necessary system settings and activate user access to the desktop softphone.
Features
System Prerequisites Validation
Ensures that all necessary services and configurations are in place.
Validates the system environment before enabling users.
Provides clear status updates for each prerequisite.
User Enablement Process
Displays a list of available users to enable the sangoma Desktop.
Supports bulk user selection for faster enablement.
Allow administrator to select the desired user and enable.
Streamlined Workflow
Step-by-step guided setup for ease of use.
Reduces setup time for large organizations.
Ensures proper configuration before user activation.
Benefits
Time Efficiency: Enables multiple users at once, reducing administrative workload.
Error Reduction: Ensures all system prerequisites are met before user activation.
User-Friendly Interface: Simple and intuitive design for smooth navigation.
Scalability: Supports organizations with a large number of users.
PBX Modules
Below are the minimum required module versions to meet the dependency requirements for the Desktop Phone Setup Wizard.:
sangomaconnect 15.0.63 , 16.0.51 and 17.0.3.6.
sangomartapi 15.0.60.3 , 16.0.54.5 and 17.0.9.5.
userman 15.0.69.24 , 16.0.44.18 and 17.0.6.33.
Step-by-Step Guide
Navigate to Admin->Sangoma Connect, click on the Desktop Phone Setup Wizard to start the wizard.
Step 1: System Prerequisites Validation.
Before enabling users, the wizard verifies system requirements to ensure a smooth experience.
We can also utilize the same pre-requisites step to confirm if existing system is also properly configured for the desktop client.
The validation process checks:
HTTPS port configuration for RestApps.
Sangoma Phone Desktop Client Service port enablement.
Activation of Sangoma Realtime API module.
Installation of required DEB/RPM packages.
TLS configuration for Asterisk mini-HTTP server.
WebSocket settings for Asterisk mini-HTTP server.
The enablement of required WebSocket services.
The activation of ConfBridge for conferencing.
Asterisk REST Interface availability.
Proper HTTP prefix settings.
If any prerequisites fail, the user needs to press the Gear button to resolve the issue.
If all checks pass, the administrator can proceed to the next step by pressing the Next button for Step 2.
Step 2: Enable Users
Once system prerequisites are validated:
A list of available users with “valid email address” is displayed, showing their username, display name, email address, and default extension.
The administrator can select multiple users by checking the boxes next to their names.
Once users are selected, clicking the Enable button activates Sangoma Desktop for them.
The Wizard enables the Sangoma desktop and confirms the enablement.
Press the Continue button and then click the Finish button to complete the wizard.
Press the Apply Config button to apply all the changes.