Desktop Client Module Installation

Version 12.1 by michelk on 2021/09/09 18:01

For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.

Overview

This document covers how to install the optional Desktop Client Module, on an existing iSymphony server installation. If you have not yet installed the iSymphony server see Getting Started.

The Desktop Client Module allows users to download and install the Desktop Client Application on their machines. The Desktop Client Application allows users to utilize the iSymphony client interface from within a native application that runs on the user's machine. This allows iSymphony to act as a native application, with its own window and shortcuts. The Desktop Client Application also allows for functionality like Global Hot Key focusing and application based CRM popups.

The Desktop Client Module requires an iSymphony Server version of 3.2.1 or higher.

The Desktop Client Module 2.0.0 requires an iSymphony Server version of 3.4.1 or higher.

Due to the size of the Desktop Client Module, it is provided as a separate download from the main iSymphony Server.

On this page:

The [toc] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

1. Download The Desktop Client Module

The desktop client module downloads can be found in the Downloads Archive. You will want to download the Desktop Client Module package to the server that is running the iSymphony server.

2. Extract The Desktop Client Module

Run the following command to extract the module to the iSymphony Server installation. You need to be in the same directory as the downloaded Desktop Client Module package when running this command.

tar -zxf isymphony_desktop_<version>.tar.gz -C /opt/isymphony3/server/modules

3. Set The File Ownership Of The Desktop Module

The file ownership of the desktop module must match that of the rest of the iSymphony Server installation.

Checking File Ownership Of The iSymphony Server Installation

To check the file ownership of the iSymphony Server installation you can run the following command, on the server command line:

ls -la /opt

The user that owns the iSymphony server installation will be the user that owns the isymphony3 directory in the opt directory.

Notes on FreePBX & AsteriskNow

If your iSymphony server was installed from one of the following sources, the iSymphony server installation will be owned by the asterisk user.

Came pre-installed with the FreePBX or AsteriskNow distros.
Installed via the FreePBX Yum repositories.
Installed via the iSymphony FreePBX RPM.

Setting The Ownership Of The Desktop Client Module

To set the ownership of the Desktop Client Module you can run the following command, on the server command line:

chown -R <ownername>:<ownergroup> /opt/isymphony3/server/modules/desktop

Replace <ownername> with the name of the user that owns the iSymphony installation and replace <ownergroup> with the group the user belongs to.

For example, if you are running on FreePBX installation of iSymphony, you will use the following command:

chown -R asterisk:asterisk /opt/isymphony3/server/modules/desktop

4. Restart The iSymphony Server

Once the Desktop Client Module is installed, you will have to restart the iSymphony Server in order to activate the module. See Starting And Stopping The iSymphony Server.

5. Add The Desktop Client Installers

The installers served by iSymphony can be added by downloading the .zip archive and moving it to the iSymphony installers directory:

cd ~/
wget http://www.getisymphony.com/files/builds/isymphony/desktop_client/isymphony_desktop_client_2_0_0.zip
mv ./isymphony_desktop_client_2_0_0.zip /opt/isymphony3/server/installers/

The latest version of the desktop client will be served. If no installers are added to the installers directory then the legacy installers (version < 2.0.0) will be served instead.

See Adding New Desktop Client Installers for more information.

6. Install The Desktop Client On The Client Machines

Once the Desktop Client Module is installed, your users will now be able to download and install the Desktop Client Application on their machines. See Desktop Client Installation v2.0.0 or for legacy versions see Desktop Client Installation v1.0.1.