chadxz / asterisk-playground

A sandbox to tinker with Asterisk and its many interfaces

asterisk-playground

Vagrant + Ansible scripts for setting up an Asterisk instance on a ubuntu/xenial virtual machine. Comes with Dockerized Asterisk and a Node.js AGI + ARI app.

---

pre-reqs

Things you'll need locally for Ansible

• An ssh key

• Python 3 installed. On Mac I use homebrew.

• pipx installed. On Mac I use homebrew.

• virtualenv installed. Using pipx above.

• Ensure you have an ssh key

• Ensure you have Python 2.7.x installed. (Installed by default on OSX)

• Ensure you have homebrew installed.

  /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

• Install Python pip package manager.

  easy_install pip

• Use pip to install Ansible.

  pip install ansible

• Install virtualbox and vagrant.

  brew cask install virtualbox vagrant

• Start the virtual machine with vagrant up

deploying the system

To setup the vm from scratch:

$ make

Once deployed to, you can ssh into it:

$ ssh 192.168.68.68

To upgrade the asterisk box or agi+ari application:

$ make deploy

accessing the system

Once deployed, a few services will be available on the vm:

• cAdvisor will be running, providing monitoring for the system and containers. Access this at http://192.168.68.68:8080/containers/

• SwaggerUi will be running at http://192.168.68.68:1337 pointing at Asterisk.

• Asterisk will be running. Point a sip client at 192.168.68.68 using the credentials from asterisk/conf/pjsip.conf.

• The 'call-control' node app will be running, but it only interacts with Asterisk and exposes no public facing ui.

• To view logs of any application, ssh into the box with vagrant ssh playground and use docker ps to view the container statuses and docker logs <container name> to view logs of any individual container. For Asterisk, you can access the console using the command docker exec -ti asterisk asterisk -c

asterisk-playground's Issues

add speex and opus support to asterisk

currently i have to disable these in x-lite to get the hello world to play back

Softphone connection.

Hi @chadxz asterisk-playground looks very helpfull but I am very new to asterisk. I want to connect with a softhone (http://www.counterpath.com/x-lite/)

Here is my acount settings screenshot but it fails. Can you help me for correct settings.

Note: Currently I can access system. (For example: http://192.168.68.68:8088/ari/api-docs/resources.json is working)

Create an example of the use of the awry ARI Applications API

Use awry to interact with the ARI Applications API to prove out the client library's implementation. The applications api has the following apis:

• list() all applications registered in Asterisk
• get() a specific application's details
• subscribe() to a specific application's eventSource, which could be a channelId, a bridgeId, an endpoint (using the form PJSIP/6001), or a deviceName
• unsubscribe() from the same

Once the proper usage of these apis is discovered through an implementation, document them in a ticket in the awry issues so they can be added as examples in the jsdoc.

swagger-ui no longer working

seems the swagger-ui image that i was using has updated to no longer expose a way to add an authorization. Need to build a custom swagger-ui image to deploy that has ability to set api_key authorization like http://ari.asterisk.org

rewrite asterisk agi client

it's based on a fork of an old client. rewrite with modern javascript (node 6+) like awry.

get better quality sounds

the sounds i'm using right now are lower quality than I could be using. should look into getting sln16 or g722 sounds for both core and moh

fix swagger-ui installation

seems to be chain restarting. haven't looked to see why yet.

Create an example of the use of the awry ARI Asterisk API

Use awry to interact with the ARI Asterisk API to prove out the client library's implementation. The asterisk endpoint has the following apis:

• getObject() retrieves a dynamic config object
• updateObject() creates or updates a dynamic config object
• deleteObject() removes a dynamic config object
• getInfo() retrieves asterisk system information such as build, system, config, or status info
• listModules() lists loaded asterisk modules
• getModule() retrieves details about a specific module
• loadModule() loads a specific module
• unloadModule() unloads a specific module
• reloadModule() causes a specific asterisk module to reload
• listLogChannels() retrieves a list of all configured log channels
• addLog() adds a new log channel
• deleteLog() removes one
• rotateLog() causes a log channel to rotate
• getGlobalVariable() retrieves the value of a global variable
• setGlobalVariable() sets the value of a global var

Once the proper usage of these apis is discovered through an implementation, document them in a ticket in the awry issues so they can be added as examples in the jsdoc.

update docker installation

needs to use docker-ce

https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/#set-up-the-repository

fix reboot

it doesn't work as-is