Installationsanweisung fr ViciBox v.

6
(Installation for ViciBox v.6)
www.vicibox.com
Foreword
Some basic Linux skills and general IT knowledge is assumed trougout !arts of tis document. "or
tis reason# tis guide does not cover to!ics suc as basic networking# $% burning# !artitioning sceme
design# var&ing infrastructure metodologies# validit& of install# and oter unmentioned to!ics or
variations of installation. To find out more about an& of te ste!s in tis document# or to learn more
about an& !articular ViciBox install or Vici%ial setu!# we suggest &ou searc and ask 'uestions on te
Vici%ial forums at tt!())www.vicidial.org)VI$I%I*Lforum). In addition# &ou can find more
information wit regards to Linux# +!enSuS,# and oter general to!ics b& using -oogle and)or te
official +!enSuS, v../.. documentation located at tt!())activedoc.o!ensuse.org).
ViciBox is a self0contained installation $% based u!on te +!enSuS, v../.. Linux distribution. It
includes bot online as well as offline installation ca!abilities. Starting wit v.6.1 ViciBox will onl& be
released in a 620bit version for sim!lification and ease of maintenance. *n& modern 346 $56 released
since 7112 sould not ave an& issues running ViciBox.
*lternativel&# if te !ros!ect of installing and maintaining &our own ViciBox)Vici%ial cluster seems
too daunting# te Vici8ost (www.viciost.com) service is available to give &ou all te features and
benefits of Vici%ial witout te com!lexit& and learning curve of setting it u! from scratc.
5aid develo!ment is also available troug Te Vici%ial -rou! (www.vicidial.com) for an&
customi9ations or enancements desired in eiter ViciBox or Vici%ial.
Compatibility and Prereuisites
*s of tis writing te current version of ViciBox is v.6.1.1. It is built wit te following software(
+!enSuS, v../.. x46:62 620bit
Linux ;ernel v./.....1
*sterisk v...4.74.70vici
%*8%I v.7.<.1..
*mfeltec Voices&nc v.../.=
+!en>7 v..././
"or an o!timal ex!erience wit Vici%ial and ViciBox# te following minimum ardware s!ecifications
sould be used(
?uad0$ore $56 7.1-9
2-B >*@
.61-B =711r!m enter!rise0grade S*T* drive (Seagate ,S# 8itaci 6ltraStar# A% >,2# etc)
+!tionall&# in addition to te above s!ecifications# te following can be used for a more robust server(
4-B >*@ (,$$ if available)
Two ot0swa! B11-B enter!rise0grade S*T* or S*S drives in >*I%0.
ViciBox !"xpress#
* ViciBox C,x!ressD s&stem consists of all maEor roles including %atabase# Aeb# and Tele!on&
server. 6sing te minimum ardware s!ecifications listed above# tis would be well suited for a call
center u! to .B agents doing outbound calling wit call recordings at a 2(. ratio. Aen used for
inbound te same minimum ardware s!ecifications are acce!table for u! to 7B agents. 5lease note tat
te figures !resented are a conservative guideline and tat &our actual s&stem ca!acit& is eavil&
determined b& te number of agents# number of leads# concurrent call count# dialing ratio if a!!licable#
cam!aign settings# and te general ca!acit& of te ardware. It is for tis reason tat additional
s!ecifications were !rovided sould &ou run into an& minor load issues. 5articular attention sould be
!aid to te si9e of te ard0drive(s) installed in te s&stem if &ou record &our calls. Te most fre'uent
su!!ort issue we find from new customers is a crased s&stem from te ard0drive being full of
recordings.
ViciBox !Cluster#
$lustering is were multi!le individual servers !erform s!ecific roles witin Vici%ial. Tose roles are
%atabase# Aeb# Tele!on&# and *rcive server. $lustering sould generall& be used for an install
consisting of more ten 71 outbound agents or /1 inbound agents. If &ou do not know or are unsure of
weter &ou sould !erform a clustered install !lease consult wit te free communit&0based Vici%ial
forums or !aid0for Vici%ial -rou! for su!!ort. 5lease be !re!ared to ex!lain &our !lanned installation
including number of agents# call t&!e (+utbound)Blended)Inbound)# ex!ected dialing ratio or
concurrent call volume# arcival re'uirements# and an& oter uni'ue !rocesses or re'uirements &ou
ma& ave. Tis will el! generate an accurate answer to &our 'uestions.
* minimum starting cluster would consist of a single Tele!on& server and a combined %atabase and
Aeb server. * tree server cluster# wereb& tere is at least a single server dedicated to !erforming te
roll of a %atabase# Aeb# and Tele!on& server is te more robust o!tion and re'uires little to no
reconfiguration as te cluster grows in si9e.
Vici%ial scales ori9ontall& for all roles exce!t te %atabase. "or tis reason# &ou will need to s!end
extra time deciding on te ardware s!ecifications of &our %atabase server. Te s!ecifications we
recommend for a database server u! to .B1 agents is as follows(
?uad0$ore $56 7.1-9F
4-B ,$$ >am
70drive 721-BF SS% (Intel B/1# =/1# etc) configured in >*I%0. on a Linux software >*I% or
SS%0o!timi9ed raid card (LSI "ast5at @ega>*I%# etc)
>edundant 5ower Su!!lies wit eac on a different batter& back0u! (o!tional but
recommended)
To add to te above s!ecification for andling u! to /11 agents would be as follows(
Two ?uad0$ore $56 7.1-9F
.6-B ,$$ >am
"or a B11 agent %atabase server# adding to te s!ecification# would be as follows(
Two +ctal0$ore $56 7.1-9F
/7-BF ,$$ >am
20%rive 721-BF >*I%0.1 on SS% (Intel B/1# =/1# etc) wit SS%0o!timi9ed >*I% card (LSI
"ast5at @ega>*I%# etc) or Linux software >*I%
Two Se!arate B11-B enter!rise0grade S*T* drive for te +S in a >*I%0.
Cluster $imensioning
$lustering of te Aeb and Tele!on& roles in vicidial is done ori9ontall&. Tis means tat as &our
ca!acit& grows &ou sim!l& add more servers to &our cluster to com!ensate. * cluster sould alwa&s
start wit at least one dedicated Tele!on& server and a combination %atabase and Aeb server. If &our
total agent ca!acit& will be less ten B1 agents ten &ou can use te o!tional server s!ecifications
!rovided under te C$om!atibilit& and 5rere'uisiteD section for &our %atabase. *ll oter clustering
o!tions sould use one of te database0s!ecific s!ecifications listed under te CViciBox $lusterD
section. *ll Aeb and Tele!on& servers Eust need to adere to te base s!ecifications listed under te
C$om!atibilit& and 5rere'uisiteD section.
In general# &ou can ex!ect to get 7B outbound agents dialing 2(. ratio or B1 inbound agents wit .11
concurrent lines on a dedicated Tele!on& server using te standard ardware s!ecification. It is
recommended to use te o!tional s!ecification for recording long call durations or inbound call centers.
* dedicated Aeb Server will andle a!!roximatel& .B1 agents using te standard ardware
s!ecification. Aen more ten one web server is used it is recommended to configure a tird macine
to act as a login load0balancer between te multi!le web servers. Te agent will initiall& go to te load
balancer to log in and ten be redirected to one of te back0end servers. $onfiguration of te load
balancer is done troug te use of te mod:!rox&:balancer module in *!ace and is not covered b&
tis document. Tere are man& exam!les and walk0trougs available b& searcing te internet.
*lternativel&# te Vici%ial -rou! can install and set0u! a load balancer for &ou troug !aid su!!ort
o!tions.
Below are some exam!les of dimensioning for various agent loads(
B1 *gents +utbound 2(.
+!tional 8ardware S!ecification for %atabase)Aeb
Two Tele!on& Servers 0 Standard or +!tional s!ecification
=B *gent +utbound 2(.
Standard %atabase s!ecification
+ne Aeb server G Standard or +!tional s!ecification
Tree Tele!on& servers 0 Standard or +!tional s!ecification
.11 *gent +utbound 2(.
Standard %atabase s!ecification
+ne Aeb server G Standard or +!tional s!ecification
"our Tele!on& servers 0 Standard or +!tional s!ecification
711 *gent +utbound 2(.
/110agent %atabase s!ecification
Two Aeb servers G Standard or +!tional s!ecification
,igt Tele!on& servers 0 Standard or +!tional s!ecification
+!tionall& one Aeb server to act as login load balancer and administration G Standard or
+!tional S!ecifications
.11 *gent Inbound
Standard %atabase S!ecification
+ne Aeb server G Standard or +!tional s!ecification
Two Tele!on& servers 0 Standard or +!tional s!ecification
711 *gent Inbound
/110agent %atabase s!ecification
Two Aeb servers G Standard or +!tional s!ecification
"our Tele!on& servers 0 +!tional s!ecification
+!tionall& one Aeb server to act as login load balancer and administration G Standard or
+!tional S!ecifications
B11 *gent +utbound 2(.
B110agent %atabase s!ecification
"our Aeb servers G Standard or +!tional S!ecification
Twent& Tele!on& Servers 0 Standard or +!tional S!ecification
+ne web server to act as login load balancer and administration 0 Standard or +!tional
S!ecification
B11 *gent Inbound
B110agent %atabase s!ecification
"our Aeb servers G Standard or +!tional S!ecification
Ten Tele!on& Servers 0 +!tional S!ecification
+ne web server to act as login load balancer and administration 0 Standard or +!tional
S!ecification
* dedicated *rcive server was not listed in an& of te above dimensioning guidelines but will be
needed for most cluster installations. Aile ViciBox does !rovide an o!tion to install as a dedicated
*rcive server it is not re'uired to do so. *n& H*S or server tat can !rovide "T5 for Vici%ial to
u!load recordings and ten 8TT5 service to access tose recordings via a web browser can be used as
an arcive server. Ae recommend &ou ave at least .TB of s!ace available on an arcive server for
storage. 8ardware re'uirements for ViciBox to install as an arcive server are minimal. * dual0core
$56 and 7-B or more of >*@ is all tat is needed. It is igl& recommended tat &ou use at least a
>*I%0. on &our arcive server to !revent data loss.
It sould also be noted tat te Tele!on& server role is limited b& software and not ardware during
dimensioning. Tis means tat it does not scale linearl& wit ardware s!ecifications. If &ou doubled
te ardware ca!acit& &ou would not double te call or agent andling ca!acit&. Tis is because of te
manner in wic *sterisk scales starts to break down around or above 7B1 concurrent internal cannels.
$onsidering one agent in a call can !otentiall& use 2 active internal cannels we cose 7B agents
outbound as our general rule of tumb. Tere is no im!osed limit to !revent &ou from !utting as man&
agents or calls on a server as &ou want# but te cances of te asterisk !rocess crasing resulting in
&our call center being down greatl& increase above te guidelines given. It is te o!inion of te
Vici%ial -rou! tat it is better to ave an extra server and gain stabilit& in te !rocess. Tis is also
cea!er once &ou calculate te cost of an our of downtime versus te cost of te s!are server.
Installation %uidelines
Te standard IrootI !assword is IvicidialI on all installion media. To login &ou sim!l& t&!e IrootI at te
CLoginD !rom!t and IvicidialI at te C5asswordD !rom!t.
ViciBox is available onl& in a x46:62 620bit arcitecture. It is not available in a /70bit arcitecture or
for non x46 based arcitectures like *>@ or 5ower5$. *n& modern $56 released after 7112 sould
not ave an& issues installing or running ViciBox.
Virtuali9ation is NOT recommended for an& !ortion of Vici%ial exce!t te *rcive server. %ue to te
nature of Vici%ial all com!onents o!erate in a real time ca!acit&. Tis is es!eciall& true for te
Tele!on& server since it andles te audio from agents and calls. Virtuali9ed installations will not be
su!!orted b& te Vici%ial -rou!. Su!!ort for virtuali9ed installations ma& be available troug te
Vici%ial forums.
Te documentation is s!lit u! into two mandator& !ases and one o!tional !ase. 5ase . consists of
installing te +!erating S&stem onto te server and configuring te base re'uirements necessar& for
Vici%ial to work. Tis includes tings like >*I% configuration# tird0!art& drivers# and oter
considerations. 5ase . must be com!leted and network connectivit& establised !rior to an& remote
installation assistance. Te server configuration# suc as non0!rivileged users and network
configuration# can be set ere. 5ase . covers two different installation o!tions. * C5reloadD o!tion
wic is te sim!lest metod and te standard CLive$%D wic is te most flexible and
com!reensive.
5ase ..B are o!tional and recommended installation ste!s. Tis !ase is !rimaril& used to u!date te
o!erating s&stem wit an& relevant u!dates and configure additional o!tions like te %ate and Time#
etc. Tis would also be te a!!ro!riate time to do an& custom work to te o!erating s&stem and itIs
configuration !rior to te installation of 5ase 7.
5ase 7 is te final installation ste! tat installs and configures Vici%ial on te server. Tis ste! sould
onl& be done wen te server is in itIs final !roduction environment. If tis is a cluster installation# ten
te %atabase server MUST be com!leted !rior to attem!ting an& oter servers. Te installer will not
allow an install were it can not connect to te %atabase. If &ou ave a !lanned *rcive server using
ViciBox# tat sould be installed !rior to an& Tele!on& servers. *fter installing te database# itIs
recommended to install te web server# arcive server# and ten tele!on& servers in tat order.
Some conventions used trougout te installation instructions are as follows(
$ommands to t&!e will be contained witin a single 'uote and sould be t&!ed exactl& as ow
it a!!ears between te 'uotes# exam!le( Jcommand ereJ
;e&s to !ress on te ke&board will be in all ca!sK tree exam!les( ,HT,> ,S$ "/
;e& se'uences# or a multi!le ke& !ress# will be ca!itali9ed wit a das between eac ke& to
!ress simultaneousl&K five exam!les( *LT0H *LT0? $T>L0I $T>L0*LT0".
$ommentar& and Hotes will be italici9ed ex!laining various o!tions or ex!lanations for tat
stage of te installation.
,ac section as a !aragra! ex!laining te obEective of tat !ase of te installation# as well as
a footer sa&ing were to !roceed to te next section.
Te command !rom!t is signified b& a red !ound (L) sign and te cursor. ,xam!le( linux L
P&ase ' ( )* Installation from !Preload# I*)
Te !reload IS+ automaticall& installs te o!erating s&stem to a single detected ard0drive u!on boot.
It is ade'uate for installing to server wit onl& a single ard0drive or to servers wit a ardware >*I%
controller. It can not be used for an& advanced installation o!tions suc as tird0!art& driver selection#
software >*I% configuration# or for emergenc& troublesooting and rescue. It is te easiest +S
installation o!tion.
To !erform te +S Installation using te !reload IS+ !erform te following ste!s(
.. %ownload ViciBox Server 5reload IS+ from tt!())download.vicidial.com)iso)vicibox)server)
7. Burn IS+ to $% and boot from te disk
/. *t te boot screen# select CInstall ViciBox v.6.1D and !ress ,HT,>.
2. If te ard drive drive sown is correct drive to install to ten select CMesD and !ress ,HT,> to
continue. The installer will install to the first hard-drive it finds. Make sure this is the correct
hard-drive. If not, it may be necessary to disconnect all hard-drives except the intended OS
drive.
B. T&!e IrootI at te CLoginD !rom!t and !ress ,HT,>. fter the server boots, you may need to
press !"T!# to see the $%o&in' prompt appear.
6. T&!e IvicidialI at te C5asswordD !rom!t and !ress ,HT,>.
=. %ue to a bug in +!enSuS, v../..# it is re'uired to reboot te server to restore !ro!er screen
function in I&astI and oter !rograms. T&!e IrebootI and !ress ,HT,>. It is a &ood idea to
remove the () from the drive durin& reboot as well as settin& the *IOS to boot from the hard-
drive before any other devices.
Te 5ase0. +S Installation using te C5reloadD IS+ is now com!lete. Mou do not need to !erform an&
oter instructions labeled C5ase .D. 5lease !roceed to te 5ase ..B installation instructions. Mou will
need to com!lete te re'uired !ortions of 5ase ..B before continuing to 5ase 7.
P&ase ' ( )* Installation from standard I*)
Te standard IS+ is a CLive$%D tat boots into a full&0functional +!enSuS, s&stem !rior to
installation. Tis allows &ou to do an& custom work to te server !rior to +S installation suc as
s!ecial !artitioning# com!atibilit& testing# loading tird0!art& drivers# etc. Te +S installer will also
give &ou more advanced o!tions like configuring te !artitioning sceme# software >*I% setu!# etc.
%ue to te com!lexit& of tis IS+ it is not recommended for an&one not somewat familiar wit Linux
or +S installation in general. Tis IS+ can be used to boot a crased s&stem and allow an engineer to
log in remotel& to fix crased servers# recover !asswords# or test for failed ardware. It is te most
flexible and com!reensive installation medium offered for ViciBox.
To !erform te +S Installation using te standard IS+ !erform te following ste!s(
.. %ownload ViciBox Server IS+ from tt!())download.vicidial.com)iso)vicibox)server) The
standard ISO does not have +preload+ in the file name.
7. Burn IS+ to $% and boot from te disk
/. *t te boot screen# !ress te "/ ke& to select te Video @ode o!tions
2. 6sing te arrow ke&s# igligt te IText @odeI o!tion and !ress te ,HT,> ke&
B. 6sing te arrow ke&s# igligt te IViciBox6I o!tion in te center of te screen and !ress te
,HT,> ke&.
6. *t te login !rom!t# t&!e IrootI and !ress ,HT,>. ,ou may have to hit !"T!# after a minute to
see the lo&in prompt. It sometimes &ets overwritten on the screen from the boot process.
=. *t te 5assword !rom!t# t&!e IvicidialI and !ress ,HT,>
4. *t te command !rom!t# t&!e Ios0installI and !ress ,HT,>. If there is any custom
confi&uration to be done to this server prior to OS installation, it should be done before this
step.
<. To cange te default langauge# !ress *LT0L and select &our !referred language
.1. To cange te default ke&board la&out# !ress *LT0; and select &our !referred la&out
... 5ress *LT0H to agree to te license dis!la&ed and move on to te next screen
.7. To cange te dis!la&ed region# !ress *LT0, and use te u! and down arrow ke&s to select &our
!referred region. lternatively, the T* key can be used to switch between windows on this
screen and proceedin& screens.
./. To cange te dis!la&ed Time None# !ress *LT0N and use te u! and down arrow ke&s to select
&our !referred time 9one.
.2. 5ress *LT0H to acce!t te selected >egion and Time None and move on to te next screen
.B. To acce!t te default !artitioning sceme !ress *LT0H to !roceed to te next screen. The
partitionin& module in OpenSuS! v.-..- is somewhat inconsistent. ,ou should see the summary
list /(reate swap volume 0dev0sda-/ and /(reate root volume 0dev0sda1/. If not, please read the
partitionin& notes under the Miscellaneous section at the end of this document prior to
proceedin&.
.6. 5ress *LT0I to install te o!erating s&stem according to te installation summar& !resented. ,ou
can use the up and down arrows keys to scroll throu&h the installation summary. ,ou can press
!"T!# on any hi&hli&hted section to ad2ust those installation options, althou&h those options
will not be covered by this document. This is the point of no-return, do not proceed past here if
this server already has important data on it.
.=. 5ress *LT0I to confirm te destruction of te ost s&stem and installation of te new o!erating
s&stem. ,ou will be presented with a screen showin& installation pro&ress and lo&s. t this point
all data on the hard drive has been destroyed.
.4. Aen !rom!ted# !ress *LT0H and ten !ress ,HT,> to reboot te server. ,ou may also use the
left and ri&ht arrow keys to hi&hli&ht /#eboot "ow/ and press !"T!#. It is a &ood idea to
remove the () from the drive durin& reboot as well as settin& the *IOS to boot from the hard-
drive before any other devices.
.<. %uring boot# at te 8ostname !rom!t# t&!e in te !referred 8ostname of tis server in te
8ostname field. !ach server in a cluster MUST have a uni3ue hostname that is less then -4
characters5 The installation will fail otherwise. 6lease see step -4 under$"etwork
(onfi&uration' subsection in 6hase -.7 for preferred installation hostnames and &uidelines.
71. 5ress te T*B ke& to igligt te %omain Hame field and enter te a!!licable domain name.
If you do not know or do not have your local domain name 2ust enter +vici.local+ for the )omain
"ame to prevent any issues later on. This can be chan&ed later.
7.. 5ress *LT0H to acce!t te ost name and domain name and move on to te next screen.
77. *t te Hew Local 6ser screen# if desired# enter te user credentials to use for a non0!rivileged
user. If you do not want to set-up a non-privile&ed user, you can safely leave all fields blank and
the installer will not create one. The installer will prompt you to make sure you do not want to
create a user, you can safely press !"T!# while ,es is hi&hli&hted. lternatively, if the
password you entered is not determined to be a hi&h-security password, it will also alert you.
&ain, you can 2ust press !"T!# to continue.
7/. 5ress *LT0H to continue to te next screen.
72. *t te login !rom!t# t&!e IrootI and !ress ,HT,>.
7B. *t te !assword !rom!t# t&!e IvicidialI and !ress ,HT,>.
76. %ue to a bug in +!enSuS, v../..# it is re'uired to reboot te server to restore !ro!er screen
function in &ast and oter !rograms. T&!e IrebootI and !ress ,HT,>.
Te 5ase0. +S Installation using te standard IS+ is now com!lete. Mou do not need to !erform an&
oter instructions labeled C5ase .D. 5lease !roceed to te 5ase ..B installation instructions. Mou will
need to com!lete te re'uired !ortions of 5ase ..B before continuing to 5ase 7.
P&ase '.+ ( ,euired- ,ecommended- and )ptional configuration items
Tis section contains small miniaturi9ed installation and configuration instructions for various tings.
Te onl& re'uired section is te OHetwork $onfigurationO section. It is re'uired tat all Vici%ial servers
be able to communicate freel& wit eac oter on te network. Te oter sections include
recommended and o!tional configuration information.
5ase ..B 0 Hetwork $onfiguration REQUIRED CONFIGURATION
.. If not alread&# login as te root user b& t&!ing IrootI at te login !rom!t and IvicidialI at te
!assword !rom!t. If you chan&ed the root password, or someone else has, you will need it to
lo&in. The password can not be recovered easily and re3uires offline intervention.
7. T&!e I&ast lanI and !ress ,HT,> Optionally, you can type +yast+ and navi&ate to the network
confi&uration by &oin& to "etwork )evices --8 "etwork Settin&s.
/. 6sing te T*B ke&# !ress it until te network card is selected. If you have multiple network
cards, select the one that will be used to communicate with the other 9ici)ial servers.
2. 5ress *LT0I to edit te network configuration for tat interface.
B. 5ress *LT0T to select OStaticall& assigned I5 *ddressO. The server should always have a
statically assi&ned I6 address, no exceptions.
6. 5ress *LT0I to move te cursor to te OI5 *ddressO field# it sould be igligted. Optionally,
you can use the T* key to move between fields and windows on this screen and the proceedin&
screens.
=. ,nter te I5 *ddress for tis interface. This should primarily be the internal I6 ddress if this is
the first network card. If this is the second network card, this would be the I6 ddress provided
to you by your IS6 if not behind a router.
4. 5ress *LT0- to view te -eneral o!tions for tis network card.
<. 5ress *LT0N to select te "irewall None for tis Interface.
.1. 6sing te u! and down arrow ke&s# select OInternal NoneO and !ress ,HT,>. If this is the
second network card connected directly to the internet, select /!xternal :one/ instead.
Optionally, if you are &oin& to disable the built-in firewall, select /Internal :one/ for all
network cards to prevent the system from bein& locked out should the firewall be turned on by
mistake.
... 5ress *LT0H to acce!t network card configuration and return to te +verview screen.
Optionally, if you have a second network card to confi&ure, you can repeat steps . to -- by
select the second network card in step..
.7. 5ress *LT0S to cange to te 8ostname)%HS screen
./. 5ress *LT0T to select te 8ostname field
.2. ,nter te uni'ue 8ostname of tis server. ll servers MUST have a uni3ue hostname for the
installation to properly continue. The installer will fail if all hostnames are not uni3ue. ;e
recommend usin& )*<x=, ;eb<x=, and 9ici<x= for the hostnames while replacin& the <x= with the
numerical se3uence of the installed server. >or instance, the first ;eb server would be ;eb-,
the second ;eb server would be ;eb1, the first Telephony server would be 9ici-, the second
Telephony server would be 9ici1, etc. Try to choose a hostname that relates to the function of
the server and not an arbitrary name to avoid confusion. "ames like +:eus+, +*atman+, +Mickey
Mouse+, etc, do not properly relate to the function of the server.
.B. 5ress *LT0% to select te %omain field
.6. ,nter te %omain name for tis server. If you do not have or know your )omain, enter
+vici.local+.
.=. 5ress *LT0. to select Hame Server . field
.4. ,nter te %omain of tis server.
.<. ,nter te !rimar& name server to use on &our network. If you are behind a router this is
typically the router I6. If you do not have or know your )"S server+s I6 then enter +?.?.?.?+ to
use &oo&le )"S.
71. 5ress *LT07 to select Hame Server 7 field
7.. ,nter te secondar& name server ot use on &our network. If you do not know or have a
secondary )"S server, then enter +?.?.?.?+ if not already used for @oo&le )"S, or
+1A?.BC.111.111+ for Open)"S.
77. 5ress *LT06 to cange to te >outing screen
7/. 5ress *LT0" to select te %efault I5v2 -atewa& field
72. ,nter te default gatewa& I5 for &our network. This will be the I6 address of your router. This is
determined by your local network0router and can not be determined remotely. If you have a
second network interface card that is directly connected to an IS6 then you will enter the
&ateway I6 provided by the IS6 here.
7B. 5ress *LT0+ to +k te installation and make te canges. ,ou can review the chan&es by
pressin& %T-9 for the overview, %T-S for the Dostname0)"S confi&uration, and %T-E for
the routin& confi&uration.
76. Verif& !ro!er network connectivit& b& tr&ing to !ing someting on te internet# I.,. I!ing
google.comI. 5ress $T>L0$ to sto! te !ing wen satisfied. If you do not have internet
connectivity try pin&in& another server or workstation on the network.
In addition to basic network configuration# &ou can configure te built0in s&stem firewall b& t&!e I&ast
firewallI or select Securit& 00P "irewall after t&!e I&astI. Te 5ase 7 installation scri!t will ask &ou if
&ou want to enable or disable te firewall and will automaticall& o!en u! te a!!ro!riate !orts for
Vici%ial to function if left enabled. Mou onl& need to configure advanced o!tions if wanted.
5ase ..B G Install 6!dates ,ecommended
.. If not alread&# login as te root user b& t&!ing IrootI at te login !rom!t and IvicidialI at te
!assword !rom!t. If you chan&ed the root password, or someone else has, you will need it to
lo&in. The password can not be recovered easily and re3uires offline intervention.
7. T&!e I9&!!er u! 0&I to bring te u!date !rocess. If this step fails, then try a&ain later. The
OpenSuS! repositories &o into maintenance at certain times and can be unavailable, makin&
updates impossible to happen.
/. T&!e IrebootI to cleanl& load and a!!l& an& u!dates tat were a!!lied to &our s&stem.
5ase ..B G $onfigure Time None ,ecommended
.. If not alread&# login as te root user b& t&!ing IrootI at te login !rom!t and IvicidialI at te
!assword !rom!t. If you chan&ed the root password, or someone else has, you will need it to
lo&in. The password can not be recovered easily and re3uires offline intervention.
7. T&!e I&ast time9oneI to enter te time 9one configuration screen
/. T&!e *LT0> to move to te region selection window.
2. 6sing te u! and down arrow ke&s# select te a!!ro!riate region for tis serverIs location.
B. T&!e *LT0N or !ress T*B to move to te Time None window
6. 6sing te u! and down arrow ke&s# select te a!!ro!riate time 9one for tis serverIs location.
=. T&!e *LT0+ wen finised to acce!t te configured region and time 9one for tis server.
5ase ..B0 $anging te root !assword )ptional .,ead completely first/
.. If not alread&# login as te root user b& t&!ing IrootI at te login !rom!t and IvicidialI at te
!assword !rom!t. If you chan&ed the root password, or someone else has, you will need it to
lo&in. The password can not be recovered easily and re3uires offline intervention
7. T&!e I!asswdI at te command !rom!t to start te !assword cange !rocesses
/. T&!e in te new root !assword at te CHew 5assword(D !rom!t and !ress ,HT,>
2. Verif& te !assword b& t&!ing it in again at te C>et&!e new !assword(D !rom!t and !ress
,HT,>.
%+ H+T L+S, T8IS 5*SSA+>%Q It is alwa&s re'uired for an& remote su!!ort needed at te
o!erating s&stem level and can not easil& be recovered. 5lease cose a !assword tat contains letters
and numbers and is at least 4 caracters long. @ixing u!!er and lower case letters is advisable and
s!ecialt& caracters like R S ) F 0 Q T can also be used.. *void coosing !asswords tat are overl&
com!lex# random# or ard to remember. Tis Eust leads to !eo!le writing te !assword down and
leaving it stuck to teir monitor.
+ne sim!le metod is to take a word and re!lace a few letters wit numbers and ca!itali9e it. "or
instance# if we take te standard root !assword IvicidialI and a!!l& tis logic we would end u! wit
IV.c.d.alI. Aile 4 caracters is te minimum recommended lengt# .7 or more caracters is o!timal.
*void using a strong !assword generator as te !assword will almost assuredl& be forgotten or written
down wic negates te wole !oint of a strong !assword to begin wit. *lso do not use an& !assword
contained witin tis document or used as an agent)manager login. Te root !assword sould be uni'ue
and not sared wit an&one oter ten s&stem administrators.
If te IssI service (T$5 5ort 77) is not ex!osed or connected to te internet to begin wit ten it is
arguabl& safe to leave te stardard root !assword of IvicidialI. If te server IS accessible via SS8 from
te internet ten it is igl& recommended to cange te root !assword or oterwise restrict access to it
externall&. If someone is able to log in as root te& will be able to do watever te& want wit &our
server. @ost of te time tis involves using &our s&stem for S!am# %%oS attacks# and bitcoin mining.
*ll of wic ave a ver& detrimental effect on &our Vici%ial s&stem.
P&ase 0 1 ViciBox 2"xpress2 Installation
Tis section contains installation instructions for te O,x!ressO installation metod of ViciBox. 5lease
read te OViciBox ,x!ressO section at te beginning of tis document before continuing. Te time
re'uired to s!lit an ,x!ress installation into a cluster later can easil& sur!ass te amount of time
normall& re'uired to set0u! a $luster from te start.
To install Vici%ial using te ViciBox O,x!ressO metod# run te following(
.. If not alread&# login as te root user b& t&!ing IrootI at te login !rom!t and IvicidialI at te
!assword !rom!t. If you chan&ed the root password, or someone else has, you will need it to
lo&in. The password can not be recovered easily and re3uires offline intervention.
7. T&!e Ivicibox0ex!ressI and !ress ,HT,>. ,ou will see the installer start in 9ici*ox !xpress
mode. It will prompt for any further input it needs while installin&.
/. Aen te installer indicates tat it as com!leted# t&!e IrebootI and !ress ,HT,> to reboot te
s&stem and cleanl& load all canges and Vici%ial.
2. "rom a web browser on a workstation# t&!e in te I5 *ddress of &our server and !ress ,HT,>.
B. *t tis !oint &ou sould see te Vici%ial welcome !age. Te installation is now com!lete.
5lease refer to te Vici%ial @anual for furter instructions on logging into Vici%ial and configuring te
various o!tions. Te default administrative user for Vici%ial is I6666I wit te !assword of I.7/2I. Mou
do not need to com!lete an& oter 5ase 7 instructions at tis !oint.
5lease use caution wen selecting s&stem !asswords. If &ou kee! te !asswords too sim!le &ou o!en
&ourself u! to ackers committing toll fraud troug &our s&stem. * secure !assword contains more
ten 4 caracters and consists of one lowercase letter# one u!!ercase letter# and one numeral. *n
exam!le of a secure !assword would be Inebl68,1u7Ba1-tI. 5lease %+ H+T use tis !assword# it is
+HLM an exam!le. Te default !one registration !assword and server !assword as alread& been
randomi9ed in &our install. Aen canging tem# !lease kee! te above secure !assword re'uirements
in mind.
P&ase 0 1 ViciBox 2Cluster2 Installation
Tis section contains installation instructions for te O$lusterO installation metod of ViciBox. 5lease
read te OViciBox $lusterO section at te beginning of tis document before continuing. * cluster wit
under!owered resources can !otentiall& cause !roblems tat could result in downtime and loss of
!roductivit&. Server downtime can easil& outweig te financial savings from under0!owering a
$luster. "ree communit& su!!ort is available on te forums as well as !aid su!!ort troug te
Vici%ial -rou! if &ou ave an& 'uestions on !ro!erl& dimensioning or installing a cluster.
%ue to te nature of clustering and te ViciBox installer# all clusters# regardless of si9e# must be
installed in te following order(
.. %atabase Server
7. *rcive Server if a!!licable
/. Aeb Server
2. Tele!on& Server
Te installer will refuse to run witout being able to !ro!erl& connect to te database. If &ou ave a
slave database# make sure &ou are !utting in te I5 *ddress of +HLM te master database wen te
installer asks. Mou must also ave at least one Aeb server installed !rior to installing an& Tele!on&
servers in order for te *udio Store and oter web0based Vici%ial features to be !ro!erl& set0u! and
enabled. Best !ractice is to run te installations linearl&# starting wit te %B server and !rogressing
&our wa& on to te next server onl& wen te current one as com!leted itIs install. Tis ensures tat
tings are installed !ro!erl& and in te rigt order to !revent an& issues.
@ake sure to write down te I5 *ddressI of all &our servers so tat &ou can refer to tem later during
te installation. Tis will not onl& el! during te installation but also sorten te time it takes to
diagnose and correct an& issues tat ma& come u!. If !ossible# ma! out &our I5 addressI so tat te& are
linear in !rogression and make sense. "or instance# .<7..64.1..1 would be a database# following b&
.<7..64.1... for te web server# and ten .<7..64.1..7 and above for te tele!on& servers.
To install Vici%ial using te ViciBox O$lusterO metod# run te following(
.. If not alread&# login as te root user b& t&!ing IrootI at te login !rom!t and IvicidialI at te
!assword !rom!t. If you chan&ed the root password, or someone else has, you will need it to
lo&in. The password can not be recovered easily and re3uires offline intervention.
7. T&!e Ivicibox0installI and !ress ,HT,>. The installer will start and prompt you for all further
confi&uration information.
/. Aen te installer indicates tat it as com!leted# t&!e IrebootI and !ress ,HT,> to reboot te
s&stem and cleanl& load all canges and Vici%ial.
Installation of a cluster can not be verified until te Aeb server is installed at a minimum. To verif&#
t&!e te web servers I5 address from a workstation and &ou sould see te Vici%ial welcome !age. Te
default administrative user is I6666I and !assword I.7/2I. 5lease refer to te Vici%ial @anual for
information on initiall& logging in and configuring Vici%ial from te web interface.
+nce &ou ave logged into te web interface# &ou can verif& tat te cluster is working !ro!erl& b&
clicking on te >e!ort section on te left# and ten clicking te F next to were it sa&s OServerO at te
bottom. It will list te time on all connected macines in te cluster. Aen !ro!erl& set0u!# all
macines sould be witin one to two seconds of eac oter wit te exce!tion of te %atabase server
entr&. Mou sould all see all te ostnames of te Tele!on& server and te %atabase server. It is correct
for te %atabase server entr& to not sow te correct time# owever# at te bottom te O%B TimeO field
sould matc.
P&ase 0 1 ViciBox 2,estore2 *erver ,eplacement in a Cluster
Te restore metod is not a com!lete end0all solution for re!lacing a server in a ViciBox cluster. It is a
tool meanIt to ease and s!eed te re!lacement of a server. It can not be used for a database and does not
co!& an& custom configurations# crontab entries# or oter tings done on a server. It is advised &ou
maintain back0u!s of &our servers to !revent data loss and additional downtime during re!lacement.
In order to use te restore o!tion &ou will need to know &our database connection information. If te
database was installed wit ViciBox !rior to v.2.1 or ten &ou will also need to know te SVH revision
running on &our cluster. Te safest metod for determining te SVH revision it to run Isvn infoI in
te )usr)src)astguiclient)trunk director& on &our database server. If &our database was not installed using
ViciBox ten &ou will ave to ask te s&stem administrator wat SVH revision was used.
To run te ViciBox restore# !erform te following commands(
.. If not alread&# login as te root user b& t&!ing IrootI at te login !rom!t and IvicidialI at te
!assword !rom!t. If you chan&ed the root password, or someone else has, you will need it to
lo&in. The password can not be recovered easily and re3uires offline intervention.
7. T&!e Ivicibox0install 00restoreI at te command !rom!t and !ress ,HT,>. The installer will
start in the special restore mode and prompt you for further information.
/. Aen te installer indicates tat it as com!leted# t&!e IrebootI and !ress ,HT,> to reboot te
s&stem and cleanl& load all canged and Vici%ial.
ViciBox 3pgrade
Tere are currentl& two metods for u!grading ViciBox. @etod one is to do all ste!s and !rocedures
manuall& according to te documentation located at )usr)src)astguiclient)65->*%,. Te second
metod involves using a !rogram called Ivicibox0u!gradeI to !erform te scema and SVH u!grade for
&ou leaving Eust te canges to configuration files. Te vicibox0u!grade !rogram will also add te
vicibox table on te database if it doesnIt exist making &our cluster com!atible wit newer features
introduced since ViciBox v.2.1.
Te !referred metod is to start on te database. It is igl& advised &ou take a back0u! of te database
!rior to !erforming te u!grade. +nce te database is done &ou would ten run vicibox0u!grade on te
web servers# followed b& te dialers. Mou can use te 00el! flag to view all run0time o!tions. 5lease
kee! in mind tat te u!grade !rogram does not modif& an& configuration files like
)etc)asterisk)extensions.conf. Tese will still need to be u!graded b& and. Tis is merel& a tool to el!
u!grade te database and make sure te same SVH revision is installed on all servers.
Te !rogram as been tested to run !ro!erl& on ViciBox v./.1 and above. Mou can sim!l& co!& it to te
older servers to use itIs features. *s mentioned !reviousl&# alwa&s start wit te database first. It is
im!erative tat te database be u!graded first before an& oter s&stems in a cluster are attem!ted. If
&ou are u!grading an Iex!ressI installation ten &ou onl& need to run vicibox0u!grade once.
Aen ran on a s&stem tat was installed !rior to ViciBox v.2.1 &ou will be !rom!ted for te roles tat
eac server !erforms. Mou will ten be !rom!ted on weter or not to insert te records into te vicibox
table if it exists at te end of te u!grade. Te recommendation is to sa& Mes to inserting te records
into te vicibox table. Tis will el! in te maintenance of &our installation in te future.
4iscellaneous- 5ips and 5ric6s- Issues- and ot&er commentary
Installation Partitioning on *tandard I*)
Te !artitioning module included in +!enSuS, as become less consistent in ow it calculates te
!artitioning sceme. Te default !aritioning sceme tat it sould be creating consists of a 2-B Oswa!O
!artition and a O)O root !artition containing te rest of te drive. 6nfortunatel& tis does not work
consistentl& if tere was a !reviousl& installed linux swa! !artition. Instead it will use tat swa!
!artition# create anoter 2-B !artition# and ten configure te rest of te drive as te O)O root !artition.
Te easiest wa& to fix tis is to wi!e out te !artition table using te following command from te
Live$% !rior to t&!ing Ios0installI during 5ase .(
.. T&!e Idd ifS)dev)9ero ofS)dev)sda bsSB.7I and !ress ,HT,>
7. T&!e IrebootI to reboot te server and re0attem!t &our install
$*6TI+H( %o not run tis command on an& active server as it will destro& all data on te drive
re'uiring a s!ecialist to recover it. Mou ave been warnedQ
"xpert 4ode )ptions
Te O$lusterO installer includes an ex!ert mode to enable extra o!tions for tose wo needs tem. If
&ou are not tat familiar wit Linux or Vici%ial ten most likel& &ou do not need an& of te o!tions
offered b& ex!ert mode. Im!ro!erl& setting tings in ex!ert mode can ave a detrimental effect to te
efficienc& and o!eration of a cluster.
Below are te extra !rom!ts offered b& te ex!ert mode install(
Slave %atabase installation
Install index.!! to redirect user to te Vici%ial welcome screen (enabled b& default)
Install !!@&*dmin (disabled b& default)
Su!!l& connection settings for use b& te *rcive server role
7egacy 4ode
Legac& mode enables su!!ort for legac& Vici%ial installs not installed using ViciBox v.2.1F. Mour
installation must be using an SVH OTrunkO >evision in order to be com!atible wit ViciBox v.2.1. Mou
will also need to know wat SVH revision &our oter servers are using in order for ViciBox to
com!lete itIs install. * metod to add te IviciboxI table used b& ViciBox v.2.1F to older installations is
currentl& !lanned but not available &et.
5&e 8ngrep1sip8 command
Tere is an ama9ingl& useful but little known utilit& tat as been included in ViciBox v./..F called
Ingre!0si!I. Aat tis does is use ngre!# a network0gre!Iing utilit&I# and scans for SI5 traffic. ItIs use is
!rett& straigtforward# &ou t&!e Ingre!0si!I and it gives SI5 out!ut. In addition to tis# &ou can scan for
SI5 traffic to a certain ost or for a s!ecific !one number. "or instance# if &ou want to see te SI5
messages going to !one number 46//</<//1# &ou would run Ingre!0si! 46//</<//1I. It will ten onl&
sow &ou SI5 messages tat ave tat !one number in it. Mou can also use ost to s!ecif& onl& a
certain ost. So if &ou wanted to see SI5 messages going to a new carrier wit I5 *.B.$.%# &ou would
t&!e Ingre!0si! ost *.B.$.%I. Mou can also ca!ture tese messages to send to carriers wen te&
inevitabl& tell &ou ever&ting is great but te& are broken. It sould be noted tat ngre!0si! does not
dis!la& correctl& wen using VL*Hs on &our network# but it is still close enoug to be readable if &ou
understand SI5 messaging. Tere is a config file located at )etc)ngre!0si!.conf if &ou want to cange
te standard network interface it listens to wen ran. >emember# wit all carriers# &ou are wrong until
M+6 ave !roven oterwise.
5&e 8mysl1tuning8 command
Te Im&s'l0tuningI scri!t will look at &our currentl& running @&S?L configuration and give &ou
generali9ed recommendations on tuning &our m&.cnf settings as well as sow were an& !otential
!roblems are. Tis is es!eciall& useful for wen tings seem to be slowing down but notings looks
obviousl& wrong. Tis is useful for wen &ou it &our @&S?L configured max connection limit. It will
also sow &ou if &ou ave ever allocated more memor& ten &ou ave >*@ wic means &ou
swa!!ed out to disk. *ll ver& useful tings# but it is not .11U accurate in itIs recommendations. It is
merel& a tool used to guide &ou in te diagnosis of a !roblem. It sould not be used for fine tuning but
for diagnostic and broad tuning.
9oiper :eb P&one is installed
Te 9oi!er web !one is installed b& default on all version of ViciBox and works for u! to / minutes if
&ou want to test it. Te web !one is Aindows onl& and best installed initiall& from Internet ,x!lorer.
5oint I, to tt!())webserver.i!)agc)web!one) and it sould download and install. +nce installation is
com!lete# te web!one works from I,# "ire"ox# and $rome. Te Noi!er Aeb 5one License can be
!urcased from te Vici%ial -rou! and installed for &ou or &ou can !urcase it directl& from Noi!er
and install it. Te web !one is based u!on &our full& 'ualified domain name ("?%H) and is non0
refundable once issues. Tis means tat if &ou tell tem to generate te license for
tt!())m&.webserver.com and &ou ten later decide &ou wanted it to be tt!())some.webserver.com te
license will not work. Mou will ave to !urcase a second license for te new "?%H or sta& wit te
old server name. Mou also need to use a domain name as it will not work wit I5 *ddressing directl&.
Feedbac6 and Community *upport
Ae like earing from &ou. Aeter it is bugs# condemnation# or !raise# we like it. It el!s us to
im!rove bot Vici%ial and ViciBox. Aitout &our feedback tings will not im!rove or move in te
direction te communit& wants it to. 5lease take some time to log into te communit& forums at
tt!())www.vicidial.org)VI$I%I*Lforum) and let us know ow &ou did# good or bad. Mou will find te
arra& of talent available tere to be excellent as well as te breadt of knowledge alread& !osted.
5lease remember to searc for an& issues or to!ics !rior to !osting to see if &our 'uestion as alread&
been answered. In addition to getting &ou &our answer 'uicker# it also makes oters more likel& to
res!ond wen te& know &ou searced first.
Aen !osting on te forum# it is considered !ro!er eti'uette to state wat installation medium &ou
used# wat te Vici%ial *dmin and Build date are from te administration interface# wat SVH revision
&ou are using# and an& oter !ertinent information tat migt relate to &our issue or bug. "or instance#
using te version of Vici%ial si!!ed on ViciBox v.2.1.1# wit a =B0agent outbound cluster using te
dimensioning mentioned !reviousl&# &ou would want to include te following in &our !ost so we know
ow best to start el!ing &ou(
ViciBox v.2.1.1 /70bit !reload
Build( .714/.0.B74
Version( 7.60/=Ba
SVH >ev( .4B4
.x%B# .xAeb# /xTele!on&# .x *rcive
Credits and 5&an6s
Tanks go out to all te active members of te Vici%ial $ommunit& "orums and tose com!anies and
individuals wo s!onsor features in Vici%ial and ViciBox. Tese gu&s make tings a!!en and !us us
to release bigger and better versions of Vici%ial and ViciBox. Te& ave committed code sni!!ets for
im!roving functionalit&# !aid for features tat ever&one gets to use# and beta tested earl& versions to tr&
and find bugs before general release. Sto! b& and sa& tanks# te& like it.
Vici%ial was written and co!&rigt b& @attew "lorell. Te god0fater of Vici%ial and te Vici%ial
-rou!.
ViciBox was conceived initiall& b& @icael $argile from te Vici%ial -rou!.
ViciBox is currentl& written and maintained b& Vames 5earson from te Vici%ial -rou!. Te grave&ard
engineer of Vici%ial -rou! and te gu& wo screwed u! tat ting in ViciBox &ou needed.
Iterative testing and verification !erformed b& ;eit 8uges# >obert >eeder# and @att Borcert from
te Vici%ial -rou!. Te OnormalO engineers# e.
,nEo&