Wazo

https://wazo.readthedocs.io/en/stable/
Admin
Wazo is an open-source application suite built on Asterisk and custom developments, providing...
Tokens:158,114
Snippets:958
Trust Score:8.3
Update:11 months ago
Show doc for...
Tokens:
Raw
### Python: Setup for wazo-dird Plugins

Source: https://wazo.readthedocs.io/en/stable/system/wazo-dird/developer

Example `setup.py` for a Python library that registers back-end, service, and view plugins for wazo-dird. It utilizes setuptools' entry points to make plugins discoverable by wazo-dird.

```python
#!/usr/bin/env python3
# -*- coding: utf-8 -*-

from setuptools import setup
from setuptools import find_packages


setup(
    name='Wazo dird plugin sample',
    version='0.0.1',

    description='An example program',

    packages=find_packages(),

    entry_points={
        'wazo_dird.services': [
            'my_service = dummy:DummyServicePlugin',
        ],
        'wazo_dird.backends': [
            'my_backend = dummy:DummyBackend',
        ],
        'wazo_dird.views': [
            'my_view = dummy:DummyView',
        ],
    }
)


```

--------------------------------

### Install and use a custom wazo-webhookd service plugin

Source: https://wazo.readthedocs.io/en/stable/system/wazo-webhookd

These commands and API call demonstrate how to install a custom wazo-webhookd service plugin and create a subscription for it. The `python setup.py install` command installs the plugin, and the subsequent `POST /subscriptions` request creates a new webhook subscription named 'Example webhook' using the 'example' service.

```bash
python setup.py install

```

```http
POST /subscriptions
{
  "name": "Example webhook",
  "service": "example",
  "config": {
    "time_sleep": 10
  },
  "events": ["user_created"],
}

```

--------------------------------

### Install wazo-confgend plugin

Source: https://wazo.readthedocs.io/en/stable/system/wazo-confgend/developer

Command to install a wazo-confgend plugin using its setup.py file. This makes the plugin discoverable by wazo-confgend. Requires Python and setuptools to be installed.

```bash
python setup.py install

```

--------------------------------

### Start ngrok to Expose Services

Source: https://wazo.readthedocs.io/en/stable/troubleshooting/troubleshooting

Starts all configured ngrok tunnels, making your Wazo server's services accessible from the internet via the provided public URLs.

```bash
./ngrok start --all
```

--------------------------------

### Example Asterisk dahdi-channels.conf for French BRI

Source: https://wazo.readthedocs.io/en/stable/administration/hardware/bri_configuration

Shows an example configuration for a typical French BRI line span in the Asterisk dahdi-channels.conf file, including group, context, switchtype, and signalling.

```ini
; Span 1: B4/0/1 "B4XXP (PCI) Card 0 Span 1" (MASTER) RED
group = 0,11              ; belongs to group 0 and 11
context = from-extern     ; incoming call to this span will be sent in 'from-extern' context
switchtype = euroisdn
signalling = bri_cpe    ; use 'bri_cpe' signalling
channel => 1-2          ; the above configuration applies to channels 1 and 2


```

--------------------------------

### Python: Dummy Back-End Plugin Example for wazo-dird

Source: https://wazo.readthedocs.io/en/stable/system/wazo-dird/developer

Implementation of a dummy back-end plugin for wazo-dird. This example demonstrates the required methods such as `name`, `load`, `unload`, `search`, and `list`, generating random data for search results.

```python
# -*- coding: utf-8 -*-

import logging
import random
import string

logger = logging.getLogger(__name__)

class DummyBackendPlugin(object):

    def name(self):
        return 'my_local_dummy'

    def load(self, args):
        logger.info('dummy backend loaded')

    def unload(self):
        logger.info('dummy backend unloaded')

    def search(self, term, args):
        nb_results = random.randint(1, 20)
        return self._random_list(nb_results)

    def list(self, unique_ids):
        return self._random_list(len(unique_ids))

    def _random_list(self, nb_results):
        columns = ['Firstname', 'Lastname', 'Number']
        return [self._random_entry(columns) for _ in xrange(nb_results)]

    def _random_entry(self, columns):
        random_stuff = [self._random_string() for _ in xrange(len(columns))]
        return dict(zip(columns, random_stuff))

    def _random_string(self):
        return ''.join(random.choice(string.lowercase) for _ in xrange(5))


```

--------------------------------

### Example DAHDI system.conf for French BRI

