Skip to main content

Appendix A: The Vanilla Configuration Map

The conf/vanilla/ tree shipped with FreeSWITCH provides a complete, working baseline configuration. This appendix lists every file and directory at the configuration root, followed by a detailed table of every file in autoload_configs/, so operators can locate the configuration for any module or subsystem and cross-reference the chapter in this manual that documents it.

Configuration Root Layout

The configuration root contains a mix of top-level XML files, template files, and subdirectories. FreeSWITCH assembles all of these into a single in-memory XML document at startup, driven by the #include and X-PRE-PROCESS directives in freeswitch.xml. The subdirectories correspond directly to the five top-level sections of that document: configuration (served from autoload_configs/), dialplan, chatplan, directory, and languages (served from lang/). The ivr_menus/ and skinny_profiles/ directories supply additional configuration partials included by their respective modules.

Top-Level Entries

PathPurpose
freeswitch.xmlMaster document; assembles all sections via X-PRE-PROCESS cmd="include" directives. Documented in Chapter 3: The XML Configuration System.
vars.xmlGlobal preprocessor variables ($${domain}, $${local_ip_v4}, codec strings, port numbers). Documented in Chapter 4: Global Variables and Core Settings.
autoload_configs/One *.conf.xml file per loadable module or core subsystem; maps to the configuration section. Documented across Parts II through VII.
dialplan/XML dialplan contexts (default, public, features) and per-context include directories. Documented in Chapter 12: The XML Dialplan and Chapter 13: Inbound Calls and the Public Context.
directory/User and domain definitions. Contains default.xml and the default/ directory of per-user files. Documented in Chapter 6: The User Directory.
sip_profiles/Sofia SIP profile definitions (internal.xml, external.xml, IPv6 variants) and the external/ gateway include directory. Documented in Chapter 7: SIP Profiles with Sofia and Chapter 8: Gateways and Trunk Registration.
ivr_menus/XML IVR menu definitions (demo_ivr.xml, new_demo_ivr.xml) loaded by mod_dptools. Documented in Chapter 21: IVR Menus.
skinny_profiles/SCCP (Skinny) profile definitions (internal.xml) loaded by mod_skinny. Documented in Chapter 11: Other Endpoints.
lang/Language and phrase macro files for the languages section, organized by locale (de, en, es, fr, he, pt, ru, sv).
chatplan/XML chatplan context (default.xml) for instant-message routing via mod_dialplan_xml.
mime.typesMIME type mappings used by the HTTP subsystem.
voicemail.tplEmail body template for voicemail notification messages. Documented in Chapter 19: Voicemail.
notify-voicemail.tplEmail body template for missed-call (notify) voicemail messages. Documented in Chapter 19: Voicemail.
web-vm.tplHTML email template for voicemail web notifications. Documented in Chapter 19: Voicemail.
fur_elise.ttmlTTML tone-stream score for Fur Elise, used as a hold-music example.
tetris.ttmlTTML tone-stream score for the Tetris theme, used as a hold-music example.
extensions.confAsterisk-compatible extensions file stub; present for reference only.
config.FS0Alternate configuration root marker used by some packaging scripts.
README_IMPORTANT.txtOperator notes shipped with the vanilla tree. Referenced in Chapter 1: Introduction and Core Concepts.

autoload_configs Reference

Each file in autoload_configs/ is read by the module or core subsystem whose name matches the filename prefix. FreeSWITCH loads these files in the order determined by modules.conf.xml and the pre_load_modules.conf.xml / post_load_modules.conf.xml sequence.

