YAPS stands for Yet Another Phone System, and like the name states it is mainly a telephony system; our main focus at this time is on Programmable Voice, Voice over Internet Protocol(VoIP), and PSTN communication.
|
|
To get started with YAPS Programmable Voice follow the next few steps.
Preparation
The first step with YAPS Programmable Voice is to install all the requirements. Refer to websites of the various products in the list bellow for detail on installation and configuration.
Requirements:
- Docker Compose
- Node and NPM
- Git (optional)
- A softphone (with support for tcp)
Running the Infrastructure
Once all the requirements are installed, the next step is to run the infraestructure. For that, you must clone or download YAPS git repository. The first time you run this commands it will take awhile. Run using docker-compose
git clone https://github.com/fonoster/yaps
cd yaps
docker-compose upWork is on the way to enable YAPS for Docker Swarm and K8s.
Installing the Tools
The next step is to install the Command-Line Tool. To install the tool run the following command:
npm install @yaps/ctl -g
For details on this tool please go to ctl @ npmjs.
Creating and Deploy an Application
If everything is went to plan, it is now time to generate and deploy your first Voice Application.
mkdir voice-app
cd voice-app
yaps apps:init
yaps apps:deployFor more examples go the examples folder in this repository.
Testing
To interact with your application, point your softphone to Asterisk sub-system. Asterisk will be listening for SIP traffic on port 6060\tcp. The testing information is as follows:
USENAME = 1001
PASSWORD = 1234
TEST EXTENSION = 1002
What's Next?
Congratulations if you made it this far. The next step with YAPS is to get familiar with the [Command-Line Tool](https://www.npmjs.com/package/@yaps/ctl) and [SDK](https://github.com/fonoster/yaps/wiki/AppManager).
YAPS' main features are:
- Programmable Voice
- Available on Docker and Kubernetes environments
- Typical SIP Server functions; Proxy, Registrar, Location Service
- Configurable routing strategies; Intra-Domain, Domain Ingress, Domain Egress and Peer Egress
- Per node Multi-Tenancy/Multi-Domain with Domain level Access Control List
- Transport: TCP, UDP, TLS, WebSocket
- Database: Redis
For bugs, questions, and discussions please use the Github Issues
We are currently unable to place calls using UDP do to NAT issues.
For contributing, please see the following links:
Copyright (C) 2020 by Fonoster Inc. MIT License (see LICENSE for details).