Standard installation

This method describes how to install OdooPBX on a Linux server.

Also the previous step System requirements must be done.

OdooPBX has the following components:

  • Odoo & PostgreSQL

  • Asterisk PBX

  • The Agent.

Let review them in more details.

All-in-one demo

Below commands will install a full all-in-one demo system:

pip3 install odoopbx
salt-call state.apply full

The Agent

This is where all starts. To start your OdooPBX journey you must first install the OdooPBX Agent.

The Agent does the following jobs:

  • Forwards Asterisk events to Odoo according to the downloaded events map.

  • Executes Asterisk actions received from Odoo.

  • Protects Asterisk from DDoS and password bruteforce attacks.

  • Manages the installation & upgrade process.

The Agent itself is built upon the Saltstack platform. So if you come the Salt world - welcome home, dude!

The Agent uses Salt states files to install different OdooPBX components. The following components are available:

  • odoo - Odoo server.

  • addons - Public OdooPBX modules.

  • postgres - PostgreSQL database.

  • agent - Salt minion, api and master processes.

  • asterisk - Asterisk PBX server.

  • nginx - the Nginx proxy server.

Note

Please note that the Agent requires root privileges. The commands below must be run as the root user.

To install a compoment the following command is used:

salt-call state.apply agent
salt-call state.apply odoo
salt-call state.apply addons
salt-call state.apply asterisk
salt-call state.apply nginx

To install all compoments use this:

salt-call state.apply full

Different components can be installed into different servers and be interconnected easily.

But it’s not a good idea to put all eggs in one busket, especially the PBX egg that is actually a real-time application that likes dedicated resources.

So the most common setup uses two servers:

  • 1: Odoo, PostgreSQL, Nginx.

  • 2: Asterisk, The Agent.

The best place to install the Agent is the same server where Asterisk runs because in this case it has direct access to local file system and can access call recordings.

If you don’t need call recordings in Odoo you can setup the Asterisk agent on a different computer but it is advised to place it at least near the Asterisk server. But depending on your company size you can also have your Asterisk in America and Odoo in Europe datacenter.

Odoo installation

If you don’t have Odoo installed you can use the Agent to deploy Odoo on the current host. .. code:: sh

salt-call state.apply odoo

This will install Odoo in a system wide python path with configuration file in /etc/odoo/odoo.conf.

You can start Odoo with:

systemctl start odoo

To see the Odoo log do:

journalctl -u odoo -f

Odoo configuration

Odoo should be configured in the right way in order to be ready for Asterisk Plus.

When the Agent is used to install Odoo all is setup automatically by it. Read below only if you have your own Odoo server deployed somewhere.

Workers

Workers are Odoo processes that handle requests.

Asterisk modules make many short-running requests.

So your Odoo should be configured with at least 2 workers (but 4 workers is the minimal recommended starting value).

Warning

If you use odoo.sh with 1 worker configured it is possible to get issues related to performance.

Long polling

Internal gevent-based server must be enabled (aka long polling) for popup notifications and live channels reload to work.

When you enable workers gevent server is also enabled.

By default port 8072 is used and you can check it with:

netstat -an | grep LISTEN | grep 8072

on your Odoo server.

If you don’t use a proxy (apache / nginx / etc) then you should open Odoo on gevent’s port e.g.: http://127.0.0.1:8072/web.

If you run Odoo behind a proxy be sure to add a different proxy handler for the /longpolling/poll URL.

Here is a snippet for Nginx:

location /longpolling/poll {
  proxy_pass http://127.0.0.1:8072;
}

If you see Exception: bus.Bus unavailable in your Odoo log then it means you did not set long polling right.

Single / multi database setup

There is one thing your should know.

It’s a good configuration when your Odoo is limited to just one database with dbfilter configuration option and list_db set to False.

But when you run Odoo with multiple databases some special configuration must be enabled.

You should add asterisk_plus to server_wide_modules parameter in order to be able to make CURL requests from the Asterisk dialplan (see below).

Here is an example of such a configuration line:

server_wide_modules = web,asterisk_plus

If your Odoo is in a single-mode setup there is no need to configure the server_wide_modules parameter.

