Wiki source code of Desktop Client Module Installation
Version 11.1 by michelk on 2021/09/09 18:01
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | {{layout}} |
| |
11.1 | 2 | {{layout-section ac:type="single"}} |
| 3 | {{layout-cell}} | ||
| 4 | {{warning}} | ||
| 5 | Upgrading to iSymphony Version 3.4.2 or later will include the desktop module by default. Skip this document and proceed to [[doc:Adding New Desktop Client Installers]] if v3.4.2+ is installed. | ||
| 6 | {{/warning}} | ||
| 7 | {{/layout-cell}} | ||
| 8 | {{/layout-section}} | ||
| 9 | |||
| |
1.1 | 10 | {{layout-section ac:type="two_right_sidebar"}} |
| 11 | {{layout-cell}} | ||
| |
11.1 | 12 | |
| 13 | |||
| 14 | |||
| 15 | |||
| |
1.1 | 16 | = Overview = |
| 17 | |||
| 18 | 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 [[doc:Getting Started]]. | ||
| 19 | |||
| 20 | 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. | ||
| 21 | |||
| |
11.1 | 22 | |
| 23 | |||
| |
1.1 | 24 | {{warning}} |
| 25 | The Desktop Client Module requires an iSymphony Server version of **3.2.1 or higher**. | ||
| 26 | {{/warning}} | ||
| 27 | |||
| |
11.1 | 28 | {{warning}} |
| 29 | The Desktop Client Module 2.0.0 requires an iSymphony Server version of **3.4.1 or higher**. | ||
| 30 | {{/warning}} | ||
| |
1.1 | 31 | {{/layout-cell}} |
| 32 | |||
| 33 | {{layout-cell}} | ||
| 34 | {{panel title="On this page:"}} | ||
| 35 | |||
| 36 | |||
| 37 | {{toc maxLevel="2" indent="1"/}} | ||
| 38 | {{/panel}} | ||
| 39 | {{/layout-cell}} | ||
| 40 | {{/layout-section}} | ||
| 41 | |||
| 42 | {{layout-section ac:type="single"}} | ||
| 43 | {{layout-cell}} | ||
| |
11.1 | 44 | = (% style="color: rgb(0, 0, 0); font-size: 24px; line-height: 24px" %)1. Download The Desktop Client Module(%%) = |
| 45 | |||
| |
10.1 | 46 | ((( |
| |
11.1 | 47 | The desktop client module downloads can be found in the [[doc:ISYMKB.Downloads Archive]]. You will want to download the Desktop Client Module package to the server that is running the iSymphony server. |
| |
10.1 | 48 | ))) |
| |
1.1 | 49 | |
| 50 | ((( | ||
| |
11.1 | 51 | |
| 52 | |||
| 53 | {{note}} | ||
| 54 | You need to download the Desktop Module for this step, not the desktop installers. The downloaded file should be a .tar.gz, not a .zip. | ||
| 55 | |||
| 56 | The URL should look like the following, with the exception of the version, which will be replaced with the version you are downloading: | ||
| 57 | |||
| 58 | [[http:~~/~~/www.getisymphony.com/files/builds/isymphony/desktop_modules/isymphony_desktop_version.tar.gz>>url:http://www.getisymphony.com/files/builds/isymphony/desktop_modules/isymphony_desktop_2_0_0.tar.gz||shape="rect"]] | ||
| 59 | |||
| 60 | After step 2 you should have extracted a directory named "desktop", if that is not the case, you used the wrong url. To recover, remove the directory you just extracted from the module directory, and then return to step 1. | ||
| 61 | {{/note}} | ||
| 62 | |||
| 63 | |||
| |
1.1 | 64 | ))) |
| 65 | |||
| 66 | = 2. Extract The Desktop Client Module = | ||
| 67 | |||
| 68 | 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. | ||
| 69 | |||
| 70 | {{code language="bash"}} | ||
| |
11.1 | 71 | tar -zxf isymphony_desktop_<version>.tar.gz -C /opt/isymphony3/server/modules |
| |
1.1 | 72 | {{/code}} |
| 73 | |||
| 74 | = 3. Set The File Ownership Of The Desktop Module = | ||
| 75 | |||
| 76 | The file ownership of the desktop module must match that of the rest of the iSymphony Server installation. | ||
| 77 | |||
| 78 | == Checking File Ownership Of The iSymphony Server Installation == | ||
| 79 | |||
| 80 | To check the file ownership of the iSymphony Server installation you can run the following command, on the server command line: | ||
| 81 | |||
| 82 | {{code language="bash"}} | ||
| 83 | ls -la /opt | ||
| 84 | {{/code}} | ||
| 85 | |||
| 86 | The user that owns the iSymphony server installation will be the user that owns the **isymphony3** directory in the **opt **directory. | ||
| 87 | |||
| 88 | {{info title="Notes on FreePBX & AsteriskNow"}} | ||
| 89 | If your iSymphony server was installed from one of the following sources, the iSymphony server installation will be owned by the **asterisk** user. | ||
| 90 | |||
| 91 | * Came pre-installed with the FreePBX or AsteriskNow distros. | ||
| 92 | * Installed via the FreePBX Yum repositories. | ||
| 93 | * Installed via the iSymphony FreePBX RPM. | ||
| 94 | {{/info}} | ||
| 95 | |||
| 96 | == Setting The Ownership Of The Desktop Client Module == | ||
| 97 | |||
| 98 | To set the ownership of the Desktop Client Module you can run the following command, on the server command line: | ||
| 99 | |||
| 100 | {{code language="bash"}} | ||
| 101 | chown -R <ownername>:<ownergroup> /opt/isymphony3/server/modules/desktop | ||
| 102 | {{/code}} | ||
| 103 | |||
| 104 | Replace **<ownername> **with the name of the user that owns the iSymphony installation and replace **<ownergroup>** with the group the user belongs to. | ||
| 105 | |||
| 106 | For example, if you are running on FreePBX installation of iSymphony, you will use the following command: | ||
| 107 | |||
| 108 | {{code language="bash"}} | ||
| 109 | chown -R asterisk:asterisk /opt/isymphony3/server/modules/desktop | ||
| 110 | {{/code}} | ||
| 111 | |||
| 112 | = 4. Restart The iSymphony Server = | ||
| 113 | |||
| 114 | Once the Desktop Client Module is installed, you will have to restart the iSymphony Server in order to activate the module. See [[doc:Starting And Stopping The iSymphony Server]]. | ||
| 115 | |||
| |
11.1 | 116 | = 5. Add The Desktop Client Installers = |
| |
1.1 | 117 | |
| |
11.1 | 118 | The installers served by iSymphony can be added by downloading the .zip archive and moving it to the iSymphony installers directory: |
| 119 | |||
| 120 | {{code}} | ||
| 121 | cd ~/ | ||
| 122 | wget http://www.getisymphony.com/files/builds/isymphony/desktop_client/isymphony_desktop_client_2_0_0.zip | ||
| 123 | mv ./isymphony_desktop_client_2_0_0.zip /opt/isymphony3/server/installers/ | ||
| 124 | {{/code}} | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | 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. | ||
| 129 | |||
| 130 | {{info}} | ||
| 131 | See [[Adding New Desktop Client Installers>>url:http://docs.getisymphony.com/display/ISYMDOCS/Adding+New+Desktop+Client+Installers||shape="rect"]] for more information. | ||
| 132 | {{/info}} | ||
| 133 | |||
| 134 | === (% style="color: rgb(0,0,0);" %)6. Install The Desktop Client On The Client Machines(%%) === | ||
| 135 | |||
| 136 | 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 [[doc:Desktop Client Installation v2\.0\.0]] or for legacy versions see [[Desktop Client Installation v1.0.1>>url:http://docs.getisymphony.com/display/ISYMDOCS/Desktop+Client+Installation+v1.0.1||shape="rect"]]. | ||
| |
1.1 | 137 | {{/layout-cell}} |
| 138 | {{/layout-section}} | ||
| 139 | {{/layout}} |