Kerio Operator Getting Started Guide 2011 Kerio Technologies. All rights reserved. 1 About Kerio Operator Kerio Operator is a PBX software for small and medium business customers. Kerio Operator is based on VoIP technology internally but it also supports the standard telecom interfaces such as ISDN BRI and ISDN PRI (also known as T1 or E1). This version of Kerio Operator is provided as software but there are plans for hardware versions in the future. 2 Why Kerio Operator Before, a PBX was a mystery box on the wall. Today, it is a server in the server rack. Before, the PBX required a phone guy. Today, it is administered by an IT guy with the same ease as any other Kerio product. Despite the migration to IP-based technology, voice remains a mystery to many IT administrators, who want nothing to do with deploying or managing a PBX. We envision a phone system that integrates tightly with your other IT systems so that you know everything about everything when the phone rings. 3 Installation Kerio Operator is distributed in the form of a VMware appliance and as an installation CD image. Virtual Appliance To run the virtual appliance, you need VMware Workstation, VMware Player, or VMware Server. The appliance uses bridged networking. If you have a computer with several network interfaces, please disable VMware bridge protocol on the interfaces that should not be used by the appliance. Installation CD Image To create the Kerio Operator installation CD, download the image (.iso) file and then use your preferred CD burning software to burn the installation disk. The computer you install Kerio Operator on needs to meet the following minimum HW requirements: Processor: Celeron 1 GHz Memory: 512 MB 1
Hard disk drive: 8 GB Connectivity: 1 Ethernet card Optionally, you can have a Digium B410P card to connect to a BRI ISDN line or a Digium TE122 card to connect to a PRI ISDN (aka E1/T1) line. Kerio Operator contains its own operating system so the PC you choose to install Kerio Operator on does not need to have an operating system. Warning: The installer will delete all partitions on the target hard disk and create new partitions as needed for Operator. If the disk contains some valuable data, make sure you back it up before installing Operator! Notes The following notes apply to both the virtual appliance and Kerio Operator running on a physical HW: Kerio Operator is configured to request an IP address via DHCP. You need to have a DHCP server in your network. If you do not use a DHCP server, please set IP address manually choose IP configuration in the appliance s console menu, set DHCP to no and fill in the IP address, network mask, gateway address, and DNS server address. Kerio Operator s text console displays the administration URL. Open this URL in your web browser to configure Kerio Operator. As a first step, you will be asked to set up a password for the administration account. The administrator s user name is Admin. To access the text console s menu, you need to enter Admin s password. Until you configure it in the administration interface, the password is empty. To shutdown or reboot Kerio Operator, simply select the appropriate option in the text console menu. To access console shell, press Alt+F2. Press Alt+F1 to return to the console menu. To access the shell, you need to log in as root. The root password is the same as the Admin s password. Security Kerio Operator implements a simple firewall. If you connect Kerio Operator to public Internet, please make sure that you activate the firewall and set the IP addresses that are allowed to access Kerio Operator. You should start your instance of Kerio Operator for the first time in a safe network (your LAN) and connect it to the public Internet only after you set a strong administration password and configure the firewall properly. 2
4 Communication Kerio Operator uses the SIP VoIP protocol. To test the Kerio Operator, you will need one or several SIP phones (hardware or software). In order to place or receive external calls, you will also need: An SIP account from an SIP provider. There are many offerings on the market, especially from the alternative telco companies. See the Kerio Operator s beta forum for hints about how to configure Kerio Operator to work with particular providers. Alternatively, you can use a second SIP server and place calls between extensions on Kerio Operator and users registered on the second SIP server. In addition to SIP, Kerio Operator also supports ISDN connectivity. To use it, you need to have a supported card: Digium B410P for BRI ISDN or Digium TE122 for PRI ISDN (aka E1/T1). 5 Web Interfaces Kerio Operator provides two web interfaces: The Administration interface and the User interface. Both interfaces can be accessed via either the HTTP protocol or its secure variant HTTPS. Both interfaces support the following browsers: Firefox 3, Firefox 3.5, Firefox 3.6, Internet Explorer 7, Internet Explorer 8, Safari 4 and 5 (other browsers may work as well but are not tested during development). The web interfaces are currently available in English and Czech. You can switch the language in the upper right corner of the window. The default interface language setting is Automatic which uses the preferred language as configured in your browser. The Administration interface can be accessed at http://operator-ip-address/admin/ or https://operator-ip-address/admin/ please replace the string operator-ip-address with the actual IP address assigned to your Kerio Operator appliance. Likewise, the User interface (also called MyPhone) can be accessed at http://operator-ip-address/ or https://operator-ip-address/ When you access the Administration interface for the first time, you will be asked to enter your administrator username and password. We recommend that you choose a strong password if you ever plan to connect Kerio Operator to an insecure network. You can change the administration password once you log into the Administration interface. The administrator appears among other users in the Users grid. To access the User interface (MyPhone), you first need to configure at least one user account (in the Users grid) and assign a user name and password to it. This is the list of known issues: The Auto Attendant script editor is not yet as user friendly as we would like it to be (ideas welcome). Product/Trial registration is not yet working. 3
6 Quick Configuration How-To This section is a brief step-by-step guide. Once you do the configuration steps described below, you will be able to place test calls. We assume that the Kerio Operator appliance is running and you can access the Administration interface using a web browser. Configuring Extensions In the Administration interface, go to the Configuration Users section and add one or several user accounts: 1. Click on the Add... button a dialog for adding a new user opens. 2. In the dialog, fill in the login name, password and PIN. The login name and password are used to access the User interface and to register the user s phone. The PIN is used to access the voicemail. 3. Optionally, fill in the user s full name and email address. 4. Switch to tab Extension and click Add... In the Add Extension dialog, fill in the extension number (or keep the one proposed by Kerio Operator) and SIP password. 5. Press OK in the Add Extension dialog and then again in the Add User dialog. 6. Configure your SIP phone to register with Kerio Operator: Set the SIP server (registrar or proxy) address to the Kerio Operator s IP address. Set the phone s number to the extension number you have configured in step 4 above. In some SIP phones, you will need to enter your extension number into the User name or Name field. Set the Authentication name to the extension number. On some SIP phones, the authentication name is denoted as Authentication ID or Authorization name. Set the Password to the login name and password you have configured in step 4. 7. Check the Configuration Extensions section to see if the phone is registered. Refresh the view if necessary. Repeat steps 1 through 5 to register additional extensions. Configuring external SIP connectivity In this section, we assume you have an account with an SIP provider (a company that provides SIP telephony services). You need to know the following information: The telephone number assigned to you by the SIP provider (For simplicity, we assume you have a single number, not a range of numbers). The address of the provider s server (SIP registrar or proxy). The authentication name and password assigned by the provider. With some SIP providers, the authentication name is the same as the telephone number. You can configure the external connectivity taking the following steps: 1. In the Kerio Operator s Administration interface, go to section Configuration Call Routing. 2. Click the Add SIP interface... button. A window with a configuration wizard opens. 4
3. Enter the name of the interface. Use a descriptive name that will help you to identify the interface. The interface name should not contain spaces. 4. Choose the New provider option and fill in the telephone number you have received from the SIP provider. Click the Next button. 5. Now, configure rules for routing incoming and outgoing calls. Choose the extension that should receive incoming calls. Enter the prefix that you want to use to dial out, for example 0 or 9. 6. Press the Next button. 7. Enter the address of your provider s SIP proxy or registrar, and enter your authentication name and password. With most providers, you will also need to check the option Must register with the registrar or proxy. 8. Press the Finish button. Kerio Operator will now create a new SIP interface and rules for handling incoming and outgoing calls. In case you experience difficulties when configuring the external SIP connectivity, you can use the simple built-in packet sniffer to diagnose the problem. The sniffer is available under Configuration System Network. After you capture the communication, download the file and open it in Wireshark or similar tool. Configuring connection to another SIP server If you do not have an account with any SIP provider, you can test Kerio Operator against another SIP server in your own network. The configuration is similar to the previous case. 1. In the Kerio Operator s Administration interface, go to the Configuration Call Routing section. 2. Click the Add SIP interface... button. A window with a configuration wizard opens. 3. Enter the interface name. Choose the Link to another PBX option. Click the Next button. 4. In the next screen, enter the prefix you want to dial to reach the second SIP server. Again, press Next. 5. Fill in the server s address. 6. The second SIP server may or may not require authentication, so enter the authentication name and password only if needed. 7 Configuring E1/T1/EuroISDN Connection If you install Kerio Operator on a computer with one of the supported telephony cards, Kerio Operator will auto-detect the card and will display it among the interfaces in the Call Routing screen. You can then finish the configuration of the card by setting up call routing according to your needs. Please note that when setting up external phone numbers, you can work either with a single phone number, an interval of numbers, or a list of individual telephone numbers. Since the B410P card has 4 basic rate interface ports on it, it will be shown as 4 interfaces in the Call Routing screen. 5
8 Phone Provisioning Kerio Operator contains a preliminary support for automatic configuration (also known as provisioning) of certain hardware SIP telephones. The following phones are supported: Cisco 7940 and 7960 with SIP firmware version 3 and above Linksys SPA901, SPA922, SPA942, SPA962, PAP2T, SPA504G and SPA525G with firmware version 5 and above. Snom 300, 360, 820, M3 and MeetingPoint. To use the automatic phone configuration, you will need a DHCP server (DHCP stands for Dynamic Host Configuration Protocol). The DHCP server must support DHCP option 66 the TFTP server address. You should set this DHCP option to Kerio Operator s IP address. (The DHCP server integrated in Kerio Control supports the option 66). The automatic configuration process works as follows: 1. The SIP telephone boots up and sends a DHCP request asking for an IP address. 2. The DHCP server receives the request, assigns an IP address and sends the address in a DHCP response message. Along with the IP address, the response also contains a TFTP server address (as mentioned above, this should be the Kerio Operator s IP address). 3. The SIP telephone contacts the TFTP server that is integrated in Kerio Operator. 4. Kerio Operator checks whether the telephone is new. If the phone is new, Kerio Operator will generate a new extension number for the telephone. Alternatively, the phone will just appear in the list of provisioned telephones and you can assign an extension to it yourself. If the phone is not new, Kerio Operator will find the extension that has already been assigned to the telephone. 5. Kerio Operator generates a configuration file that is appropriate for the given phone type and sends it to the telephone via the TFTP protocol. 6. The telephone configures itself using the configuration values it has just received and is ready to be used. Configuring the Phone Provisioning The configuration screen for provisioning is available in the Configuration Provisioned Phones section. The provisioning is enabled by default. There are two fields at the top of the configuration screen: First extension number. If this number is 10, Kerio Operator will assign extension 10 to the first configured phone, 11 to second, etc. If a number is in use (e.g. assigned to a manually created extension), it will be skipped. Create new extensions for newly registered phones. Check this if you want to automatically assign an extension number to each newly registered phone. If you leave this option unchecked, the new phone will appear in the list and will wait till you assign an extension to it. Password for phones. This is the SIP password that will be used by the provisioned phones. 6
The rest of the configuration screen is occupied by a grid that lists provisioned phones (i.e. phones automatically configured by Kerio Operator). You can add, edit, or remove the provisioned phones. Adding a phone When adding a new phone to Kerio Operator, there are two options: Simply connect the phone to your LAN. The auto-config mode is usually the factory default, so the phone should be configured automatically as detailed above in the automatic configuration process description. With a brand new phone, the automatic configuration can last up to one minute so please wait a while and then refresh the list to see the newly added phone. Add the phone manually before you start it for the first time. This can be useful if you want to prepare the configuration for the phone before the user plugs it in. If you want to enter data for a larger number of phones, you can import the data from a CSV file. An example CSV file is as follows: 00:00:00:00:11:22;Cisco;79XX;10;12 00:00:00:00:11:23;Cisco;79XX;15 00:00:00:00:11:24;Linksys;SPA942;11;14 The fields are as follows: phone s HW address; make of the phone; phone type; extension 1; optional extension 2;...(The number of extensions must not exceed the maximum number supported by the particular phone type). Editing phones Probably the most frequent activity in the phone edit dialog will be adding an extension to a phone or removing the extension. You can also move an extension from a phone to another one. Removing phones If you remove a phone from provisioning, the configuration will be deleted from the phone and the automatic configuration will be disabled on it. This prevents the phone from asking for a configuration again once it restarts. Should you need to return the phone to automatic configuration again, you need to go the phone s menu and re-enable the provisioning feature there. 9 Directory Service Integration It is possible to connect Kerio Operator to Active Directory or Apple Open Directory. You will find the dialog under Configuration Advanced Options Directory Service in the Administration interface. Once you connect Kerio Operator to the directory service server, users will be authenticated against the directory service when they log in to the User interface. Also, Kerio Operator will read user data (user name, full name, email address) from the directory service server. After you configure the directory service connectivity, the screen Configuration Users will allow you to either add local users or add (or activate) users from the directory service. 7
10 Emergency numbers You will find the definition of emergency numbers under Configuration Emergency numbers in the Administration interface. Calls to emergency numbers will always be allowed regardless of the configuration of call rights. You can add or remove individual emergency numbers manually or choose a predefined list of numbers for a particular country (only United States, Slovakia, and the Czech Republic are currently available). Additionally, you can activate direct dialing of emergency numbers. This means that people can skip the dial-out prefix when calling the emergency service they simply dial 911 (or another emergency number like 112 in the EU). When enabling the direct dialing, you must choose at least one outbound route that will be used for the emergency calls. Note: Do not test this feature by calling real emergency numbers! You can always add some non-emergency number to the list like your cell phone number add call this safe number instead. 11 Feedback Kerio Technologies is eager to hear your opinion on Kerio Operator. Also feel free to report any errors or difficulties that you may encounter. 12 Open Source Software Notice Kerio Operator includes open source software. The complete open source code packages of these components are available in Kerio Software Archive at http://download.kerio.com/archive/. 13 Legal Notices Cisco and Linksys are registered trademarks of Cisco Systems, Inc. Digium is registered trademark of Digium, Inc. snom is registered trademark of snom technology AG. VMware is registered trademark of VMware, Inc. Active Directory is registered trademark of Microsoft Corporation. Open Directory logo is trademark of Apple Inc. 8
www.ognelis.ru