Addons

To install the OdooPBX public addons use:

salt-call state.apply addons

Or follow this instruction to copy OdooPBX addons to your custom Odoo server.

Install addons in the same way you install any other Odoo module.

Do a database backup before installation or upgrade and also make a backup of previous version of the module if you have it (just in case to be able to restore quicky).

Make sure that addons_path is set correctly to include OdooPBX addons.

The module dependencies are localed in requirements.txt file located in the addons folder.

If you use odoo.sh make sure you copy the requirements to your modules top folder so that odoo.sh can install the required dependencies.

If you use python virtualenv make sure you install the requirements there and not system wide.

Asterisk

To install Asterisk on the current server run:

salt-call state.apply asterisk

This will build Asterisk from the sources and also create default OdooPBX related configuration files.

If you use your own Asterisk server read the below instuction.

Prepare an Asterisk Manager Interface (AMI) account to allow the Agent to connect to Asterisk.

Vanilla Asterisk requires editing the manager.conf file, which is usually found in /etc/asterisk.

A sample configuration is provided below, which lets the Agent to connect to your Asterisk server AMI port (usually 5038) using the login odoo with the password odoo.

manager.conf:

[general]
enabled = yes
webenabled = no ; Asterisk calls does not use HTTP interface
port = 5038
bindaddr = 127.0.0.1

[odoo]
secret=odoo
displayconnects = yes
read=all
write=all
deny=0.0.0.0/0.0.0.0
permit=127.0.0.1/255.255.255.0

Asterisk-based distributions such as FreePBX offer a web GUI interface for managing your AMI users. You can use that interface to create one, or you can add the account configuration data in a custom file, which will not be managed by the distro, usually /etc/asterisk/manager_custom.conf

Warning

For security reasons always use deny/permit options in your manager.conf. Change permit option to IP address of your Asterisk server if agent is not started on the same box.

Make sure that you applied new configuration by checking the Asterisk console:

manager show user odoo

The Agent Configuration

The Agent local configuration file is located in /etc/salt/minion_local.conf.

The defaults are located in /etc/salt/minion.d/odoopbx.conf.

When you add an option to the local configuration it overwrites the default value.

Odoo settings

First configure the Agent’s connection to Odoo:

odoo_host: odoo # Put IP address or hostname here.
odoo_port: 8069 # If your Odoo is behind a proxy put 80 or 443 here.
odoo_user: asterisk1 # It's ok to leave the default user name.
odoo_password: asterisk1 # This is the default password set on addon installation. CHANGE IT!!!
odoo_use_ssl: False # Set to true if your proxy servers HTTPS requests.
odoo_db: odoopbx_14 # Put your database here

Asterisk AMI settings

Configure the Agent for Asterisk connection. Make sure you applied the Asterisk manager configuration first.

Once you are sure the Odoo AMI user is operational add the following options to configure the Agent’s connection to your Asterisk:

ami_host: 127.0.0.1
ami_port: 5038
ami_login: odoo # Put here AMI user name you created in manager.conf.
ami_secret: odoo # Put here AMI user password.

Check /etc/salt/minion_local.conf to check that everything looks like expected.

Agent test run

salt-minion -l info

Check the output printed on the screen. There should be no errors on start. You should see messages that confirm both Odoo connection and Asterisk connection as shown below:

[INFO    ] salt.loaded.ext.engines.odoo_executor:48 Logged into Odoo.
* * *
[INFO    ] salt.loaded.ext.engines.asterisk_ami:69 AMI connecting to odoo@127.0.0.1:5038...
[INFO    ] salt.loaded.ext.engines.asterisk_ami:72 Registering for AMI event *

Now stop it with CTRL+C and run it as a service:

systemctl start salt-minion

Asterisk Dialplan configuration

Asterisk Plus exposes additional functionality by providing the following controllers:

  1. You can get the contact’s name by accessing asterisk_plus/get_caller_name?number=${CALLERID(number)}

  2. If the Contact for the phone number has a manager set, use asterisk_plus/get_partner_manager?number=${CALLERID(number)} to get the manager’s number

  3. You can get the Contact’s tags by using /asterisk_plus/get_caller_tags?number=${CALLERID(number)}