FileConfiguresDocumented in
acl.conf.xmlNamed access-control lists and their CIDR node entries.Chapter 29: Access Control Lists
alsa.conf.xmlmod_alsa audio device endpoint.Chapter 11: Other Endpoints
amqp.conf.xmlmod_amqp AMQP event publisher; broker URL and exchange settings.Part 9: mod_amqp
amr.conf.xmlmod_amr narrowband AMR codec; mode and payload settings.Chapter 16: Codecs and Negotiation
amrwb.conf.xmlmod_amrwb wideband AMR codec; mode and payload settings.Chapter 16: Codecs and Negotiation
av.conf.xmlmod_av H.264, H.263, and H.263+ video codec via libavcodec; per-codec encoder/decoder thread counts, bitrate cap, keyframe frequency, and x264 options.Chapter 16: Codecs and Negotiation
avmd.conf.xmlmod_avmd advanced voicemail detection; beep detection parameters using the DESA-2 algorithm.Part 9: mod_avmd
blacklist.conf.xmlmod_blacklist caller-ID blacklist configuration.Part 9: mod_blacklist
callcenter.conf.xmlmod_callcenter ACD queues, agents, and tier definitions.Chapter 22: Queues: FIFO and Call Center
cdr_csv.conf.xmlmod_cdr_csv CDR flat-file output; templates, legs, and rotation.Chapter 27: Call Detail Records
cdr_pg_csv.conf.xmlmod_cdr_pg_csv CDR output to PostgreSQL.Part 9: mod_cdr_pg_csv
cdr_sqlite.conf.xmlmod_cdr_sqlite CDR output to a SQLite database.Chapter 27: Call Detail Records
cidlookup.conf.xmlmod_cidlookup caller-ID name lookup via HTTP or local cache.Part 9: mod_cidlookup
conference.conf.xmlmod_conference conference profiles and per-profile parameter set.Chapter 20: Conferencing
conference_layouts.conf.xmlmod_conference video layout definitions for video conferences.Chapter 20: Conferencing
console.conf.xmlmod_console console logger; log level and color settings.Configured directly in this file.
curl.conf.xmlmod_curl HTTP client application; global timeout and proxy defaults.Part 9: mod_curl
db.conf.xmlmod_db key-value database interface; DSN and table settings.Chapter 23: Utility Applications
dialplan_directory.conf.xmlmod_dialplan_directory dialplan provider backed by LDAP; host, DN, password, and search base settings.Part 9: mod_dialplan_directory
directory.conf.xmlmod_directory dial-by-name IVR application; search order, digit timeout, and result-navigation key mappings.Part 9: mod_directory
distributor.conf.xmlmod_distributor weighted gateway distribution lists.Part 9: mod_distributor
easyroute.conf.xmlmod_easyroute database-backed DID routing.Part 9: mod_easyroute
enum.conf.xmlmod_enum ENUM DNS lookup; root zone and routing rules.Configured directly in this file.
erlang_event.conf.xmlmod_erlang_event Erlang node event handler; node name and cookie.Part 9: mod_erlang_event
event_multicast.conf.xmlmod_event_multicast multicast event publisher; address and port.Part 9: mod_event_multicast
event_socket.conf.xmlmod_event_socket inbound ESL listener; listen-ip, listen-port, password.Chapter 25: The Event Socket
fax.conf.xmlAlternate configuration filename accepted by mod_spandsp for backward compatibility; contains T.30/T.38 fax parameters.Chapter 24: Fax and T.38
fifo.conf.xmlmod_fifo FIFO queue definitions and consumer/caller settings.Chapter 22: Queues: FIFO and Call Center
format_cdr.conf.xmlmod_format_cdr CDR formatter; output format and HTTP posting options.Part 9: mod_format_cdr
graylog2.conf.xmlmod_graylog2 GELF log shipper; host, port, and log level.Part 9: mod_graylog2
hash.conf.xmlmod_hash shared in-memory hash table; realm definitions.Chapter 23: Utility Applications
hiredis.conf.xmlmod_hiredis Redis client via hiredis; host, port, and pool settings.Part 9: mod_hiredis
httapi.conf.xmlmod_httapi HTTP-driven dialplan application; gateway URL and bindings.Configured directly in this file.
http_cache.conf.xmlmod_http_cache HTTP media cache and S3/Azure object storage; cache location, size, TTL, and storage profiles.Part 9: mod_http_cache
ivr.conf.xmlmod_dptools IVR menu loader; points to ivr_menus/ definitions.Chapter 21: IVR Menus
java.conf.xmlmod_java embedded JVM; JVM arguments and classpath.Chapter 28: Scripting Integration
lcr.conf.xmlmod_lcr least-cost routing; database DSN and query definitions.Part 9: mod_lcr
local_stream.conf.xmlmod_local_stream music-on-hold stream definitions; directory, rate, and shuffle.Chapter 18: Audio Files and Streaming Sources
logfile.conf.xmlmod_logfile file logger; log path, level, and rotation settings.Configured directly in this file.
lua.conf.xmlmod_lua embedded Lua interpreter; script-dir and startup script.Chapter 28: Scripting Integration
memcache.conf.xmlmod_memcache Memcached client; server list and expiry defaults.Part 9: mod_memcache
modules.conf.xmlCore module load list; controls which modules start with FreeSWITCH.Chapter 5: Module Loading and Management
mongo.conf.xmlmod_mongo MongoDB client; URI and collection defaults.Part 9: mod_mongo
msrp.conf.xmlmod_msrp MSRP (Message Session Relay Protocol) endpoint settings.Configured directly in this file.
nibblebill.conf.xmlmod_nibblebill real-time billing; database DSN and per-leg decrement.Part 9: mod_nibblebill
opal.conf.xmlmod_opal H.323 and other OPAL-supported protocol endpoint.Part 9: mod_opal
opus.conf.xmlmod_opus Opus codec; bitrate, complexity, and FEC settings.Chapter 16: Codecs and Negotiation
osp.conf.xmlmod_osp Open Settlement Protocol client; server URL and crypto material.Part 9: mod_osp
perl.conf.xmlmod_perl embedded Perl interpreter; startup script path.Chapter 28: Scripting Integration
pocketsphinx.conf.xmlmod_pocketsphinx speech recognition; acoustic model and grammar paths.Part 9: mod_pocketsphinx
post_load_modules.conf.xmlModules loaded after the main module set completes startup.Chapter 5: Module Loading and Management
pre_load_modules.conf.xmlModules loaded before the main module set, typically core interfaces.Chapter 5: Module Loading and Management
presence_map.conf.xmlmod_presence_map SIP presence status code mapping table.Configured directly in this file.
python.conf.xmlmod_python embedded Python interpreter; startup script path.Chapter 28: Scripting Integration
redis.conf.xmlmod_redis Redis client (legacy); host, port, and pool settings.Part 9: mod_redis
rtmp.conf.xmlmod_rtmp RTMP media endpoint; bind address and port.Chapter 11: Other Endpoints
shout.conf.xmlmod_shout MP3 and Icecast streaming; encoder and server settings.Chapter 18: Audio Files and Streaming Sources
signalwire.conf.xmlmod_signalwire SignalWire platform connectivity; authentication token.Chapter 30: SignalWire Connectivity
skinny.conf.xmlmod_skinny SCCP endpoint; bind address, port, and profile references.Chapter 11: Other Endpoints
smpp.conf.xmlmod_smpp SMPP SMS gateway; host, port, and system ID.Part 9: mod_smpp
sndfile.conf.xmlmod_sndfile audio file format handler via libsndfile; format mappings.Chapter 18: Audio Files and Streaming Sources
sofia.conf.xmlmod_sofia SIP stack global settings and profile references.Chapter 7: SIP Profiles with Sofia
spandsp.conf.xmlmod_spandsp fax (T.38, T.30) and DSP applications.Chapter 24: Fax and T.38
switch.conf.xmlCore runtime parameters: RTP port range, max sessions, session rate, and database DSN.Chapter 4: Global Variables and Core Settings
syslog.conf.xmlmod_syslog syslog logger; facility and log level.Configured directly in this file.
timezones.conf.xmlTimezone name-to-POSIX-string mapping table used by strftime in the dialplan.Configured directly in this file.
translate.conf.xmlmod_translate dialplan number translation rules; pattern and replacement tables.Part 9: mod_translate
tts_commandline.conf.xmlmod_tts_commandline TTS via an external command; command template.Part 9: mod_tts_commandline
v8.conf.xmlmod_v8 embedded V8 JavaScript engine; startup script path.Chapter 28: Scripting Integration
verto.conf.xmlmod_verto WebRTC JSON-RPC endpoint; profile bind address, TLS, and codec settings.Chapter 9: WebRTC with Verto
voicemail.conf.xmlmod_voicemail voicemail profiles, storage paths, and email notification settings.Chapter 19: Voicemail
voicemail_ivr.conf.xmlmod_voicemail_ivr IVR menu customization for the voicemail self-service prompts.Part 9: mod_voicemail_ivr
vpx.conf.xmlmod_vpx VP8 and VP9 video codec via libvpx; encoder bitrate and quality settings.Chapter 16: Codecs and Negotiation
xml_cdr.conf.xmlmod_xml_cdr CDR output as XML via HTTP POST; URL and credential settings.Chapter 27: Call Detail Records
xml_curl.conf.xmlmod_xml_curl dynamic XML configuration fetched from an HTTP backend; binding and URL settings.Chapter 26: Dynamic Configuration with XML Curl
xml_rpc.conf.xmlmod_xml_rpc HTTP/XML-RPC management interface; bind port and credentials.Part 9: mod_xml_rpc
xml_scgi.conf.xmlmod_xml_scgi dynamic XML configuration via SCGI; socket path and bindings.Part 9: mod_xml_scgi
zeroconf.conf.xmlmod_zeroconf mDNS/Bonjour service advertisement settings.Configured directly in this file.