Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

Select Status


freeswitch (16) Versions 0.7.0

Installs/Configures FreeSWITCH

cookbook 'freeswitch', '= 0.7.0', :supermarket
cookbook 'freeswitch', '= 0.7.0'
knife supermarket install freeswitch
knife supermarket download freeswitch
Quality 0%

FreeSWITCH cookbook

This Chef cookbook installs FreeSWITCH either from source or packages and configures its basic settings. It is intended that this cookbook remain small and perform only installation tasks, with downstream cookbooks depending on it to configure FreeSWITCH for more specific tasks.


Tested on Ubuntu 12.04, Debian 7.1 and CentOS 6.5.


Add recipe[freeswitch] to your node's run list


  • node['freeswitch']['install_method'] - the method by which to install FreeSWITCH. May be package or source. This choice determines other applicable parameters. (default package)
  • node['freeswitch']['user'] - the user as which to run FreeSWITCH (default freeswitch)
  • node['freeswitch']['group'] - the group as which to run FreeSWITCH (default freeswitch)
  • node['freeswitch']['service'] - the service name as which to run FreeSWITCH (default freeswitch)
  • node['freeswitch']['binpath'] - the path at which FreeSWITCH binaries are located (default /usr/bin)
  • node['freeswitch']['confpath'] - the path at which FreeSWITCH configuration is located (default /etc/freeswitch)
  • node['freeswitch']['homedir'] - the path at which FreeSWITCH's home directory is' located (default /var/lib/freeswitch)
  • node['freeswitch']['local_ip'] - the local IP FreeSWITCH listens on (default default['asterisk']['public_ip'] = node['ec2'] ? node['ec2']['public_ipv4'] : node['ipaddress'])
  • node['freeswitch']['domain'] - the domain at which FS acts as a registrar, etc (default node['fqdn'])
  • node['freeswitch']['vars_template'] - the template file to use for placing FreeSWITCH vars.xml
  • node['freeswitch']['vars_template_cookbook'] - the cookbook from which to load the vars template
  • node['freeswitch']['autoload_modules'] - the list of modules which FreeSWITCH should load on startup (default %w[mod_console mod_logfile mod_enum mod_event_socket mod_rayo mod_sofia mod_loopback mod_commands mod_conference mod_db mod_dptools mod_expr mod_fifo mod_hash mod_esf mod_fsv mod_http_cache mod_dialplan_xml mod_g723_1 mod_g729 mod_amr mod_ilbc mod_speex mod_h26x mod_siren mod_sndfile mod_native_file mod_local_stream mod_tone_stream mod_ssml mod_flite mod_pocketsphinx mod_say])