Here are some examples of integration, using Asterisk dialplans.

extensions.conf:

[globals]
ODOO_URL=http://odoo:8069

; Set connection options for curl.
[sub-setcurlopt]
exten => _X.,1,Set(CURLOPT(conntimeout)=3)
exten => _X.,n,Set(CURLOPT(dnstimeout)=3)
exten => _X.,n,Set(CURLOPT(httptimeout)=3)
exten => _X.,n,Set(CURLOPT(ssl_verifypeer)=0)
exten => _X.,n,Return

; Partner's extension click2call e.g. +1234567890##101
[post-dial-send-dtmf]
exten => s,1,NoOp(DTMF digits: ${dtmf_digits})
same => n,ExecIf($["${dtmf_digits}" = ""]?Return)
same => n,Wait(${dtmf_delay})
same => n,SendDTMF(${dtmf_digits})
same => n,Return


;Set Caller ID name from Odoo
; Get caller ID name from Odoo, replace odoo to your Odoo's hostname / IP address
; Arguments:
; - number: calling number, strip + if comes with +.
; - db: Odoo's database name, ommit if you have one db or use dbfilter.
; - country: 2 letters country code, See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
; If country code is omitted Asterisk Agent's Odoo account's country settings will be used for phonenumbers parsing.

[sub-setcallerid]
exten => _X.,1,Gosub(sub-setcurlopt,${EXTEN},1)
;   You need to cut leading + on numbers incoming from trunks before passing it to get_caller_name.
exten => _X.,n,Set(CALLERID(name)=${CURL(${ODOO_URL}/asterisk_plus/get_caller_name?number=${CALLERID(number)})})
exten => _X.,n,Return


; Get partner’s manager (salesperson) channel

[sub-dialmanager]
exten => _X.,1,Set(manager_channel=${CURL(${ODOO_URL}/asterisk_plus/get_partner_manager?number=${CALLERID(number)})})
exten => _X.,n,ExecIf($["${manager_channel}" != ""]?Dial(${manager_channel}/${EXTEN},60,t))
exten => _X.,n,Return

; Get partner's tags to create a special call routing (e.g. VIP queue)
; You can also get caller tags from Odoo with the following controller Here is an example:

; Partner tags
; VIP - tag name in this example.

[partner-vip-tag-lookup]
exten => _X.,1,Set(CURLOPT(conntimeout)=3)
exten => _X.,n,Set(CURLOPT(dnstimeout)=3)
exten => _X.,n,Set(CURLOPT(httptimeout)=3)
exten => _X.,n,Set(CURLOPT(ssl_verifypeer)=0)
exten => _X.,n,Set(tags=${CURL(${ODOO_URL}/asterisk_plus/get_caller_tags?number=${CALLERID(number)})})
exten => _X.,n,NoOp(Tags: ${tags})
exten => _X.,n,Set(match=${REGEX("VIP" ${tags})})
exten => _X.,n,NoOp(Match: ${match})
exten => _X.,n,Return(${match})

; Check VIP tag
[check-vip]
exten => _X.,1,Gosub(partner-vip-tag-lookup,${EXTEN},1,VIP)
exten => _X.,n,GotoIf($["${GOSUB_RETVAL}" = "1"]?vip-queue,${EXTEN},1)


; Incoming call handling

[from-sip-external]
exten => _X.,1,Gosub(sub-setcallerid,${EXTEN},1) ; Set partner's caller name
exten => _X.,n,MixMonitor(${UNIQUEID}.wav) ; Record call
exten => _X.,n,Gosub(sub-dialmanager,${EXTEN},1) ; Try to connect to manager
; Put here some login to handle if manager channel is busy for example put in the queue.
exten => _X.,n,Queue(sales)

[from-internal]
exten => _X.,1,MixMonitor(${UNIQUEID}.wav) ; Activate call recording.
exten => _XXXX,2,Dial(SIP/${EXTEN},30) ; Local users calling
exten => _XXXXX.,2,Dial(SIP/provider/${EXTEN},30,TU(post-dial-send-dtmf) ; Outgoing calls pattern

That’s all for now!