XML Meta Page
Primary Tasks
- Find all pages that reference XML configuration
- Categorize the pages into a target group
Documentation Tasks
- Find more information about email and voicemail config
- Read Configuring FreeSWITCH and find commonalities between other documentation attempts
Ideas
- Separate configuration docs by configuration section?
Recipes?
Dial by name directory – should go to a tutorial page
Dialing tel links with freeswitch – definitely a recipe
FreeSWITCH Scheduler API – should be made into a recipe and the rest of the content should go wherever these API things go – or maybe not? scheduler seems more appropriate from an externally controlling application.... it might be confusing used from XML dialplan
Gateway prefixes – Recipe!
Prefix_dialing – a recipe if I've ever seen one
Call Forward Example - recipe
JitterBuffer – good candidate for a recipe
Codec Negotiation – good recipe candidate
T38 Modem – consider for us with fax
https://freeswitch.org/confluence/display/FREESWITCH/Time+of+Day+and+Holiday+Routing
Ring group – good candidate for dialplan, may be good for discussing originate strings
Call Group intercept – possibly use as a recipe... if not, use as a tutorial
Dialplan FollowMe – extract the xml examples
Freeswitch IVR Originate pull out any recipe stuff
Conference Add Call Example – possible
Conference Announce Count Inline – recipe?
Outbound Conference Calls – recipe?
Tutorials/Auxiliary
FreeSWITCH PBX Example – definitely a tutorial. Needs some updates and some moving around. Firewall config should be in the networking section and referenced.
IMT – a tutorial! But with a little work, it could become a recipe
High Availability – definitely a tutorial – firewall stuff should be farmed out
SSD Tuning for Linux – aux knowledge
SBC FreeSWITCH Configuration Example 2 – definitely a tutorial
T38 Modem – building/installing an external package is auxiliary
FreeSWITCH Softphone – tutorials
Module Configuration
https://freeswitch.org/confluence/display/FREESWITCH/ACL
Default Configuration – pull out each module related piece of information to its appropriate module page
FreeSWITCH XML-RPC – send it to the module page! And don't include in any mention of actual dialplan stuff – this is about controlling freeswitch with an external application.
Sofia SIP Stack – sofia SIP config info
Configuring SIP – directory config
External Profile – external profile
Sofia Configuration Files – the sofia configuration is arguably part of the mod_sofia module, buuuut it's also really important and merits a longer explanation
Speech Phrase Management – specific to speech phrase config
Queue_which_calls_extensions – extract some fifo knowledge, but remove the rest as apparently it's outdated
Category:TTS – recipe for TTS with google speech
Directory – directory config
XML User Directory – directory config
Contact Mapping – directory config
LDAP Directory – directory config
Xmlcdrd – make sure to extract the config here
CDR and accounting variables – Do these variables apply to all the modules listed? With the same behavior?
Conference Add Call Example – possibly more useful if given as a recipe... need to see if it depends on the config
Conference Announce Count Inline – or just stay in its module page
Outbound Conference Calls – possibly stays on its own page
Core Configuration
Freeswitch for new people – discusses pre-processor which is a core config concept
macOS Email Voicemail#ConfigureFreeSWITCH%E2%84%A2Email – I can't remember whether the params there are for mod_voicemail specifically or not – to do
Windows Install – mailer-app param, but for windows
Reloading – somewhat relevant ... seems like surplus though. This is a weird mix of module concerns and core concerns.
Configuration Recipes – pull out config here to the directory config page. The call group example should exclude the XML and only reference using bridge with the very important "group/${callgroup}@${domain_name}" syntax.
vars.xml – describes some vars that are apart of core config
Default Configuration – flesh out the description of config files to core config section, the other explanations MUST be given to the modules section.
High Availability – make sure params discussed here are included, but otherwise should go to a tutorial page
XML Basics – intro to XML
Databases – dsn set xml, needs further explanation to be useful (i.e. where the variable should be set if it matters)
ODBC DSN – consolidate with other database page
PostgreSQL in the core – consolidate – do not discuss installation of postgres – it is an entirely different concern
NAT Traversal – switch conf
XML Modules Configuration – this is extraneous and needs to be streamlined into the main modules page.
https://freeswitch.org/confluence/display/FREESWITCH/Global+Variable+local+ip+v4
Static XML Dialplan
https://freeswitch.org/confluence/display/FREESWITCH/Freeswitch+for+new+people – discusses some dialplan concepts
How To's – lock negotiated codec with dialplan condition
Routing with directory parameters – a little surplus. Users will most likely have already learned about condition-field-value semantics. It's enough to simply tell them that the variables can be matched without fleshing out another condition example. This is better explained in the directory section only.
Configuration Recipes – might not be necessary in this context as it's just matching a standard destination number.
Configuring FreeSWITCH – I need to read over this. BUT it brings up something that I've noticed. Everyone is trying to re-invent the wheel! We need to consolidate this information and fill in the blanks, not start over. And starting an introduction, but introducing clutter can be hard. I think this is a good reference.
vars.xml – describes vars that can be used in the dialplan
Freeswitch.xml.fsxml – I envision a final page in the Static XML Dialplan area describing debugging tips and common mess ups or something like that.
SBC FreeSWITCH Configuration Example 2 – consider extracting any unique information from this page
https://freeswitch.org/confluence/display/FREESWITCH/Manipulating+Channel+Variables
Time of Day and Holiday Routing
Demo IVR – reference for ivr example... but this is more of a config concern
Inline Dialplan – good examples about inline dialplan
https://freeswitch.org/confluence/display/FREESWITCH/Global+Variables
Misc Destinations – probably needs to be put into a discussion about a standard installation
Core Discussion (sans XML)
Proxy Media – great explanation of proxy media, the XML part should be farmed out to sofia_config/sip_profile config
Sofia SIP Stack – discuss Sofia, but XML should be farmed out to its own section (sofia config section?)
SSD Tuning for Linux – discusses setting dsn... the core documentation should discuss all dsn config and then the tutorial should reference it
Codecs and Media – discusses setting codecs with pre-processor
Codec Negotiation – discusses variables
https://freeswitch.org/confluence/display/FREESWITCH/Global+Variables
SIP Profiles
It seems like people make a big deal out of SIP profiles and naturally isolate them from the other config.
https://freeswitch.org/confluence/display/FREESWITCH/External+Profile
Sofia Configuration Files – discusses sofia configuration files in depth
Shared Line Appearance – make the config apart of the discussion, send the rest to an auxiliary page. It might be best to have a separate space for SIP phone compatibility.
Outbound_profile – consider for inclusion
Codecs and Media – sofia config discussion for codecs
https://freeswitch.org/confluence/display/FREESWITCH/Auto+Nat
NAT – some params
NAT Traversal – various vars related to nat, some with
Example Offsite phones – may be extraneous
Inline Dialplan – make sure to pull out the profile information from here
Call Group intercept – extract directory config
https://freeswitch.org/confluence/display/FREESWITCH/mod%5Fsofia+variables
Needs Categorization
https://freeswitch.org/confluence/display/FREESWITCH/OpenBTS
Outbound_profile – may also be an interoperability concern. The examples should at least be diagrams instead of text
JitterBuffer – I'm not sure what place this has in the grand scheme of things yet
Bypass Media Overview – will ultimately need to be in a separate discussion, probably within its current category
ZRTP – has variables ZRTP IS NOW DEPREICATED and will be removed out of the docs
VAD and CNG – has variables
Lua
https://freeswitch.org/confluence/display/FREESWITCH/Cause+Code+Substitution+Example
Perl
Channels
This section needs to find a place. But the concept of a channel is important. It isn't necessarily bound to static XML dialplan even though that's where most the examples reside.
https://freeswitch.org/confluence/display/FREESWITCH/FS+Channel+Variables
https://freeswitch.org/confluence/display/FREESWITCH/Variables
https://freeswitch.org/confluence/display/FREESWITCH/temp+switch+core+variables
- Features#SharedLineAppearance(SLA) - lists XML configuration for internal sip profile
- Freeswitch for new people - second half discusses the use of XML and configuration
macOS 24x7 Preparation -has XML, but it's not FreeSWITCH XML, so doesn't apply- macOS Email Voicemail#ConfigureFreeSWITCH%E2%84%A2Email - lists XML configuration for FreeSWITCH email
- Amazon EC2 - discusses XML configuration
- Windows Install - discusses XML dialplan and XML configuration for the mailer-app
- Reloading - discusses reloading XML (`reloadxml`) and reload commands
- How To's - discusses XML dialplan to lock negotiated codec
- Routing with directory parameters
- ASR - discusses unimrcp XML configuration
- Config external.xml - should be removed
- Configuration Recipes - has a few small examples: group calls, sip_profiles
- Configuring FreeSWITCH - more introductions to XML dialplan
- Switch.conf.xml - configuration for keybindings and switch.conf
- vars.xml - another page describing vars
- Default Configuration - very partial description of XML config
- Dial by name directory - very partial description of dial_by_name XML config
- Dialing tel links with freeswitch - dialplan XML configuration for tel links
- FreeSWITCH.xml - someone giving a light description of freeswitch.xml
- Freeswitch.xml.fsxml - someone discussion freeswitch.xml.fsxml
- FreeSWITCH PBX Example - XML config for a PBX, but also includes other information, should go in the "auxiliary knowledge" section or something similar
- FreeSWITCH Scheduler API - should be split out into another page. Docs for the API and then docs for using the API with XML. It shouldn't target just the scheduler, but all API things that can be accessed from XML
- FreeSWITCH XML-RPC - likely works best if it's farmed out into individual sections for these languages - only makes sense as a light reference on the meta page
- Gateway prefixes XML configuration for gateway prefixes ... but also includes some auxiliary knowledge
- High Availability - discusses some XML config that may be best placed in an auxiliary knowledge/dedicated HA section
- IMT - discusses XML config for "inter-machine trunks", which is probably best discussed in an auxiliary knowledge section
- Prefix_dialing - discusses prefix dialing and could be placed in an XML section... there's also superfluous discussion about mod_xml_curl
- Proxy Media - has XML config discussing proxy_media
- Sofia SIP Stack discusses sofia XML configuration
- Configuring SIP - discusses vars.xml (again), internal.xml, default.xml
- External Profile more discussion on external profile
- Gateways Configuration - XML configuration for gateway
- Sofia Configuration Files - more discussion about sofia XML configuration
- Speech Phrase Management - speech phrase XML configuration
- SSD Tuning for Linux - light discussion of XML configuration for the core-db, likely makes the most sense in an auxiliary knowledge page
- TTS - XML configuration for TTS
- XML Basics another XML introduction
- XML Switch Configuration - another page about XML switch configuration
- OpenBTS - XML configuration for OpenBTS?
- Queue_which_calls_extensions XML dialplan for mod_fifo, which may be outdated
- Shared Line Appearance - more sofia XML configuration
- SBC FreeSWITCH Configuration Example 2 - an example that would be better in the prototypes section
- Outbound_profile - another discussion about outbound profiles with light information about XML config for ext-rtp-ip and ext-sip-ip
- Verto Communicator - has XML config, but is specific to a module, wouldn't make sense in a dedicated XML section
- Codecs and Media - discussion about XML config for codecs
- Bypass Media Overview - goes into a light discussion about profile config for sofia and channel variable bypass_media
- Call Forward Example XML example for call forwarding
- JitterBuffer discusses XML dialplan for application jitterbuffer and config for opus
- Codec Negotiation - discusses XML dialplan for setting codec
- ZRTP - light description of ZRTP config in XML - ZRTP IS NOW DEPREICATED and will be removed out of the docs
- VAD and CNG - show XML config for setting VAD/CNG vars
- Category:TTS - shows XML config for an IVR and for using tts from google
- T38 Modem - discusses XML dialplan for fax using t38
- Databases - discusses XML configuration for core-db
- ODBC DSN - more XML configuration for core-db
- PostgreSQL in the core – more XML config for core-db
- Lua FreeSWITCH Dbh – discusses serving XML configuration with fetch_config API and DB – should probably go to Lua section
- FreeSWITCH Databases – more discussion about XML db config
- Access Control List (ACL) discusses XML config for ACL
- Auto Nat XML config for sip profiles.... again
- MWI – another sofia profile setting for XML
- NAT – more references to XML config
- NAT Traversal – more sofia profile XML config
- Directory – discusses XML config for directory
- XML User Directory – more XML config for directory
- Contact Mapping – more about XML user directory
- LDAP Directory - discussion about dialplan_directory.conf
- __Channel Variables – lots of XML config
- FS Channel Variables - more channel variables stuff with XML examples
- Manipulating Channel Variables more examples about using XML for manipulating variables
- __Variables – has more discussion of XML with variables – should really be combined into something else
- Time of Day and Holiday Routing - more XML dialplan with config for various areas
- XML Dialplan – another "intro to XML" page
- Demo IVR - another XML IVR config example
- Example Offsite phones – more XML dialplan and sofia profile examples
- Example Extension Status – another XML dialplan example
- Zeroconf.conf.xml –
another xml conf that just links to the defunct SVN trunk - let's delete - XML Modules Configuration – discussion of modules configuration – good candidate for an XML discussion page or the modules area
- Xmlcdrd – definitely should be in a tutorial section
- XML Dialplan archive – needs to be incorporated
- Ring group - has XML dialplan bridge example
- Inline Dialplan - shows XML config for sip profiles
- Call Group intercept - more config and directory configuration
- Cause Code Substitution Example – shows XML example for usage of the script
- Dial Plan Action Perl Example - shows XML example for using perl – should really go in the perl section
- Switch core variables – more variables stuff with XML examples
- CDR and accounting variables – more XML stuff
- mod_sofia variables – has mod_sofia XML example configs
- mod_dialplan_xml variables – more XML variables
- temp switch core variables – more examples of setting variables with XML
- mod_fifo variables – shows more examples of setting variables with XML – should really be put in the mod_fifo section
- Global Variables – XML examples with global vars
- Dialplan FollowMe – more XML guidance
- Freeswitch IVR Originate More XML dialplan examples
- Misc Destinations - another document fragment about destinations
- Conference Add Call Example - XML configuration for mod_conference
- Conference Announce Count Inline – more conference XML configuration
- Outbound Conference Calls – more conference XML config
- Client and Developer Interfaces – discusses some XML modules
- FreeSWITCH Softphone – makes more sense in a prototypes/tutorials section
- FreeTDM – has some XML configs
- Freetdm.conf Examples – has examples of XML configs
- FreeTDM OpenR2 – XML configuration examples
- Java CDR Logger – looks like it might duplicate configuration for mod_xml_cdr
- JavaScript – shows XML example of calling a javascript application
- Session getVariable – definitely needs to be split out to their own page and then deleted
- Global Variable local ip v4 – needs to go to XML section about variables
- PHP ESL – has XML showing the use of socket
- PHP Example - Mod XML curl – prototype implementation for serving XML to XML_CURL
- PHP Example - Wakeup call – has more XML ... as a side note, the XML examples show javascripts :|
- IVR – more IVR XML config
- RTCP – has XML config for RTCP
- RTMP Configuration Files – has RTMP config in XML
- Troubleshooting Debugging – console config XML here
- Troubleshooting Freeswitch – more console config XML here
- Debugger – has some XML dbugging stuff??
- Debugging Freeswitch – more about XML dialplan debugging
- Logging – more XML dialplan application examples
- Reporting Issues to GitHub – more instruction for XML config of logfile.conf.xml
- RTP Issues – has more XML example configurations
- SIP Protocol Messages – more XML example dialplans
- Playing recording external media – XML example for playback
- AutoProvisioning and Dynamic Directories – mod_xml_curl setup/configuration
- Caller ID LDAP Lookup – more examples using XML....
- Detect Active Channels – shows an XML dialplan example
- ENUM Caller ID lookup – shows an example of calling a perl script from XML, but with a non-standard scripts directory
- Force transfer context example – XML example with force transfer
- Home PBX Example – PBX prototype with XML
- IVR in Perl – example IVR configuration in perl, the XML referenced uses a non-standard scripts directory
- Multi-line rollover – has XML examples and shows sofia configuration
- Regular Expression – shows some XML regex examples
- Sample Regexes – more XML regex examples
- Simple Call Forward with IVR – another xml example
- Simple Day Nite Mode – another XML example for time/date
- Multi-tenant – XML example with multi-tenant
- Advanced SBC with mod_lcr and mod_easyroute – shows more XML config, references a lot of sofia configuration
- Park & Retrieve – another XML example
- Presence - has another XML example
- Variable presence data cols – another XML example
- IVRd – has an XML example for connecting to event socket
- Mod ssh – has xml config, but it seems to be for a module
- Google Voice – this example shows some configuration in XML for jingle
- Pylons – an example that references xml_curl configuration...
- SBC_Setup – has dialplan configuration and sofia profile configuration
- SSL, SSLv2, SSLv3 – has vars.xml configuration and sip profile configuration
- PHP email – has XML configuration for setting the mailer
- HylaFax – has example XML extensions for transmitting and receiving faxes
- FreeSWITCH DB in RAMdrive – references the core-db-name
- Mumble Conference With ALSA – shows XML config for conference, portaudio
- Multi home tutorial – repeats things about registration with sip provider, directory, gateway config, etc
- Multi Homed Dual NIC How To – more xml sip profile config
- Multiple Companies – more xml config: contexts, directory
- [DEAD] Video-recording – apparently obsolete XML stuff
- Googletalk – more XML dialplan and chatplan config
- MikesNotes – has openzap config and some dialplan config
- Google Voice API – more google voice stuff with XML dialplan
- Freeswitch-nanpa-project – has example feature codes using XML dialplan