Source: https://wazo.readthedocs.io/en/stable/administration/hardware/bri_configuration

Provides an example configuration for a typical French BRI line span within the DAHDI system configuration file.

```ini
# Span 1: B4/0/1 "B4XXP (PCI) Card 0 Span 1" (MASTER) RED
span=1,1,0,ccs,ami
# termtype: te
bchan=1-2
hardhdlc=3
eşocanceller=mg2,1-2


```

--------------------------------

### Wazo Plugin Rules Script Example (wazo/rules)

Source: https://wazo.readthedocs.io/en/stable/contributors/plugins/plugins

An executable script that handles commands for building, packaging, installing, and uninstalling Wazo plugins. It defines actions for each command, such as copying configuration files or reloading services.

```shell
#!/bin/sh

case "$1" in
    build) 
        ;;
    package)
        mkdir -p ${pkgdir}/etc/asterisk/extensions_extra.d
        cp helloworld.conf ${pkgdir}/etc/asterisk/extensions_extra.d/
        ;;
    install)
        asterisk -x 'dialplan reload'
        ;;
    uninstall)
        ;;
    *)
        echo "$0 called with unknown argument '$1'" >&2
        exit 1
        ;;
esac


```

--------------------------------

### Plugin Install Progress Event Example

Source: https://wazo.readthedocs.io/en/stable/api_sdk/message_bus

This JSON object shows the 'plugin_install_progress' event, which is published during plugin installation. It contains a 'uuid' for the installation task and a 'status' field indicating the current stage of the installation.

```json
{
    "name": "plugin_install_progress",
    "origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
    "data": {
        "uuid": "8e58d2a7-cfed-4c2e-ac72-14e0b5c26dc2",
        "status": "completed"
    }
}
```

--------------------------------

### Listing and Installing Plugins with wazo-provd-cli

Source: https://wazo.readthedocs.io/en/stable/contributors/provisioning/managing_plugins

Demonstrates how to list installed plugins and install all firmwares for a specific plugin version using the `wazo-provd-cli`. This is useful for managing firmware updates across devices.

```python
wazo-provd-cli> plugins.installed().keys()
[u'xivo-snom-8.7.3.15',
 u'xivo-cisco-sccp-legacy',
 u'xivo-snom-8.4.35',
 u'xivo-snom-8.7.3.25',
 u'xivo-aastra-switchboard',
 u'xivo-aastra-3.2.2-SP3',
 u'xivo-aastra-3.2.2.1136',
 u'xivo-cisco-sccp-9.0.3',
 u'null',
 u'xivo-snom-8.7.3.25.5']
wazo-provd-cli> p = plugins['xivo-snom-8.7.3.25.5']
wazo-provd-cli> p.install_all()
```

--------------------------------

### Install Consul Binary and Setup Directories

Source: https://wazo.readthedocs.io/en/stable/system/consul

This set of commands installs the Consul binary by unzipping the archive and moving it to the system's PATH. It also creates necessary directories for Consul's configuration and data, and sets up a dedicated 'consul' user and group for running the service.

```shell
unzip consul_0.5.2_linux_386.zip

```

```shell
unzip consul_0.5.2_linux_amd64.zip

```

```shell
mv consul /usr/bin/consul
mkdir -p /etc/consul/xivo
mkdir -p /var/lib/consul
adduser --quiet --system --group --no-create-home \
        --home /var/lib/consul consul

```

--------------------------------

### Setup External Auth Plugin using setuptools

Source: https://wazo.readthedocs.io/en/stable/system/wazo-auth/developer

This setup.py file configures the packaging and distribution of an external authentication plugin for wazo-auth. It specifies the package name, version, and importantly, defines an entry point under 'wazo_auth.external_auth' to register the 'BarPlugin' from the 'src.plugin' module.

```python
#!/usr/bin/env python3
# -*- coding: utf-8 -*-

from setuptools import find_packages
from setuptools import setup

setup(
    name='auth_bar',
    version='0.1',

    packages=find_packages(),
    entry_points={
        'wazo_auth.external_auth': [
            'bar = src.plugin:BarPlugin',
        ],
    }
)

```

--------------------------------

### Compile and Install wazo-libsccp from Git

Source: https://wazo.readthedocs.io/en/stable/contributors/sccp

Clones the wazo-libsccp repository, compiles the source code, and installs it. Assumes dependencies are already met.

