Usage Requirements
PBX OS
SNG7 with PBX version 15+.
PBX Modules
Please find below the module list to fulfill the dependency requirement for Sangoma Phone Desktop client.
...
| Note |
|---|
There are multiple commercial and open source module dependencies required to support Sangoma soft clients. PBX deployments that have the paid version of Endpoint Manager or Phone Apps licensed for multiple years may require that the module maintenance to be current to ensure that they have the minimum version to support the Sangoma Connect module. |
Asterisk
16 latest and up (18+ recommended)
Licensing
Your system will need to have some Sangoma Connect user licenses. The Admin→SangomaConnect page will list the current number of licensed users on the PBX.
...
Modules
While installing or updating the required sangomartapi module, the following required modules should also get updated automatically. Just as a reference, these are the modules that will also need to be up to date, and enabled:
...
| Code Block |
|---|
# fwconsole ma downloadinstall sangomartapi |
RPMS
| Panel | ||
|---|---|---|
| ||
A quick way of installing the PJSIPCallIDToChannel RPM is to use the built-in asterisk-version-switch updater. By running 'asterisk-version-switch' and selecting any asterisk version (+16 is recommended) all the required RPMs will be downloaded and installed along with the new Asterisk version. Make sure to run 'yum update' first, to have all the packages up to date. WARNING! THIS PROCESS WILL DROP ACTIVE CALLS. CONSIDER TAKING AROUND 10 MINUTES FOR THIS PROCESS TO COMPLETE. |
...
| Code Block |
|---|
# asterisk -rx "core restart now" |
Ports
Users will need to be able to access these system ports, which might require port forwarding for remote users.
...
Firewall Settings
For some environments where Sangoma Phone will be used from remote networks, the zone accessibility settings must be set properly for the Sangoma Phone Desktop Client Service port.
These settings are found in Connectivity->Firewall->Services→Extra Services. By default, the service is open only to the Local zone, enable for other zones only as needed.
Asterisk SIP Settings
Select a TLS certificate in Settings→Asterisk SIP Settings→SIP Settings[chan_pjsip].
...
After those are enabled, set the Default TLS Port Assignment to PjSip, from the General SIP Settings tab
...
Advanced Settings
After the above Asterisk SIP Settings are applied, Enable the mini-HTTP Server, with TLS, and Force the WebSocket Mode to PJSIP. These options are found in Settings→Advanced Settings.
...
Set the Conference Room App to app_confbridge. Sangoma Phone Desktop Client conference features will not work unless the Conference Room App set is ConfBridge(app_confbridge).
...
SangomaConnect Settings
Set the PBX's host address in Admin→SangomaConnect→Settings
To avoid potential issues, the following is advised:
Client users will use this same Address value, along with the PBX's "Sangoma Phone Desktop Client Service" Secure Port when logging in. With that in mind, this Address will need to be something that is resolvable from the client user's desktop.
A proper Fully Qualified Domain Name is recommended
A Secure Port must be enabled for "Sangoma Phone Desktop Client Service" in Admin→System Admin→Port Management
This address should also match what is used as the PBX's HTTPS SSL cert's Common Name
In most cases, this address should be what is found in Admin→System Admin→Hostname
While an FQDN and valid SSL certificate is recommended, an IP address can be set here as long as a self-signed certificate with the IP address as its common name is used during the HTTPS setup when enabling Secure Ports in Port Management.
Generating a self-signed certificate with an IP for its common name can be done through Admin→Certificate Management
To do this, you will likely need to remove all existing Self-signed certificates by clicking the Delete Self-Signed CA button. This is because a typical install will have added a Default Self-Signed certificate which is based on a local hostname. Adding new self-signed certs while that exists will not work as expected. After deleting the default cert, choose the option to Generate Self-Signed Certificate, and set the pbx ip address as the hostname.
This method can lead to issues if not all client users will be logging in with the same IP address set here. For example, some situations might have users logging in using the PBX's external IP vs internal IP.
User Setup
SangomaConnect Settings
Each Sangoma Phone user will need to be based on an existing PJSip extension.
In User Manager, the Sangoma Phone users will need to have "Enable Sangoma Phone Login" option enabled in the SangomaConnect tab of their user settings.
Language Settings
The desktop client's Login screen will always be in English.
After logging in successfully, the client will be translated if the User's Language Setting matches a language supported by the client. Otherwise, it will default to English.
The User's Language Setting can be set through Admin->User Management, by editing a User or Group.
The current list of supported languages include:
English (United States)
English (United Kingdom)
French (France)
German (Germany)
Italian (Italy)
Spanish (Spain)
...