CounterPath Bria for Linux User Manual
Bria 3 for Linux Administrator Guide
CounterPath Corporation
CounterPath Corporation
Suite 300, One Bentall Centre
505 Burrard Street, Box 95
Vancouver, BC V7X 1M3
Tel: 604.320.3344
sales@counterpath.com www.counterpath.com
© July 2010 CounterPath Corporation. All rights reserv ed.
This document contains information proprietary to CounterPath Corporation, and shall not be used for
engineering, design, procurement, or manufacture, in whole or in part, without the consent of CounterPath
Corporation.
The content of this publication is intended to demonstrate typical uses and capabilities of the CounterPath
Bria 3 softphone application from CounterPath Corporation. Users of this material must determine for
themselves whether the information contained herein applies to a particular IP-based networking system.
CounterPath makes no warranty regarding the content of this docu ment, including—but not limit ed to—implied
warranties of fitness for any particular purpose. In no case will CounterPath or persons involved in the
production of this documented material be liab le for any inciden tal, indire ct or otherwise co nsequential damage
or loss that may result after the use of this publication.
CounterPath and the logo are trademarks of CounterPath Corporation.
Ubuntu and Canonical are registered trademarks of Canonical Ltd.
This manual corresponds to version 3.1 of Bria 3 for Linux.
Rev 2
2
Content s
Overview.......................................................................................................................................1
System Requirements .............................................................................................................1
Multimedia Device Requirements ..........................................................................................2
Deploying through Manual Configuration: Recommended Procedure..................................3
Deploying through Remote Provisioning: Recommended Procedure....................................4
Configuring Bria...........................................................................................................................6
Configuring Accounts.............................................................................................................6
Configuring Global Settings (Preferences).............................................................................7
Setting up Contacts.................................................................................................................7
Managing Licenses .................................................................................................................8
Account Configuration Reference ................................................................................................9
SIP Account Properties – Account .........................................................................................10
SIP Account Properties – Voicemail ......................................................................................11
SIP Account Properties – Topology .......................................................................................13
SIP Account Properties – Storage...........................................................................................14
SIP Account Properties – Security..........................................................................................15
SIP Account Properties – Advanced.......................................................................................17
Preferences Reference...................................................................................................................19
Preferences – Network............................................................................................................20
Preferences – Audio Codecs...................................................................................................21
Preferences – Quality of Service ............................................................................................23
Preferences – Directory ..........................................................................................................24
Preferences – Advanced..........................................................................................................25
A Dial Plan....................................................................................................................................27
B Contact List Headings...............................................................................................................35
C Glossary.....................................................................................................................................37
1
CounterPath Corporation
2
1 Overview
This manual is intended for:
• “Retail” users. You are a retail user if you are working in a non-office environment and you are your own
system administrator.
• System administrators who have purchased Bria 3 for Linux from the CounterPath website and are
deploying it for use by the staff in an enterprise. The staff are considered “enterprise users”. The
administrator should be familiar with PBX solutions, telephony and VoIP telephony.
You can deploy Bria by manually configuring via the softphone GUI, or using a provisioning server. If you are
planning to implement provisioning, you must also read:
• “Bria 3 Provisioning Guide - Retail Edition”
For more information on the documents you should read, go to http://www.counterpath.com/bria.html, click
Resources, and read the “Bria 3 for Linux Administrator Orientation”.
1.1 System Requirements
System Requirements
Hardware Requirements
• 1 Ghz processor or faster.
• 256 MB RAM.
• 20 MB free disk space on your hard drive.
• Internet connection - broadband is best (GPRS is not supported for voice calls).
• Microphone and speakers or headset. Headsets with built-in AEC are recommended.
Software Requirements
• Qt 4.4.0
• libasound2 1.0.18
•Gconf 2.2
• PulseAudio 0.9.16 (optional)
• Ubuntu 10.04.
1
CounterPath Corporation
1.2 Multimedia Device Requirements
Bria requires both speakers and a microphone to make calls. Any of the following are acceptable:
• External speakers and microphone
• Built-in speakers and microphone
• Dual-jack multimedia headset
• USB multimedia headset
• USB phone.
2
Bria 3 for Linux Administrator Guide
1.3 Deploying through Manual Configuration: Recommended Procedure
If you have chosen to manually configure Bria and will not implement remote provisioning, read this entire
manual.
If you are a service provider, you should be aware that if you deploy through manual configuration then users
do not log in, which exposes your service to abuse and may compromise the user’s privacy.
Configuring Bria: Administrator Steps
The general procedure is:
1. Install and start Bria. The Bria Login dialog appears with the Profile set to “Manually enter login server”.
Set the profile to “No login required” and click Continue. The softphone appears.
2. Configure Bria to work on your network and with your services. Use the Account Settings window
(Softphone > Accounts) and the Preferences window (Softphone > Preferences.
The rest of this manual describes this configuration.
3. When you are satisfied with the configuration, deploy to your employ ees or users.
4. Then either configure the application for each employee, or provide them with a list of settings so th at they
can configure it themselves.
Instructions for your Users
Because you are not provisioning Bria, your users do not need to log on. Instruct your users to start Bria as
follows:
• The first time the user starts Bria, the Login dialog appears.
• The user should set the profile to “No login required” and click Continue.
Bria will start and the user can configure the softphone. The next time the us er starts Bria, the Login dialog will
not appear: Bria will start immediately.
3
CounterPath Corporation
1.4 Deploying through Remote Provisioning: Recommended Procedure
Configuring Bria: Administrator Steps
If you are deploying through remote provisioning you will need to start Bria without provisioning in order to
explore configuration options.
1. Install and start Bria. The Bria Login dialog appears with the Profile set to “Manually enter login server”.
Set the profile to “No login required” and click Co ntinue. The softph one GUI appe ars. From now on , when
Bria starts, the Login dialog will not appear.
2. Manually configure Bria to work on your network and with your services. Use the Account Settings
window (Softphone > Accounts) and the Preferences window (Softphone > Preferences.
The rest of this manual describes this configuration.
3. When you are satisfied with the configuration, see the “Bria 3 Provisioning Guide - Retail Edition” for
information on setting up your users for remote logi n and remote provisioning.
4. In addition, just before you deploy across your enterprise, change the setup for your own Bria to follow the
correct login procedure:
• Start Bria, go to the Preferences > Application page and check Enable login screen.
• Shut down Bria and restart. The Login dialog will appear.
• Choose “Manually enter login server” and complete the other fields. Click OK.
4
Bria 3 for Linux Administrator Guide
Using the “No Login” Profile
If you ever need to start Bria without logging in:
1. Go to the Preferences > Application page and check Enable Login screen.
2. Restart Bria. The Login dialog will appear.
3. Choose “No login required” and click OK.
Bria will start, using the local version of the configuration data that is saved on your computer (from the
first time you used Bria without logging in).
Keep in mind that when you are supp orti ng remot e provisioning, starting Bria without logging in is intended to
allow you, the administrator , to experiment wi th login opti ons. It is not inten ded to allow u sers to skip login , for
example, by displaying the Login dialog and choosing the “No login required” option.
If a user first logs in and then later changes to “No login required”, Bria will start but none of the user’s account
credentials or account settings will be available, so Bria will not be usable.
Instructions for your Users
1. When the user starts Bria, the Login dialog appears.
2. The user should set the profile to “Manually enter login serv er”.
3. The user should complete the remaining fields (with information you have provided to each user, perhaps
through an e-mail) and click OK. Bria will start. From now on, the Login dialog will appear at each startup.
5
CounterPath Corporation
2 Configuring Bria
2.1 Configuring Accounts
Each user will need at least one SIP account. Each account requires the following information:
•User name
• Password
• Authorization Name (if applicable; see page 10 for information)
•Domain
Procedure
1. From the Bria menu, choose Softphone > Account Settings. The Account list appears.
2. Choose Add; the SIP Account window appears.
3. Enter the User Details and then change or complete all other fields. See “Account Configuration
Reference” on page 9 for details.
4. When done, click OK. The account is created and registered.
6
Bria 3 for Linux Administrator Guide
2.2 Configuring Global Settings (Preferences)
Use the Preferences window (Softphone > Preferences) to configure features that apply globall y, rather than on
a per-account basis. The panels that you, as the system administrator, should set are:
• Network. You should complete these fields to suit your network.
• Audio Codecs. You should enable the codecs that are suitable to your environment.
• Quality of Service. If your VoIP service provider supports QoS, you can configure Br ia for it.
• Directory. You can set up a company directory on a server and connect Bria to it via the LDAP protocol.
The directory will appear in the Directory tab. Information in this tab will update automatically whenever
the information on the LDAP directory changes.
• Advanced.
See “Preferences Reference” on page 19. For information on the pa nel s tha t are no t di scusse d in this guide, see
“Bria 3 for Linux User Guide”.
2.3 Setting up Contacts
Typically, users will want to create contacts in order to easily make phone calls. In addition, in order to send
IMs, shared online information and transfer files, contacts are required.
Contact Storage
You can set up Bria so that contacts are only stored locally on each user’s computer, or both locally and
remotely on a WebDAV or XCAP server. See page 14.
Populating the Contact List
You may want to provide an initial contact list for users who are using Bria. You can:
• Provide a file that users can import. See below.
This option makes sense if users will be set up to store their contacts locally or on a WebDAV or XCAP
server. It cannot be used if users will be set up to use the Outlook address book for contacts.
• Create an LDAP directory and set up users to connect to this directory. Once Bria is connected to the
directory, the directory contents appear in the Directory tab (alongside the Contacts and History tabs) and
users can choose to create a contact from any entry. See page 24.
Importing Contacts
You can provide a file (for example, the company contact list) that each user can import as desired. The import
file can be:
• A comma-separated file. Use this method to import from a Microsoft® Excel® file. You will first have to
set up the file; see below.
• A vCard file (*.vcf file). A vCard is an electronic business card that is often attached to an email.
Setting up an Excel File for Import
1. Remove any introductory text or headings from the top of the file. (You can keep text at the end of the file;
it will be ignored during the import.)
7
CounterPath Corporation
2. Insert a blank row as the first row. In this row, type the headings that Bria will use to interpret the meaning
of each column. The columns can be in any order. Key headings are:
• uri. Bria recognizes a value in this column as a soft phone address a nd considers t he address as one that
can be phoned.
• display-name, entry_id, given_name, surname
• business number
For a complete list of headings, see page 35.
3. Save the file as *.csv.
2.4 Managing Licenses
When you obtain Bria, you purchase a license with a specified number of seats. Each time a user enters the
license key, the license count is drawn down on the CounterPath license database. When the count is drawn
down to 0, then the next time the key is entered, an error message appears for that user.
You can either increase your license count or revoke unused seats. To revoke seats, go to ww.counterpath.com,
click the Store link, click the Your Account link, and log in.
Users on the same computer can use the same license but they all need to enter it first time they run the client
(the key is saved to own home folder so other users cannot read it).
Therefore, if you seem to have drawn down more license counts than expected, the problem may be that one or
more guests have used seats. You can request that CounterPath revoke these licenses in order to reinstate the
number of seats actually in use.
Setting up for the Licensing Server
Periodically, Bria connects to CounterPath’s license server in order to verify that a valid license is being used.
Therefore, at all times, Bria will need to have an internet connection.
Bria connects to https://secure.counterpath. com via port 443; make sure your firewall allows this HTTPS traf fic
to this URL.
8
3 Account Configuration Reference
The Account Settings window lets you configure features that apply on a per-account basis. (The preferences
window lets you configure features that apply across all accounts.)
1. Choose Softphone > Account Settings from the menu. The Accounts list appears.
2. Edit an existing account or create a new one. The Account Settings window appears.
9
Loading...