SARK V4.0.1 Debian install

From sailpbx
Jump to: navigation, search

back to SARK v4.0.0 contents

SARK 4.1.0 Wheezy Install

This page assumes a new install.

Proceed as follows;

Log in to the linux console on your sail box and run the following

apt-key add sail.gpg.key
echo deb wheezy main >> /etc/apt/sources.list
apt-get update

Installing a Mail agent

You can use whatever mail agent you like on your server. Exim, sendmail, whatever is your favourite. SARK has on-board support for a lightweight mail agent called ssmtp. If you install it then sark will provide a tab in the networking section for you to configure it. Install it now (so that SARK can set the correct perms) with...

apt-get install ssmtp

There is a setup guide for Asterisk vmail to email HERE

Installing SARK/SAIL

apt-get install sail

The install will take a good few minutes depending upon the speed of the donor box and your internet link. During the install you will be asked to enter a root password for MySQL (make a note of it, you'll need it later). You will also be asked to enter the international dial code (IDD) for your country. For example, if you are in the UK, this would be 44.

Let the install run to its conclusion.

Seed the CDR database

Now you can seed the Asterisk MySQL CDR database with the following command (substitute the MySQL root password you gave during the sail installation).

mysql -u root --password={your mysql root password} < /opt/sark/stat/asterisk-stat-v2/cdr-mysql-setup.sql

Install PHP GD Library

SAIL's Jpgraph reporting engine needs the PHP GD library to display graphs. Install it with:

apt-get install php5-gd

Create the missing folders

mkdir -p /var/lib/asterisk/firmware/iax
chown -R asterisk:asterisk /var/lib/asterisk/firmware

Upload a favicon

Create a favicon.ico file in your favorite icon editor or online and upload it to /opt/sark/www folder.

chown www-data:www-data /opt/sark/www/favicon.ico

Install Asterisk extra sounds package

SAIL requires the Asterisk extra sounds package. If you want UK English, there is a deb on the repo

apt-get install ast-en-gb-gpl-gsm-sounds

If you want "Alison" (US American), there is no deb available for this but it's pretty easy to install. At the linux CLI do the following

cd /usr/share/asterisk/sounds
tar xvfz asterisk-extra-sounds-en-gsm-current.tar.gz
rm asterisk-extra-sounds-en-gsm-current.tar.gz

Clean up

You're done - reboot it


a2dissite 000-default
service apache2 reload

your sail app will be at http://your.server.ip.address

  • UID - admin
  • PWD - sarkadmin

Close your browser and re-open it if you were previously running an earlier version of sail. If you don't, you'll get odd looking output as the cached jquery code fights with the new 4.1 output. Dump the dialplan in use with:

asterisk -rx "dialplan show" > dialplanlist.txt
  • Customise Initial page - When we login to the sail app we get to a blank page with just the menus. Refer this post for customisation or edit the support.htm file in this pre-packaged set of changed files and upload to /opt/sark/www folder.

OK, you're done; unless of course you'd like to run the new ldap directory feature in 4.1, in which case read on...

LDAP install

Assuming LDAP is not already installed on your SARK/SAIL box, proceed as follows;

Open the SARK browser app and navigate to the network panel. Turn OFF the checkbox "Use DHCP to obtain an IP address?:" and enter a domain name into the domain name field. You can also allocate a fixed IP address and DNS information at this point if you wish but you MUST enter a domain name. Doesn't matter what domain you choose, as long as it follows the rules for correct domain name formation. This is necessary because the Debian LDAP installer will use this name to create the LDAP Base dn. If you DON'T do this then you'll end up needing to reconfigure ldap after the install and it will get messy so don't say we didn't warn you.

V4 globals domain.png

In our example we've used a domain of

If you are on an OpenVZ container, you will not be able to change the domain name as it is set in the container's conf file in the host machine.

OK, save the information you've entered and reboot your box.

Now you can install ldap

apt-get install slapd ldap-utils

The installer will ask you to provide an admin password for LDAP, make a note of it; you'll need it shortly and whenever you want to do any other stuff with ldap in the future.

Check the LDAP Base Name (Base DN)

You can check by running slapcat as follows:-

root@deb8ct-test2:~# slapcat
dn: dc=nodomain
objectClass: top
objectClass: dcObject
objectClass: organization
o: nodomain
dc: nodomain

The base name appears in the first line of output. In the above example it is "dc=nodomain". We've used "nodomain" as an example because you'll likely see it a lot, particularly when you are spinning up LXC instances and the like. It just means that LDAP couldn't find the FQDN, probably because it wasn't set. It's no big deal, you can just go ahead and use dc=nodomain if you like. In any event, you should enter whatever YOUR base name is into the Globals=>LDAP panel along with the LDAP password you chose during the install.

If "dc=nodomain" bothers you then you'll need to enter a domain name in SARK, issue a commit and then do a reconfigure for slapd (the LDAP daemon).

dpkg-reconfigure slapd

This will allow it to have another look.

Adding the contacts OU

Once LDAP is installed you need to add an organizationalUnit(ou) for your address book. If you are already a whiz with ldap then just go ahead and do it, using a base dn the same as your domain name. If you don't know ldap then proceed as follows...

You will find a file on your SARK box at /opt/sark/cache/ldapcontactou.ldif

dn: ou=contacts,dc=sark,dc=aelintra,dc=com
objectClass: organizationalUnit
objectClass: top
ou: contacts

Without getting into the details (you can read about ldap elsewhere), in the first line of the file is the name of the organizationalUnit we want to create. In our example it is "contacts", if you are unfamiliar with ldap, then leave it as that. The remainder of the line (dc=sark,dc=aelintra,dc=com) is called the base dn. Debian builds the base dn automatically from the domain you provided earlier so you must make yours match your domain name. If, for example, you used a domain name of then you should make your file look like this

dn: ou=contacts,dc=splodge,dc=soap,dc=com
objectClass: organizationalUnit
objectClass: top
ou: contacts

Ok, lets add it, we are going to use the LDAP slapadd utility, which is old fashioned nowadays, but easy to use.

/etc/init.d/slapd stop
slapadd -l /opt/sark/cache/ldapcontactou.ldif
/etc/init.d/slapd start

Almost done. Navigate to the SARK browser app and open the Globals page. You will see a new tab called LDAP. Click on it and enter the details for your LDAP database. You'll need the password you provided when you installed LDAP.

V4 globals ldap.png

Issue a commit and you're done.

Refresh your browser and navigate to SARK. You should see a "Directory" option when you click on the "System" drop-down. In this page you can add and modify your telephone book entries and have your phones browse them. You'll need to add a couple of entries to your SARK firewall for TCP ports 389 and 686 (restrict them to net:$LAN) to allow the phones to query the database. Here's how we've added ours (see the last line) - don't forget to restart the firewall.

V4 firewall ldap.png

Set up your phones to use LDAP

Most major SIP Phone types can use LDAP however, the implementation varies from type to type.

Snom and Yealink both support LDAP and both have on-board provisioning already set-up for openLDAP on SARK.

Cisco small business phones (SPA) support LDAP and Provu have a section on their website showing how to set them up

Polycom phone set-up is more complex (isn't it always?), however there is good documentation provided by Polycom so you should be able to get it running with a little work although we don't show it here.

Aastra's do not natively support LDAP. However, it is possible to program it in using their XML capabilities and a php server stub. There is documentation elsewhere on the web detailing how to do it.

Panasonic phones do not currently have LDAP directory support.

Gigaset professional (N series) phones support LDAP and there is documentation on their website