diff --git a/docs/FreeSWITCH-Explained/Auxiliary-Knowledge-and-Utilities/13173942.mdx b/docs/FreeSWITCH-Explained/Auxiliary-Knowledge-and-Utilities/13173942.mdx index a78617fd..b1d7dd92 100644 --- a/docs/FreeSWITCH-Explained/Auxiliary-Knowledge-and-Utilities/13173942.mdx +++ b/docs/FreeSWITCH-Explained/Auxiliary-Knowledge-and-Utilities/13173942.mdx @@ -3,7 +3,7 @@ -## About +## About This is how to Generate TLS certificates in win32\. A temporary solution for Windows users until an automatic script is available. diff --git a/docs/FreeSWITCH-Explained/Modules/mod_rayo_3375450.mdx b/docs/FreeSWITCH-Explained/Modules/mod_rayo_3375450.mdx deleted file mode 100644 index e1c02d62..00000000 --- a/docs/FreeSWITCH-Explained/Modules/mod_rayo_3375450.mdx +++ /dev/null @@ -1,295 +0,0 @@ - -# mod_rayo - - - -## About - -mod\_rayo is a server implementation of the [Rayo protocol](http://rayo.org) for FreeSWITCH. Rayo clients, like [Adhearsion](http://adhearsion.com) use this protocol to control calls. - - -## Installing - -To use mod\_rayo tell FreeSWITCH to compile in this module by editing modules.conf in /usr/src/freeswitch and adding: - -**modules.conf** - -```xml -event_handlers/mod_rayo -formats/mod_ssml -``` - -[mod\_ssml](./mod_ssml_3375453.mdx#about) is REQUIRED by mod\_rayo - -Now recompile FreeSWITCH. - -make -make install - -Tell FreeSWITCH to use the modules when running by adding them to modules.conf.xml in /usr/local/freeswitch/conf/autoload\_configs: - -**modules.conf.xml** - -```xml - - -``` - -## Configuration - -The conf/autoload\_configs/rayo.conf.xml file contains the following configuration settings. An example configuration is located in conf/rayo and can be installed with - -make config-rayo - -It is recommended that you start with the example rayo config and adjust the xmpp settings as needed - -### Core Settings - -**rayo.conf.xml** - -```xml - - - - - - - - - - - -``` - -### Recording Settings - -**rayo.conf.xml** - -```xml - - - - -``` - -### Input Settings - -**rayo.conf.xml** - -```xml - - - - -``` - -### Fax Settings - -```xml - - - - -``` - -### Call Progress Analysis Settings - -Call progress analysis allows the client to request FS to monitor for dtmf, call progress tones, fax tones, voicemail beeps, etc. This feature works by mapping the dialplan applications and their detection events to Rayo CPA signal-types (fax-ced, fax-cng, beep, speech, dtmf, etc). If you have an alternative detector for specific tones, simply specify the new detector's dialplan start/stop app and the events emitted. - -The only restriction is that no detector may detect the same event/subclass as previously defined detector. - - \ - \ - \ - \ - \ - \ - \ - \ - - \ - \ - \ - \ - \ - \ - \ - \ - - \ - \ - \ - \ - \ - \ - \ - - \ - \ - \ - \ - \ - \ - \ - \ - \ - \ - \ - \ - - \ - \ - \ - \ - \ - \ - \ - \ - - \ - \ - \ - -#### XMPP settings - -mod\_rayo is an XMPP server. mod\_rayo currently only supports serving a single XMPP domain. - -insecure XMPP client connection example (use only on private networks!!!) - - \ - \ - \ - \ - \ - \ - \ - \ - -Secure XMPP client connection example. This example requires TLS when connecting to mod\_rayo. You will need to generate a certificate and private key and store them in the certs directory. - - \ - \ - \ - \ - \ - \ - \ - \ - -The acl param is also available for an added layer of security. When enabled, only XMPP clients in approved networks will be accepted. Create a "rayo-clients" acl in conf/autoload\_configs/acl.conf.xml and set the acl param: - - \ - -#### Dial gateways - -Dial gateways define call endpoint routes by mapping URI prefixes to FreeSWITCH dialstring prefixes. This allows Rayo to do things like route a call addressed by phone number to the PSTN over a FreeTDM endpoint vs. routing a call with a SIP URI over a mod\_sofia gateway. - -"default" is a reserved dial prefix that matches when all other matches fail. - - \ - \ - \ - - \ - \ - - \ - \ - - \ - \ - \ - \ - \ - -#### Aliases - -Aliases are useful for testing. They allow you to map XMPP IQ requests to a short command. If the command is an IQ set command, you can omit the IQ from the alias as it is assumed by default. - -An alias requires a "target". This target is used to assist with command autocompletion. That is, if the alias target is "call", then the alias will only suggest active calls when you tab autocomplete. - -The possible targets are: - -* all -* call -* component (any component input/output/record/prompt) -* external (clients and peer servers) -* input (input components) -* internal (anything not external) -* server (mod\_rayo server) -* output (output components) -* record (record components) - - \ - \ - \\]]>\ - \ - \\]]>\ - \ - \\]]>\ - \ - \\]]>\ - \ - -### rayo APP - -Offer call to Rayo client. This is similar to the [Outbound Event Socket](../Client-and-Developer-Interfaces/Event-Socket-Library/Event-Socket-Outbound_3375460.mdx#faq) "socket" application. If there are no Rayo clients connected to FreeSWITCH when the call is offered, the call is rejected. - - \ - \ - \ - \ - \ - \ - -### rayo API - -Rayo admin console - -This API is primarily for testing or checking the status of calls offered to Rayo clients. - -#### rayo \ \ - -Execute an alias on a target JID - - rayo answer a12dg45-123ffg-2314f@rayo.example.com - -#### rayo status - -Show current status of all XMPP entities. This lists all active clients/calls/mixers/servers/components. - - rayo status - -#### rayo cmd \ \ - -Send an XMPP \ request to an XMPP entity. - -The IQ request is automatically filled with the proper from and to JIDs (Jabber IDs). - - rayo cmd 10.50.0.10 \\\ - -#### rayo presence \ online|offline - -Send admin console \ to mod\_rayo server. - -By default, the admin console is offline and will not be offered calls. If you wish to test a call over via the console, you must send online presence to the mod\_rayo server. - - rayo presence 10.50.0.10 online - -Now calls will be offered to the console client. "rayo answer \" will take control of the call. - -#### rayo msg \ \ - -Send a \ to an XMPP entity - - rayo msg c888@rayo.example.com How are you today? - - diff --git a/docs/FreeSWITCH-Explained/Modules/mod_ssml_3375453.mdx b/docs/FreeSWITCH-Explained/Modules/mod_ssml_3375453.mdx deleted file mode 100644 index f6fce691..00000000 --- a/docs/FreeSWITCH-Explained/Modules/mod_ssml_3375453.mdx +++ /dev/null @@ -1,91 +0,0 @@ - -# mod_ssml - - - -## About - -mod\_ssml implements the [SSML](http://www.w3.org/TR/speech-synthesis/) (Speech Synthesis Markup Language) and TTS (text-to-speech) file formats. - -This module is used primarily by [mod\_rayo](./mod_rayo_3375450.mdx#about). - -### Installing - -Tell FreeSWITCH to compile in this module by editing modules.conf in /usr/src/freeswitch/trunk and adding: - -```xml - formats/mod_ssml -``` - -Now go recompile FreeSWITCH. - -```xml -make -make install -``` - -Tell FreeSWITCH to actually use the module when running by adding the module to modules.conf.xml in /usr/local/freeswitch/conf/autoload\_configs: - -```xml - -``` - -### ssml.conf.xml Configuration - -The conf/autoload\_configs/ssml.conf.xml file contains the configuration. An example configuration is located in formats/mod\_ssml/conf/autoload\_configs/ssml.conf.xml. - -It is recommended that you start with the example config and adjust the settings as needed! - -#### tts-voices - -This section defines all the available voice languages and genders. mod\_ssml will search these voices for the closet match. - -```xml - - - - - - - -``` - -#### Say module integration - -These sections map languages to the appropriate FreeSWITCH say module (like [mod\_say\_en](https://70.169.193.216/index.php?title=Mod%5Fsay%5Fen&action=edit&redlink=1 "Mod say en (page does not exist)")), define say voices in order of preference, and map interpret-as to the say types and methods - -```xml - - - - - - - - - - - - - - - -``` - -#### ssml:// format - -To use the format: - -```xml -ssml://

Hello there!

 -``` - -#### tts:// format - -To use the format: - -```xml - tts://flite|slt|Hello there! -``` - -