Table of Contents

Loading ...

Installing the System


Trying it out

Here are the system minimum requirements if you just want to try out a Wazo Platform instance:

  • CPU: 1 CPU is enough for a test server
  • Memory: 2 GiB of memory is a tight minimum for a test server
  • Storage: 8 GiB is comfortable for a test server, except if you plan to use large firmware files for physical phones.


Here are the expected resources for a small production installation of around 50 users:

  • 2 CPU minimum
  • 4 GiB RAM minimum
  • 50 GiB storage minimum


To install the Unified Communication use case in an all-in-one setup, do the following steps:

  1. Install a Debian 11 Bullseye system with a default locale with an UTF-8 charset.

  2. Run the following commands as root on the Debian system to provision sudo, git and Ansible:

    apt update
    apt install -yq sudo git ansible curl

    Note: Ansible is a suite of software tools that enables infrastructure as code. It is open-source and the suite includes software provisioning, configuration management, and application deployment functionality.

  3. Extract the Wazo Platform installer

    git clone
    cd wazo-ansible
  4. (optional) By default, Wazo Platform will install the development version. To install the latest stable version

    git checkout $ansible_tag
  5. Install the Wazo Platform installer dependency

    ansible-galaxy install -r requirements-postgresql.yml
  6. Edit the file inventories/uc-engine to add your preferences and passwords. The various variables that can be customized are described at

    By default, Wazo Platform will install the development version. To install the latest stable version, activate the following settings in inventories/uc-engine:

    wazo_distribution = pelican-bullseye
    wazo_distribution_upgrade = pelican-bullseye

    If you want to install the web user interface, activate the following in your inventories/uc-engine:


    The following variables allow you to create the root account at installation time, to be able to use the web user interface and an API user to be able to use the REST APIs:

    engine_api_configure_wizard = true
    engine_api_root_password = <YOUR_ROOT_PASSWORD>
    api_client_name = <YOUR_API_USERNAME>
    api_client_password = <YOUR_API_PASSWORD>

    Note: this API user will only have permissions for configuration REST API (wazo-confd).

  7. Launch the installation by running the following command:

    ansible-playbook -i inventories/uc-engine uc-engine.yml
  8. Once the installation completed, execute the following command to verify that all the Wazo services (wazo-plugind, wazo-webhookd, ...) are up and running:

    wazo-service status

Use the REST API

You may now use the REST API from outside your system (here

  1. Get an authentication token for 1 hour:

    Execute from the Debian system:

    wazo-auth-cli token create --auth-user <YOUR_API_USERNAME> --auth-password <YOUR_API_PASSWORD>

    Or with curl from anywhere:

    curl -k -X POST -u <YOUR_API_USERNAME>:<YOUR_API_PASSWORD> -H 'Content-Type: application/json' -d '{"expiration": 3600}'
  2. Use any REST API you want.

    Note: You must replace <YOUR_TOKEN> with the authentication token

    To obtain the version of Wazo:

    curl -k -X GET -H 'X-Auth-Token: <YOUR_TOKEN>' -H 'Content-Type: application/json'

    To list the telephony users configured on the system:

    curl -k -X GET -H 'X-Auth-Token: <YOUR_TOKEN>' -H 'Content-Type: application/json'

Optional post-install steps

You may now follow the optional post-install steps.