```bash
git clone https://github.com/wazo-platform/wazo-libsccp.git
cd wazo-libsccp
make
make install
```

--------------------------------

### Install provd Plugins

Source: https://wazo.readthedocs.io/en/stable/administration/provisioning/basic_configuration

Installs and manages provisioning plugins for Wazo. This endpoint allows for installing plugins and handling potential issues with uninstalled plugins.

```APIDOC
## POST /provd/pg_mgr/install

### Description
Installs a specified provisioning plugin. Ensure that devices are not left in an unconfigured state after uninstalling plugins.

### Method
POST

### Endpoint
/provd/pg_mgr/install

### Parameters
#### Request Body
- **plugin_name** (string) - Required - The name of the plugin to install.

### Request Example
```json
{
  "plugin_name": "xivo-snom-8.7.5.35"
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the plugin has been installed.

#### Response Example
```json
{
  "message": "Plugin 'xivo-snom-8.7.5.35' installed successfully."
}
```
```

--------------------------------

### Python: Unit Test Structure (Arrange-Act-Assert)

Source: https://wazo.readthedocs.io/en/stable/contributors/style_guide

Demonstrates the recommended three-section structure for unit tests: Preconditions/Preparations, Thing to test, and Assertions. This pattern, often called Arrange-Act-Assert, makes tests clear and concise. It includes helper methods for setup and assertion.

```python
class UserTestCase(unittest.TestCase):

    def test_fullname(self):
        user = User(firstname='Bob', lastname='Marley')
        expected = 'Bob Marley'

        fullname = user.fullname()

        self.assertEquals(expected, fullname)

    def _prepare_expected_user(self, firstname, lastname, number):
        user = User()
        user.firstname = firstname
        user.lastname = lastname
        user.number = number

        return user

    def _assert_users_are_equal(expected_user, actual_user):
        self.assertEquals(expected_user.firstname, actual_user.firstname)
        self.assertEquals(expected_user.lastname, actual_user.lastname)
        self.assertEquals(expected_user.number, actual_user.number)

    def test_create_user(self):
        expected = self._prepare_expected_user('Bob', 'Marley', '4185551234')

        user = create_user('Bob', 'Marley', '4185551234')

        self._assert_users_are_equal(expected, user)

```

--------------------------------

### Configure APT HTTP Proxy

Source: https://wazo.readthedocs.io/en/stable/system/proxy

Sets the HTTP proxy for the Advanced Packaging Tool (APT). This ensures that package installations and updates can be performed through a proxy server. Requires creating a configuration file in `/etc/apt/apt.conf.d/`.

```shell
Acquire::http::Proxy "http://domain\username:password@proxyip:proxyport";

```

--------------------------------

### Update Installable Plugins List

Source: https://wazo.readthedocs.io/en/stable/administration/provisioning/basic_configuration

Refreshes the list of installable plugins after changing the plugin server URL.

```APIDOC
## POST /provd/pg_mgr/install/update

### Description
Refreshes the list of available plugins after a new plugin server URL has been configured.

### Method
POST

### Endpoint
/provd/pg_mgr/install/update

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the plugin list has been updated.

#### Response Example
```json
{
  "message": "Installable plugins list updated successfully."
}
```
```

--------------------------------

### Install wazo-purge-db Sample Plugin using setup.py (Python)

Source: https://wazo.readthedocs.io/en/stable/system/purge_logs

This setup.py file defines a sample Python plugin for wazo-purge-db. It specifies the package name, version, description, and entry points for the plugin. This script is used for packaging and installing the plugin.

```Python
#!/usr/bin/env python
# -*- coding: utf-8 -*-

from setuptools import setup
from setuptools import find_packages


setup(
    name='wazo-purge-db-sample-plugin',
    version='0.0.1',

    description='An example program',
    packages=find_packages(),
    entry_points={
        'wazo_purge_db.archives': [
            'sample = wazo_purge_db_sample.sample:sample_plugin',
        ],
    }
)

```

--------------------------------

### REST API Permissions Setup

Source: https://wazo.readthedocs.io/en/stable/api_sdk/rest_api/quickstart

This section details the necessary steps to create a user and policy with appropriate permissions to access the REST API.

```APIDOC
## REST API Permissions Setup

### Description
This section details the necessary steps to create a user and policy with appropriate permissions to access the REST API. It involves creating a user with the `external_api` purpose and a policy with wildcard ACL templates, then associating the policy with the user.

### Method
POST, PUT

### Endpoint
- `POST /users`
- `POST /policies`
- `PUT /users/{user_uuid}/policies/{policy_uuid}`

### Parameters
#### Request Body for POST /users
- **purpose** (string) - Required - Specifies the purpose of the user, e.g., `"external_api"`.
- **username** (string) - Required - The desired username for the API user, e.g., `"rest-api-test"`.

#### Request Body for POST /policies
- **acl_templates** (array of strings) - Required - A list of ACL templates. Using `"#"` grants wildcard access to all REST APIs. Be cautious and remove this access when no longer needed.

#### Path Parameters for PUT /users/{user_uuid}/policies/{policy_uuid}
- **user_uuid** (string) - Required - The unique identifier of the user.
- **policy_uuid** (string) - Required - The unique identifier of the policy.

### Request Example
```json
POST /users
{
  "purpose": "external_api",
  "username": "rest-api-test",
  "password": "your_password_here"
}

POST /policies
{
  "acl_templates": ["#"]
}

PUT /users/{user_uuid}/policies/{policy_uuid}
```

### Response
#### Success Response (200)
- **user_uuid** (string) - The UUID of the created user.
- **policy_uuid** (string) - The UUID of the created policy.

#### Response Example
```json
{
  "user_uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "policy_uuid": "f0e9d8c7-b6a5-4321-fedc-ba9876543210"
}
```
```

--------------------------------

### Remote network packet capture streamed to Wireshark

Source: https://wazo.readthedocs.io/en/stable/troubleshooting/troubleshooting

This example shows how to perform a remote packet capture on a Wazo server and stream the data in real-time to Wireshark on a local machine. It requires installing dumpcap on the server and uses SSH for secure streaming.

```shell
# install dumpcap on the server wazo.example.com
ssh wazo.example.com apt-get install -y wireshark-common

# run the capture on interface eth0, for SIP packets only (UDP port 5060)
wireshark -k -i <(ssh wazo.example.com "dumpcap -P -i eth0 -w - -f 'udp port 5060'")
```

--------------------------------

### Install and Run wazo-debug-collect

Source: https://wazo.readthedocs.io/en/stable/troubleshooting/troubleshooting

Installs the wazo-debug package and then runs the wazo-debug-collect command to gather system logs into a tarball. This is useful for sending logs for analysis.

```bash
apt-get update
apt-get install wazo-debug
wazo-debug-collect -o /tmp/logs.tar.gz
```

--------------------------------

### Python setup.py for wazo-confgend plugin

Source: https://wazo.readthedocs.io/en/stable/system/wazo-confgend/developer

A sample setup.py file for a wazo-confgend driver plugin. It defines package metadata and registers the driver using an entry point under the 'wazo_confgend.asterisk.sip.conf' namespace. Requires setuptools.

```python
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Copyright 2016 The Wazo Authors  (see the AUTHORS file)
# SPDX-License-Identifier: GPL-3.0-or-later

from setuptools import setup
from setuptools import find_packages


setup(
    name='Wazo confgend driversample',
    version='0.0.1',

    description='An example driver',

    packages=find_packages(),

    entry_points={
        'wazo_confgend.asterisk.sip.conf': [
            'my_driver = src.driver:MyDriver',
        ],
    }
)

```

--------------------------------

### wazo-auth Command-Line Arguments

Source: https://wazo.readthedocs.io/en/stable/system/wazo-auth/wazo-auth

Provides the help message for the wazo-auth command-line interface. It outlines optional arguments for configuration file path, user, debugging, foreground execution, and log level, enabling flexible service startup.

```bash
usage: wazo-auth [-h] [-c CONFIG_FILE] [-u USER] [-d] [-f] [-l LOG_LEVEL]

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG_FILE, --config-file CONFIG_FILE
                        The path to the config file
  -u USER, --user USER  User to run the daemon
  -d, --debug           Log debug messages
  -f, --foreground      Foreground, don't daemonize
  -l LOG_LEVEL, --log-level LOG_LEVEL
                        Logs messages with LOG_LEVEL details. Must be one of:
                        critical, error, warning, info, debug. Default: None


```

--------------------------------

### Wazo Service Registered Event Example

Source: https://wazo.readthedocs.io/en/stable/api_sdk/message_bus

Example of the `service_registered_event`, published when a Wazo service starts. It contains the routing key and specific data about the registered service, including its name, ID, address, port, and tags.

```json
{
    "name": "service_registered_event",
    "origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
    "data": {
        "service_name": "wazo-dird",
        "service_id": "8e58d2a7-cfed-4c2e-ac72-14e0b5c26dc2",
        "address": "192.168.1.42",
        "port": 9495,
        "tags": ["wazo-dird", "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3", "Québec"]
    }
}
```

--------------------------------

### Wazo Host Configuration Example (YAML)

Source: https://wazo.readthedocs.io/en/stable/system/wazo-dird/stock_plugins

This YAML example demonstrates the host configuration section for Wazo's service discovery. It allows administrators to specify details for remote Wazo instances, such as service ID, service key, and datacenter, which are not always available through service discovery. These details are then made available for use within templates.

```yaml
services:
  service_discovery:
    hosts:
      ff791b0e-3d28-4b4d-bb90-2724c0a248cb:
        uuid: ff791b0e-3d28-4b4d-bb90-2724c0a248cb
        service_id: some-service-name
        service_key: secre7
        datacenter: dc1
        token: 3f031816-84a6-3960-fcd1-9cca67eacde2

```

--------------------------------

### Python: Exceptions - Avoid Bare 'except'

Source: https://wazo.readthedocs.io/en/stable/contributors/style_guide

Highlights the danger of using a bare 'except:' clause, which can catch critical system exceptions. It presents a 'bad' example with a bare except and a 'good' example that catches a specific custom exception.

```python
try:
    get_user(user_id)
except:
    logger.exception("There was an error")


```

```python
try:
    get_user(user_id)
except UserNotFoundError as e:
    logger.error(e.message)
    raise


```

--------------------------------

### Python: Exceptions - Avoid for Flow Control

Source: https://wazo.readthedocs.io/en/stable/contributors/style_guide

Illustrates the incorrect use of exceptions for controlling program flow versus the correct approach. It shows a 'bad' example raising an exception when a user is not available and a 'good' example returning a boolean.

```python
def is_user_available(user):
    if user.available():
        return True
    else:
        raise Exception("User isn't available")

try:
    is_user_available(user)
except Exception:
    disable_user(user)


```

```python
def is_user_available(user):
    if user.available():
        return True
    else:
        return False


if not is_user_available(user):
    disable_user(user)


```

--------------------------------

### Define wazo-webhookd Service Type using setup.py

Source: https://wazo.readthedocs.io/en/stable/system/wazo-webhookd

This setup.py file defines a new service type for wazo-webhookd. It specifies the package name, finds all packages, and uses entry points to register the custom service under the 'wazo_webhookd.services' hook. The 'example' service is linked to the 'Service' class within the 'example_service.plugin' module.

```python
from setuptools import setup
from setuptools import find_packages

setup(
    name='wazo-webhookd-service-example',
    version='1.0',
    packages=find_packages(),
    entry_points={
    'wazo_webhookd.services': [
            # * "example" is the name of the service.
            #   It will be used when creating a subscription.
            # * "example_service" is the name of the directory above,
            #   the one that contains plugin.py
            # * "plugin" is the name of the above file "plugin.py"
            # * "Service" is the name of the class shown below
            'example = example_service.plugin:Service',
        ]
    }
)

```

--------------------------------

### Python: Avoid Magic Numbers in Unit Tests

Source: https://wazo.readthedocs.io/en/stable/contributors/style_guide

Demonstrates refactoring a unit test to replace magic numbers with named variables for improved readability and maintainability. It shows a 'bad' example with direct numerical values and a 'good' example using variables.

```python
class TestRanking(unittest.TestCase):

    def test_ranking(self):
        rank = Rank(1, 2, 3)

        self.assertEquals(rank.position, 1)
        self.assertEquals(rank.grade, 2)
        self.assertEquals(rank.session, 3)

```

```python
class TestRanking(unittest.TestCase):

    def test_ranking(self):
        position = 1
        grade = 2
        session = 3

        rank = Rank(position, grade, session)

        self.assertEquals(rank.position, position)
        self.assertEquals(rank.grade, grade)
        self.assertEquals(rank.session, session)

```

--------------------------------

### wazo-purge-db Command-Line Usage (Help)

Source: https://wazo.readthedocs.io/en/stable/system/purge_logs

Displays the command-line arguments and options available for the wazo-purge-db utility. This is typically accessed using the --help flag.

```bash
usage: wazo-purge-db [-h] [-d DAYS_TO_KEEP]

optional arguments:
  -h, --help            show this help message and exit
  -d DAYS_TO_KEEP, --days_to_keep DAYS_TO_KEEP
                        Number of days data will be kept in tables

```

--------------------------------

### Python: Exceptions - Use Specific Exception Types

Source: https://wazo.readthedocs.io/en/stable/contributors/style_guide

Contrasts the improper use of generic 'Exception' with the recommended practice of using specific built-in or custom exception types. It shows a 'bad' example raising a generic Exception and a 'good' example defining and raising a custom 'UserNotFoundError'.

```python
def get_user(userid):
    user = session.query(User).get(userid)

    if not user:
        raise Exception("User not found")


```

```python
class UserNotFoundError(LookupError):

    def __init__(self, userid):
        message = "user with id %s not found" % userid
        LookupError.__init__(self, message)

def get_user(userid):
    user = session.query(User).get(userid)

    if not user:
        raise UserNotFoundError(userid)


```

--------------------------------

### Install Provisioning Packages (Debian)

Source: https://wazo.readthedocs.io/en/stable/contributors/provisioning/testing_new_sip_phone

Installs essential packages for SIP phone provisioning on a Debian server. These include DHCP, TFTP, and Apache web server.

```bash
isc-dhcp-server tftpd-hpa apache2
```

--------------------------------

### PUT /asterisk/iax/general - Codec Selection

Source: https://wazo.readthedocs.io/en/stable/installation/postinstall

Configure the allowed codecs for IAX general settings. This example prioritizes 'alaw' for European usage.

```APIDOC
## PUT /asterisk/iax/general - Codec Selection

### Description
Configure the allowed codecs for IAX general settings. This example prioritizes 'alaw' for European usage.

### Method
PUT

### Endpoint
/asterisk/iax/general

### Parameters
#### Request Body
- **allow** (string) - Comma-separated list of allowed codecs (e.g., 'alaw,g722,g729,h264').

### Request Example
```json
{
  "allow": "alaw,g722,g729,h264"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "OK"
}
```
```

--------------------------------

### PUT /asterisk/sip/general - Codec Selection

Source: https://wazo.readthedocs.io/en/stable/installation/postinstall

Configure the allowed codecs for SIP general settings. This example prioritizes 'alaw' for European usage.

```APIDOC
## PUT /asterisk/sip/general - Codec Selection

### Description
Configure the allowed codecs for SIP general settings. This example prioritizes 'alaw' for European usage.

### Method
PUT

### Endpoint
/asterisk/sip/general

### Parameters
#### Request Body
- **allow** (string) - Comma-separated list of allowed codecs (e.g., 'alaw,g722,g729,h264').

### Request Example
```json
{
  "allow": "alaw,g722,g729,h264"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "OK"
}
```
```

--------------------------------

### Python String Concatenation: Good Example

Source: https://wazo.readthedocs.io/en/stable/contributors/style_guide

Illustrates the use of string interpolation (`%s`) for concatenating strings in Python, which is more efficient and readable than using the `+` operator.

```python
phone_interface = "SIP/%s-%s" % (username, password)

```

--------------------------------

### Install ngrok on 64-bit Wazo Server

Source: https://wazo.readthedocs.io/en/stable/troubleshooting/troubleshooting

Downloads and unzips the ngrok binary for 64-bit Linux systems. This step is necessary before configuring ngrok for external access.

```bash
wget https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-amd64.zip
unzip ngrok-stable-linux-amd64.zip
```

--------------------------------

### Install ngrok on 32-bit Wazo Server

Source: https://wazo.readthedocs.io/en/stable/troubleshooting/troubleshooting

Downloads and unzips the ngrok binary for 32-bit Linux systems. This is a prerequisite for using ngrok to expose your Wazo server externally.

```bash
wget https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-386.zip
unzip ngrok-stable-linux-386.zip
```

--------------------------------

### Wazo Plugin Metadata for Hello World (plugin.yml)

Source: https://wazo.readthedocs.io/en/stable/contributors/plugins/plugins

Minimal metadata for the 'Hello World' Wazo plugin. It specifies the namespace, name, description, version, and the plugin format version it adheres to.

```yaml
namespace: demo
name: helloworld
description: Adds the extension "***42" to you dialplan to greet users
version: 0.0.1
plugin_format_version: 0


```

--------------------------------

### Restart wazo-confgend service

Source: https://wazo.readthedocs.io/en/stable/system/wazo-confgend/developer

Command to restart the wazo-confgend system service. This is necessary after installing a new plugin or modifying its configuration to apply the changes. Requires systemctl utility.

```bash
systemctl restart wazo-confgend.service

```

--------------------------------

### Python Line Continuation: Good Example

Source: https://wazo.readthedocs.io/en/stable/contributors/style_guide

Demonstrates the preferred method for breaking long lines in Python, using parentheses to group expressions instead of backslashes. This enhances readability and reduces potential errors.

```python
user = (session.query(User).filter(User.firstname == firstname)
                           .filter(User.lastname == lastname)
                           .filter(User.number == number)
                           .all())

```

--------------------------------

### Build and Upload Provisioning Plugins (Shell)

Source: https://wazo.readthedocs.io/en/stable/contributors/provisioning/developing_plugins

Shell commands to build and upload Wazo provisioning plugins. Includes steps for both development and stable versions, managing plugin archives.

```shell
cd xivo-skaro/provisioning/plugins
make upload
```

```shell
cd xivo-skaro/provisioning/plugins
make download-stable
cd _build
cp dev/xivo-digium-1.1.0.0-0.3.tar.bz2 stable/
cd ..
make upload-stable
```

--------------------------------

### DHCP Server Logs for Digium Phones

Source: https://wazo.readthedocs.io/en/stable/contributors/provisioning/developing_plugins

Example log entries showing the DHCP server's interaction when provisioning Digium phones. These logs indicate successful IP address assignment and boot events.

```text
dhcpd: [1:0:f:d3:5:48:48] [VENDOR-CLASS-IDENTIFIER: digium_D40_1_1_0_0_48178]
dhcpd: [1:0:f:d3:5:48:48] POOL VoIP
dhcpd: [1:0:f:d3:5:48:48] BOOT Digium D40
dhcpd: DHCPDISCOVER from 00:0f:d3:05:48:48 via eth0
dhcpd: DHCPOFFER on 10.42.1.100 to 00:0f:d3:05:48:48 via eth0
dhcpd: [1:0:f:d3:5:48:48] [VENDOR-CLASS-IDENTIFIER: digium_D40_1_1_0_0_48178]
dhcpd: [1:0:f:d3:5:48:48] POOL VoIP
dhcpd: [1:0:f:d3:5:48:48] BOOT Digium D40
dhcpd: DHCPREQUEST for 10.42.1.100 (10.42.1.1) from 00:0f:d3:05:48:48 via eth0
dhcpd: DHCPACK on 10.42.1.100 to 00:0f:d3:05:48:48 via eth0


```

--------------------------------

### Plugin Information File

Source: https://wazo.readthedocs.io/en/stable/contributors/provisioning/developing_plugins

A JSON file ('plugin-info') that contains metadata for a Wazo provisioning plugin. It includes version, description in multiple languages, and capabilities supported by specific phone models.

```json
{
    "version": "0.3",
    "description": "Plugin for Digium D40, D50 and D70 in version 1.1.0.0.",
    "description_fr": "Greffon pour Digium D40, D50 et D70 en version 1.1.0.0.",
    "capabilities": {
        "Digium, D40, 1.1.0.0": {
            "sip.lines": 2
        },
        "Digium, D50, 1.1.0.0": {
            "sip.lines": 4
        },
        "Digium, D70, 1.1.0.0": {
            "sip.lines": 6
        }
    }
}


```

--------------------------------

### Configure Default SIP and IAX Codecs (Asterisk/IAX)

Source: https://wazo.readthedocs.io/en/stable/installation/postinstall

This configuration sets the allowed codecs for both Asterisk SIP and IAX general settings. The example prioritizes `alaw` for European usage, including `g722`, `g729`, and `h264`.

```bash
PUT /asterisk/sip/general
    allow: alaw,g722,g729,h264
PUT /asterisk/iax/general
    allow: alaw,g722,g729,h264
```

--------------------------------

### Asterisk Dialplan for Hello World Plugin (helloworld.conf)

Source: https://wazo.readthedocs.io/en/stable/contributors/plugins/plugins

A configuration file for Asterisk that defines a dialplan entry for the 'Hello World' plugin. When extension ***42 is called, it plays the 'hello-world' audio file.

```ini
[xivo-extrafeatures]
exten = ***42,1,Playback(hello-world)
same = n,Return()

```
Tokens:
Raw