Version 5.1 by ryanp on 2021/09/09 18:02

Show last authors
1 What's on this page:
2
3
4
5 {{toc/}}
6
7 {{info}}
8 These instructions are for installation on a vanilla or non FreePBX based Asterisk server. If you are using a FreePBX based install see the [[doc:FreePBX, Elastix and PBX in a Flash Installation]] section.
9 {{/info}}
10
11 {{info}}
12 iSymphony 3.x.x is configured, by default, in such a way that you can run an iSymphony 3.x.x instance along side an iSymphony 2.x.x installation.
13 {{/info}}
14
15 = 1. Before you start =
16
17
18
19 {{id name="Before you start"/}}
20
21 Please check the following points:
22
23 1. Ensure that your system meets the minimum requirements to run iSymphony. For more information, please read the detailed [[system requirements>>doc:iSymphony Requirements]].
24 1. Have your iSymphony license key ready.
25 1. You must be able to use a command prompt and install Java to continue. If not, please contact your system administrator to assist you.
26 1. Determine the correct installation method to use for your environment. See [[doc:Determine the Installation Method]] for more information.
27
28 = 2. Install the JRE (Java Runtime Environment) =
29
30
31
32 {{id name="Install the JRE"/}}
33
34 {{info}}
35 **Please be sure to review the [[Support Platforms>>doc:ISYM28.Supported Platforms]] page for details on version requirements of platform software.**
36 {{/info}}
37
38 1. If you are not sure whether you have JRE installed correctly, please confirm by doing the following:
39 11. Open a shell console.
40 11. Type echo $JAVA_HOME in the shell console and then press Enter
41 11. View the result:
42 11*. If a line is displayed such as /opt/jre1.6.0_12 or /usr/lib/jvm/java-6-sun, then your JRE is installed and properly configured.
43 11*. If nothing is displayed, then you either need to install the JRE or set the $JAVA_HOME environment variable. You can set this environment variable in your user account's 'profile' file. Alternatively, you can set this after installing iSymphony by defining this path in your iSymphony installation's config.sh file, usually located in the iSymphony directory.
44 1. If you need to install the JRE, follow these instructions:
45 1*. Go to the [[Java download page>>url:http://www.oracle.com/technetwork/java/javase/downloads/index.html||shape="rect"]].
46 1*. Download the version entitled 'JRE 7 Update XX', where 'XX' stands for some number. (The latest version is available on that page.)
47 1*. When the download has finished, run the Java installer. Detailed installation instructions are provided on [[Oracle's website>>url:http://www.oracle.com/technetwork/java/javase/index-137561.html||shape="rect"]].
48 At one point, you will be asked to choose an installation directory. Make a note of this directory for use later.
49
50
51
52 {{id name="download"/}}
53
54 = 3. Server Installation =
55
56 Install the iSymphony server. The install package and installation steps will differ depending on the type of OS you will be installing on.
57
58 === RPM (RedHat Based Linux Distributions) ===
59
60 (((
61 Once you have downloaded the iSymphony RPM to your server run the following command to install it.
62
63 {{code language="bash"}}
64 rpm -Uvh iSymphonyServerV3-<version>-1.noarch.rpm
65 {{/code}}
66
67 {{info}}
68 By default the rpm installer will look for your java installation in **/usr/java/latest** or whatever your **JAVA_HOME** environment variable is set to. If the installer cannot locate the JRE the startup will fail. If your JRE is in a different location run the following command to set the JRE location.
69
70 {{code language="bash"}}
71 /opt/isymphony3/server/config.sh
72 {{/code}}
73 {{/info}}
74
75 === Tarball (Debian and other Linux Distributions) ===
76 )))
77
78 1. (((
79 Once you have downloaded the iSymphony TARBALL to your server run the following commands to install it.
80
81 {{code language="bash"}}
82 tar xzf iSymphonyServerV3<version>.tar.gz
83 cd ./iSymphonyServerV3<version>
84 chmod +x install.sh
85 ./install.sh
86 {{/code}}
87 )))
88 1. (((
89 If the installer cannot locate a suitable JRE you will be prompted to specify the path to the JRE during installation.  iSymphony assumes your Sun Java JRE is located in **/usr/java/latest/ **by default.
90 )))
91 1. (((
92 The installer will then ask you for the location to install iSymphony. The default will be **/opt/isymphony3/server.** We recommend that you utilize the default path.
93 )))
94
95 = 4. Setup Asterisk Configuration =
96
97 1. (((
98 Configure Asterisk by including the **isymphony.conf** file in your Asterisk dial plan. This can be accomplished by adding the following line to the end of your Asterisk **extensions.conf **file
99
100 {{code}}
101 #include /opt/isymphony3/server/isymphony.conf
102 {{/code}}
103 )))
104 1. (((
105 Reload the Asterisk Configuration using the following command:
106
107 {{code language="bash"}}
108 asterisk -rx "dialplan reload"
109 {{/code}}
110 )))
111 1. (((
112 Add an entry into **/etc/asterisk/manager.conf** similar to the following and verify that it contains a **permit **entry for the IP that the iSymphony server is installed on:
113
114 {{code}}
115 [isymphony]
116 secret = mysecret
117 deny=0.0.0.0/0.0.0.0
118 permit=127.0.0.1/255.255.255.0
119 read = all
120 write = all
121 writetimeout = 3000
122 eventfilter=!Event: RTCPSent
123 eventfilter=!Event: RTCPReceived
124 eventFilter=!Event: CEL
125 {{/code}}
126 )))
127 1. (((
128 Reload the Asterisk manager configuration using the following command:
129
130 {{code language="bash"}}
131 asterisk -rx "manager reload"
132 {{/code}}
133 )))
134 1. (((
135 If you are using Asterisk Queues you will need to add the following two properties to each queue configured in **/etc/asterisk/queues.conf**
136
137 {{note}}
138 If you do not add these properties, agents will not show any status when they are rung by a queue.
139 {{/note}}
140
141 {{code}}
142 eventmemberstatus=yes
143 eventwhencalled=yes
144 {{/code}}
145
146 Once added run the following command to apply the changes:
147
148 {{code}}
149 asterisk -rx "core reload"
150 {{/code}}
151 )))
152 1. Set up the voicemail and recording agent resource URLs and Extensions:
153 11.
154 111. Open the file **/opt/isymphony3/server/conf/agent/voicemail.xml**
155 111. Modify the **host** value in this file to the public hostname or IP of the iSymphony server. This field specifies the host to use in the URL when playing back voicemail in the client.
156 111. Modify the **extension** value to the file extension of the voicemail files as they are stored in the voicemail directory. This is used to determine which file type to play back in the client when listening to voicemail.
157 111. Open the file **/opt/isymphony3/server/conf/agent/recording.xml**
158 111. Modify the **host** value in this file to the public hostname or IP of the iSymphony server. This field specifies the host to use in the URL when playing back recordings in the client.
159 111. Modify the **extension** value to the file extension of the recording files as they are stored in the recording directory. This is used to determine which file type to play back in the client when listening to recordings.
160 1. (((
161 Start or restart the iSymphony Server via the following commands.
162
163 {{info}}
164 If the iSymphony server is already running you must restart in order for the voicemail and recording configuration to take effect.
165 {{/info}}
166
167 **RPM**
168
169 {{code language="bash"}}
170  service iSymphonyServerV3 restart
171 {{/code}}
172
173 **Tarball**
174
175 {{code language="bash"}}
176 /opt/isymphony3/server/shutdown.sh
177 /opt/isymphony3/server/startup.sh
178 {{/code}}
179 )))
180
181 = 5. Verify Required Ports Are Open =
182
183 Verify that ports 58080 and 55050 are not being blocked by any firewall and are forwarded as necessary. If you are running IP Tables run the following commands on the server CLI in order to open the ports. These ports allow access to the iSymphony Client and Administration interfaces.
184
185 {{noformat}}
186 iptables -L
187 iptables -A INPUT -p tcp -m tcp --dport 58080 -j ACCEPT
188 iptables -A INPUT -p tcp -m tcp --dport 55050 -j ACCEPT
189 service iptables save
190 {{/noformat}}
191
192 {{note}}
193 The above command will open up the iSymphony Client and Administration Interfaces to the entire outside world. Normally this is fine since these interfaces require authentication in order to access them. If you would like to enable further access restriction or enable SSL encryption on the iSymphony Client and Administration Interfaces you can do so via the security system. See [[doc:Security]] for more information.
194 {{/note}}
195
196 The iSymphony server should now be installed and running.