Package install attributes

  • node['freeswitch']['package']['packages'] - the FreeSWITCH packages to install (default %w(freeswitch-meta-vanilla freeswitch-mod-rayo freeswitch-mod-flite freeswitch-conf-rayo))
  • node['freeswitch']['package']['repo']['enable'] - if the FreeSWITCH official repository should be enabled (default true)
  • node['freeswitch']['package']['repo']['url'] - the URL of the FreeSWITCH official repo (default
  • node['freeswitch']['package']['repo']['distro'] - the distro to select from the repo (default wheezy)
  • node['freeswitch']['package']['repo']['branches'] - the branches of the repo to import (default %w(main))
  • node['freeswitch']['package']['repo']['keyserver'] - the keyserver against which to auth the repo (default nil, this will use the cookbook's stored GPG key)
  • node['freeswitch']['package']['repo']['key'] - the repo's public GPG key (default freeswitch.gpg)

Source install attributes

  • node['freeswitch']['source']['git_uri'] - the URI of the FreeSWITCH git repository to use for installation (default
  • node['freeswitch']['source']['git_branch'] - the branch of the git repository to install from (default v1.2.stable)
  • node['freeswitch']['source']['dependencies'] - the packages to be installed on which compilation depends (default %w[autoconf automake g++ git-core libjpeg62-dev libncurses5-dev libtool make python-dev gawk pkg-config gnutls-bin libsqlite3-dev bison libasound2-dev])
  • node['freeswitch']['source']['modules'] - the modules to compile (default %w[loggers/mod_console loggers/mod_logfile loggers/mod_syslog applications/mod_commands applications/mod_conference applications/mod_dptools applications/mod_enum applications/mod_db applications/mod_hash applications/mod_http_cache applications/mod_expr applications/mod_esf applications/mod_fsv codecs/mod_g723_1 codecs/mod_amr codecs/mod_g729 codecs/mod_h26x codecs/mod_bv codecs/mod_ilbc codecs/mod_speex codecs/mod_siren dialplans/mod_dialplan_xml endpoints/mod_sofia endpoints/mod_loopback asr_tts/mod_flite asr_tts/mod_pocketsphinx event_handlers/mod_event_socket event_handlers/mod_cdr_csv event_handlers/mod_rayo formats/mod_native_file formats/mod_sndfile formats/mod_local_stream formats/mod_tone_stream formats/mod_ssml say/mod_say_en])


  • freeswitch - Fetches and installs FreeSWITCH



This LWRP provides an easy way to manage FreeSWITCH users (directory entries). FreeSWITCH XML config will be reloaded after a run which manipulates users.


  • :add: adds a user to the directory
  • :remove: removes a user from the directory

Attribute Parameters

  • id: The user's ID. May be alphanumeric, and defaults to the name of the resource.
  • directory: The name of the directory in which to place the user (must already exist). Defaults to 'default'.
  • password: The user's password. Defaults to $${default_password}.
  • vm_password: The user's voicemail password. Defaults to $${default_password}.
  • effective_caller_id_name: The user's caller ID name. Defaults to 'Extension'.
  • effective_caller_id_number: The user's caller ID number. Defaults to $${outbound_caller_id}.
  • cookbook: The name of the cookbook from which to fetch the user template. Defaults to this cookbook.
  • template: The name of the template to use for the user's configuration. Defaults to user.xml.erb.


Add the joebloggs user:

freeswitch_user 'joebloggs'

Add a user specifying all the possible attributes:

freeswitch_user 'joebloggs' do |variable|
  directory 'default'
  password 'foobar'
  vm_password 'barbaz'
  effective_caller_id_name 'Joe Bloggs'
  effective_caller_id_number ''
  cookbook 'my-wrapper-cookbook'
  template 'freeswitch-user.xml.erb'

Remove the joebloggs user:

freeswitch_user 'joebloggs' do
  action :remove


[Ben Langfeld](@benlangfeld)



  • Update URL for FreeSWITCH git repository (moved to Stash)
  • Add additional dev packages now required for source builds
  • Remove mod_enum which was breaking source builds


  • mod_http_cache is now correctly installed for Rayo servers


  • Use a stored GPG key instead of relying on keyservers


  • Fix reloading after user resource execution


  • Prevent conflicts between our init script and the one provided by packages
  • Prefix package key ID for reliable lookup


  • Allow specifying the cookbook from which to load the vars template
  • Softly reload FreeSWITCH on config changes, rather than doing a full restart


  • Allow creating FS users (directory entries) via a LWRP


  • Update source build dependencies


  • Only place config templates on initial installation. Avoids unnecessarily bouncing config and restarting FreeSWITCH on every run.
  • Speed up the source build
  • Add additional development pkgs needed by FS master


  • Bump to yum 3.x cookbook


  • Ensure that mod_ssml, mod_flite and mod_pocketsphinx get installed for a Rayo server


  • Install rayo config in source install


  • Add support for CentOS
  • Default local_ip to the primary interface's IP


  • Add rayo recipe for deploying a Rayo server


  • First release

Foodcritic Metric

0.7.0 failed this metric

FC040: Execute resource used to run git commands: /tmp/cook/dc60e7232a4f1be0aedac116/freeswitch/recipes/source.rb:5