Scripting toolkit for FreeSWITCH written in the Lua programming language
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc
examples
modules
profiles
scripts
sequences
support
BUGS.md
CHANGELOG.md
INSTALL.md
LICENSE.txt
README.md
TODO.md
action_map.lua
conf.lua
config.ld
core.lua
jester.lua
ldoc.custom.css
socket.lua

README.md

Jester

Introduction

Jester is a scripting toolkit for FreeSWITCH written in the Lua programming language. It's functionality sits squarely between the feature set of the XML dialplan, IVR menus, and custom scripting. The goal of Jester is to ease development of voice workflows by providing a simple, unified way to implement more complex features that normally require custom scripting.

Installation

See INSTALL.md for installation instructions.

Architecture

Jester is written to be small, simple, and extensible. The core code is less than 800 lines! Most user tasks are carried out by pluggable modules, and people familiar with Lua scripting will find it easy to add new modules to extend functionality further. End users are spared the complexity of writing full scripts, and instead work inside script-like templates called 'sequences', that allow them to pass commands with parameters to the underlying modules, which handle all the dirty work.

Comedian mail replica

Jester's default profile is a replica of Asterisk's Comedian Mail system. The implementation is acheived using fourteen modules containing thirty-four distinct configurable 'actions', all re-usable for other complex voice workflows. Those transitioning from Asterisk to FreeSWITCH with concerns about the differences between the two voicemail systems can leverage this to provide a seamless transition to their end users.

Documentation

Jester comes with extensive documentation available online, which should make it easy for new users and developers to get up to speed.

Once you've installed Jester, the next best step is to read the help. If you'd like to install it locally, install LDoc, then run the following from the root directory:

  ldoc .

Support

The issue tracker for this project is provided to file bug reports, feature requests, and project tasks -- support requests are not accepted via the issue tracker. For all support-related issues, including configuration, usage, and training, consider hiring a competent consultant.

Other stuff

See LICENSE.txt to view the license for this software.

See BUGS.md for a list of known issues.

See TODO.md for a list of things we're working on.

See CHANGELOG.md for a running list of important changes.