/virtualboxes/blueswitch/templates/vars.xml

https://gitlab.com/voxinesshq/docker-factory · XML · 421 lines · 72 code · 21 blank · 328 comment · 0 complexity · e5d94754a53f41cacf80dedc7b28606b MD5 · raw file

  1. <include>
  2. <!-- Preprocessor Variables
  3. These are introduced when configuration strings must be consistent across modules.
  4. NOTICE: YOU CAN NOT COMMENT OUT AN X-PRE-PROCESS line, Remove the line instead.
  5. WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
  6. YOU SHOULD CHANGE THIS default_password value if you don't want to be subject to any
  7. toll fraud in the future. It's your responsibility to secure your own system.
  8. This default config is used to demonstrate the feature set of FreeSWITCH.
  9. WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
  10. -->
  11. <!-- Set local_ip_v4 to hard-coded IP -->
  12. <X-PRE-PROCESS cmd="set" data="local_ip_v4={{ freeswitch_bind_ip }}"/>
  13. <X-PRE-PROCESS cmd="set" data="default_password=1234"/>
  14. <!-- Did you change it yet? -->
  15. <!--
  16. The following variables are set dynamically - calculated if possible by freeswitch - and
  17. are available to the config as $${variable}. You can see their calculated value via fs_cli
  18. by entering eval $${variable}
  19. hostname
  20. local_ip_v4
  21. local_mask_v4
  22. local_ip_v6
  23. switch_serial
  24. base_dir
  25. recordings_dir
  26. sound_prefix
  27. sounds_dir
  28. conf_dir
  29. log_dir
  30. run_dir
  31. db_dir
  32. mod_dir
  33. htdocs_dir
  34. script_dir
  35. temp_dir
  36. grammar_dir
  37. certs_dir
  38. storage_dir
  39. cache_dir
  40. core_uuid
  41. zrtp_enabled
  42. nat_public_addr
  43. nat_private_addr
  44. nat_type
  45. -->
  46. <X-PRE-PROCESS cmd="set" data="sound_prefix=$${sounds_dir}/en/us/callie"/>
  47. <!--
  48. This setting is what sets the default domain FreeSWITCH will use if all else fails.
  49. FreeSWICH will default to $${local_ip_v4} unless changed. Changing this setting does
  50. affect the sip authentication. Please review conf/directory/default.xml for more
  51. information on this topic.
  52. -->
  53. <X-PRE-PROCESS cmd="set" data="domain=$${local_ip_v4}"/>
  54. <X-PRE-PROCESS cmd="set" data="domain_name=$${domain}"/>
  55. <X-PRE-PROCESS cmd="set" data="hold_music=local_stream://moh"/>
  56. <X-PRE-PROCESS cmd="set" data="use_profile=external"/>
  57. <X-PRE-PROCESS cmd="set" data="rtp_sdes_suites=AEAD_AES_256_GCM_8|AEAD_AES_128_GCM_8|AES_CM_256_HMAC_SHA1_80|AES_CM_192_HMAC_SHA1_80|AES_CM_128_HMAC_SHA1_80|AES_CM_256_HMAC_SHA1_32|AES_CM_192_HMAC_SHA1_32|AES_CM_128_HMAC_SHA1_32|AES_CM_128_NULL_AUTH"/>
  58. <!--
  59. Enable ZRTP globally you can override this on a per channel basis
  60. http://wiki.freeswitch.org/wiki/ZRTP (on how to enable zrtp)
  61. -->
  62. <X-PRE-PROCESS cmd="set" data="zrtp_secure_media=true"/>
  63. <!--
  64. NOTICE: When using SRTP it's critical that you do not offer or accept
  65. variable bit rate codecs, doing so would leak information and possibly
  66. compromise your SRTP stream. (FS-6404)
  67. Supported SRTP Crypto Suites:
  68. AEAD_AES_256_GCM_8
  69. ____________________________________________________________________________
  70. This algorithm is identical to AEAD_AES_256_GCM (see Section 5.2 of
  71. [RFC5116]), except that the tag length, t, is 8, and an
  72. authentication tag with a length of 8 octets (64 bits) is used.
  73. An AEAD_AES_256_GCM_8 ciphertext is exactly 8 octets longer than its
  74. corresponding plaintext.
  75. AEAD_AES_128_GCM_8
  76. ____________________________________________________________________________
  77. This algorithm is identical to AEAD_AES_128_GCM (see Section 5.1 of
  78. [RFC5116]), except that the tag length, t, is 8, and an
  79. authentication tag with a length of 8 octets (64 bits) is used.
  80. An AEAD_AES_128_GCM_8 ciphertext is exactly 8 octets longer than its
  81. corresponding plaintext.
  82. AES_CM_256_HMAC_SHA1_80 | AES_CM_192_HMAC_SHA1_80 | AES_CM_128_HMAC_SHA1_80
  83. ____________________________________________________________________________
  84. AES_CM_128_HMAC_SHA1_80 is the SRTP default AES Counter Mode cipher
  85. and HMAC-SHA1 message authentication with an 80-bit authentication
  86. tag. The master-key length is 128 bits and has a default lifetime of
  87. a maximum of 2^48 SRTP packets or 2^31 SRTCP packets, whichever comes
  88. first.
  89. AES_CM_256_HMAC_SHA1_32 | AES_CM_192_HMAC_SHA1_32 | AES_CM_128_HMAC_SHA1_32
  90. ____________________________________________________________________________
  91. This crypto-suite is identical to AES_CM_128_HMAC_SHA1_80 except that
  92. the authentication tag is 32 bits. The length of the base64-decoded key and
  93. salt value for this crypto-suite MUST be 30 octets i.e., 240 bits; otherwise,
  94. the crypto attribute is considered invalid.
  95. AES_CM_128_NULL_AUTH
  96. ____________________________________________________________________________
  97. The SRTP default cipher (AES-128 Counter Mode), but to use no authentication
  98. method. This policy is NOT RECOMMENDED unless it is unavoidable; see
  99. Section 7.5 of [RFC3711].
  100. SRTP variables that modify behaviors based on direction/leg:
  101. rtp_secure_media
  102. ____________________________________________________________________________
  103. possible values:
  104. mandatory - Accept/Offer SAVP negotiation ONLY
  105. optional - Accept/Offer SAVP/AVP with SAVP preferred
  106. forbidden - More useful for inbound to deny SAVP negotiation
  107. false - implies forbidden
  108. true - implies mandatory
  109. default if not set is accept SAVP inbound if offered.
  110. rtp_secure_media_inbound | rtp_secure_media_outbound
  111. ____________________________________________________________________________
  112. This is the same as rtp_secure_media, but would apply to either inbound
  113. or outbound offers specifically.
  114. How to specify crypto suites:
  115. ____________________________________________________________________________
  116. By default without specifying any crypto suites FreeSWITCH will offer
  117. crypto suites from strongest to weakest accepting the strongest each
  118. endpoint has in common. If you wish to force specific crypto suites you
  119. can do so by appending the suites in a comma separated list in the order
  120. that you wish to offer them in.
  121. Examples:
  122. rtp_secure_media=mandatory:AES_CM_256_HMAC_SHA1_80,AES_CM_256_HMAC_SHA1_32
  123. rtp_secure_media=true:AES_CM_256_HMAC_SHA1_80,AES_CM_256_HMAC_SHA1_32
  124. rtp_secure_media=optional:AES_CM_256_HMAC_SHA1_80
  125. rtp_secure_media=true:AES_CM_256_HMAC_SHA1_80
  126. Additionally you can narrow this down on either inbound or outbound by
  127. specifying as so:
  128. rtp_secure_media_inbound=true:AEAD_AES_256_GCM_8
  129. rtp_secure_media_inbound=mandatory:AEAD_AES_256_GCM_8
  130. rtp_secure_media_outbound=true:AEAD_AES_128_GCM_8
  131. rtp_secure_media_outbound=optional:AEAD_AES_128_GCM_8
  132. rtp_secure_media_suites
  133. ____________________________________________________________________________
  134. Optionaly you can use rtp_secure_media_suites to dictate the suite list
  135. and only use rtp_secure_media=[optional|mandatory|false|true] without having
  136. to dictate the suite list with the rtp_secure_media* variables.
  137. -->
  138. <!--
  139. Examples of codec options: (module must be compiled and loaded)
  140. codecname[@8000h|16000h|32000h[@XXi]]
  141. XX is the frame size must be multples allowed for the codec
  142. FreeSWITCH can support 10-120ms on some codecs.
  143. We do not support exceeding the MTU of the RTP packet.
  144. iLBC@30i - iLBC using mode=30 which will win in all cases.
  145. DVI4@8000h@20i - IMA ADPCM 8kHz using 20ms ptime. (multiples of 10)
  146. DVI4@16000h@40i - IMA ADPCM 16kHz using 40ms ptime. (multiples of 10)
  147. speex@8000h@20i - Speex 8kHz using 20ms ptime.
  148. speex@16000h@20i - Speex 16kHz using 20ms ptime.
  149. speex@32000h@20i - Speex 32kHz using 20ms ptime.
  150. BV16 - BroadVoice 16kb/s narrowband, 8kHz
  151. BV32 - BroadVoice 32kb/s wideband, 16kHz
  152. G7221@16000h - G722.1 16kHz (aka Siren 7)
  153. G7221@32000h - G722.1C 32kHz (aka Siren 14)
  154. CELT@32000h - CELT 32kHz, only 10ms supported
  155. CELT@48000h - CELT 48kHz, only 10ms supported
  156. GSM@40i - GSM 8kHz using 40ms ptime. (GSM is done in multiples of 20, Default is 20ms)
  157. G722 - G722 16kHz using default 20ms ptime. (multiples of 10)
  158. PCMU - G711 8kHz ulaw using default 20ms ptime. (multiples of 10)
  159. PCMA - G711 8kHz alaw using default 20ms ptime. (multiples of 10)
  160. G726-16 - G726 16kbit adpcm using default 20ms ptime. (multiples of 10)
  161. G726-24 - G726 24kbit adpcm using default 20ms ptime. (multiples of 10)
  162. G726-32 - G726 32kbit adpcm using default 20ms ptime. (multiples of 10)
  163. G726-40 - G726 40kbit adpcm using default 20ms ptime. (multiples of 10)
  164. AAL2-G726-16 - Same as G726-16 but using AAL2 packing. (multiples of 10)
  165. AAL2-G726-24 - Same as G726-24 but using AAL2 packing. (multiples of 10)
  166. AAL2-G726-32 - Same as G726-32 but using AAL2 packing. (multiples of 10)
  167. AAL2-G726-40 - Same as G726-40 but using AAL2 packing. (multiples of 10)
  168. LPC - LPC10 using 90ms ptime (only supports 90ms at this time in FreeSWITCH)
  169. L16 - L16 isn't recommended for VoIP but you can do it. L16 can exceed the MTU rather quickly.
  170. These are the passthru audio codecs:
  171. G729 - G729 in passthru mode. (mod_g729)
  172. G723 - G723.1 in passthru mode. (mod_g723_1)
  173. AMR - AMR in passthru mode. (mod_amr)
  174. These are the passthru video codecs: (mod_h26x)
  175. H261 - H.261 Video
  176. H263 - H.263 Video
  177. H263-1998 - H.263-1998 Video
  178. H263-2000 - H.263-2000 Video
  179. H264 - H.264 Video
  180. RTP Dynamic Payload Numbers currently used in FreeSWITCH and what for.
  181. 96 - AMR
  182. 97 - iLBC (30)
  183. 98 - iLBC (20)
  184. 99 - Speex 8kHz, 16kHz, 32kHz
  185. 100 -
  186. 101 - telephone-event
  187. 102 -
  188. 103 -
  189. 104 -
  190. 105 -
  191. 106 - BV16
  192. 107 - G722.1 (16kHz)
  193. 108 -
  194. 109 -
  195. 110 -
  196. 111 -
  197. 112 -
  198. 113 -
  199. 114 - CELT 32kHz, 48kHz
  200. 115 - G722.1C (32kHz)
  201. 116 -
  202. 117 - SILK 8kHz
  203. 118 - SILK 12kHz
  204. 119 - SILK 16kHz
  205. 120 - SILK 24kHz
  206. 121 - AAL2-G726-40 && G726-40
  207. 122 - AAL2-G726-32 && G726-32
  208. 123 - AAL2-G726-24 && G726-24
  209. 124 - AAL2-G726-16 && G726-16
  210. 125 -
  211. 126 -
  212. 127 - BV32
  213. -->
  214. <X-PRE-PROCESS cmd="set" data="global_codec_prefs=OPUS,G722,PCMU,PCMA,GSM"/>
  215. <X-PRE-PROCESS cmd="set" data="outbound_codec_prefs=PCMU,PCMA,GSM"/>
  216. <!--
  217. xmpp_client_profile and xmpp_server_profile
  218. xmpp_client_profile can be any string.
  219. xmpp_server_profile is appended to "dingaling_" to form the database name
  220. containing the "subscriptions" table.
  221. used by: dingaling.conf.xml enum.conf.xml
  222. -->
  223. <X-PRE-PROCESS cmd="set" data="xmpp_client_profile=xmppc"/>
  224. <X-PRE-PROCESS cmd="set" data="xmpp_server_profile=xmpps"/>
  225. <!--
  226. THIS IS ONLY USED FOR DINGALING
  227. bind_server_ip
  228. Can be an ip address, a dns name, or "auto".
  229. This determines an ip address available on this host to bind.
  230. If you are separating RTP and SIP traffic, you will want to have
  231. use different addresses where this variable appears.
  232. Used by: dingaling.conf.xml
  233. -->
  234. <X-PRE-PROCESS cmd="set" data="bind_server_ip=auto"/>
  235. <!-- NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE
  236. If you're going to load test FreeSWITCH please input real IP addresses
  237. for external_rtp_ip and external_sip_ip
  238. -->
  239. <!-- external_rtp_ip
  240. Can be an one of:
  241. ip address: "12.34.56.78"
  242. a stun server lookup: "stun:stun.server.com"
  243. a DNS name: "host:host.server.com"
  244. where fs.mydomain.com is a DNS A record-useful when fs is on
  245. a dynamic IP address, and uses a dynamic DNS updater.
  246. If unspecified, the bind_server_ip value is used.
  247. Used by: sofia.conf.xml dingaling.conf.xml
  248. -->
  249. <X-PRE-PROCESS cmd="set" data="external_rtp_ip={{ external_rtp_ip }}"/>
  250. <!-- external_sip_ip
  251. Used as the public IP address for SDP.
  252. Can be an one of:
  253. ip address: "12.34.56.78"
  254. a stun server lookup: "stun:stun.server.com"
  255. a DNS name: "host:host.server.com"
  256. where fs.mydomain.com is a DNS A record-useful when fs is on
  257. a dynamic IP address, and uses a dynamic DNS updater.
  258. If unspecified, the bind_server_ip value is used.
  259. Used by: sofia.conf.xml dingaling.conf.xml
  260. -->
  261. <X-PRE-PROCESS cmd="set" data="external_sip_ip={{ external_sip_ip }}"/>
  262. <!-- unroll-loops
  263. Used to turn on sip loopback unrolling.
  264. -->
  265. <X-PRE-PROCESS cmd="set" data="unroll_loops=true"/>
  266. <!-- outbound_caller_id and outbound_caller_name
  267. The caller ID telephone number we should use when calling out.
  268. Used by: conference.conf.xml and user directory for default
  269. outbound callerid name and number.
  270. -->
  271. <X-PRE-PROCESS cmd="set" data="outbound_caller_name=FreeSWITCH"/>
  272. <X-PRE-PROCESS cmd="set" data="outbound_caller_id=0000000000"/>
  273. <!-- various debug and defaults -->
  274. <X-PRE-PROCESS cmd="set" data="call_debug=false"/>
  275. <X-PRE-PROCESS cmd="set" data="console_loglevel=info"/>
  276. <X-PRE-PROCESS cmd="set" data="default_areacode=918"/>
  277. <X-PRE-PROCESS cmd="set" data="default_country=US"/>
  278. <!-- if false or undefined, the destination number is included in presence NOTIFY dm:note.
  279. if true, the destination number is not included -->
  280. <X-PRE-PROCESS cmd="set" data="presence_privacy=false"/>
  281. <X-PRE-PROCESS cmd="set" data="be-ring=%(1000,3000,425)"/>
  282. <X-PRE-PROCESS cmd="set" data="ca-ring=%(2000,4000,440,480)"/>
  283. <X-PRE-PROCESS cmd="set" data="cn-ring=%(1000,4000,450)"/>
  284. <X-PRE-PROCESS cmd="set" data="cy-ring=%(1500,3000,425)"/>
  285. <X-PRE-PROCESS cmd="set" data="cz-ring=%(1000,4000,425)"/>
  286. <X-PRE-PROCESS cmd="set" data="de-ring=%(1000,4000,425)"/>
  287. <X-PRE-PROCESS cmd="set" data="dk-ring=%(1000,4000,425)"/>
  288. <X-PRE-PROCESS cmd="set" data="dz-ring=%(1500,3500,425)"/>
  289. <X-PRE-PROCESS cmd="set" data="eg-ring=%(2000,1000,475,375)"/>
  290. <X-PRE-PROCESS cmd="set" data="es-ring=%(1500,3000,425)"/>
  291. <X-PRE-PROCESS cmd="set" data="fi-ring=%(1000,4000,425)"/>
  292. <X-PRE-PROCESS cmd="set" data="fr-ring=%(1500,3500,440)"/>
  293. <X-PRE-PROCESS cmd="set" data="hk-ring=%(400,200,440,480);%(400,3000,440,480)"/>
  294. <X-PRE-PROCESS cmd="set" data="hu-ring=%(1250,3750,425)"/>
  295. <X-PRE-PROCESS cmd="set" data="il-ring=%(1000,3000,400)"/>
  296. <X-PRE-PROCESS cmd="set" data="in-ring=%(400,200,425,375);%(400,2000,425,375)"/>
  297. <X-PRE-PROCESS cmd="set" data="jp-ring=%(1000,2000,420,380)"/>
  298. <X-PRE-PROCESS cmd="set" data="ko-ring=%(1000,2000,440,480)"/>
  299. <X-PRE-PROCESS cmd="set" data="pk-ring=%(1000,2000,400)"/>
  300. <X-PRE-PROCESS cmd="set" data="pl-ring=%(1000,4000,425)"/>
  301. <X-PRE-PROCESS cmd="set" data="ro-ring=%(1850,4150,475,425)"/>
  302. <X-PRE-PROCESS cmd="set" data="rs-ring=%(1000,4000,425)"/>
  303. <X-PRE-PROCESS cmd="set" data="ru-ring=%(800,3200,425)"/>
  304. <X-PRE-PROCESS cmd="set" data="sa-ring=%(1200,4600,425)"/>
  305. <X-PRE-PROCESS cmd="set" data="tr-ring=%(2000,4000,450)"/>
  306. <X-PRE-PROCESS cmd="set" data="uk-ring=%(400,200,400,450);%(400,2000,400,450)"/>
  307. <X-PRE-PROCESS cmd="set" data="us-ring=%(2000,4000,440,480)"/>
  308. <X-PRE-PROCESS cmd="set" data="bong-ring=v=-7;%(100,0,941.0,1477.0);v=-7;>=2;+=.1;%(1400,0,350,440)"/>
  309. <X-PRE-PROCESS cmd="set" data="beep=%(1000,0,640)"/>
  310. <X-PRE-PROCESS cmd="set" data="sit=%(274,0,913.8);%(274,0,1370.6);%(380,0,1776.7)"/>
  311. <!--
  312. Setting up your default sip provider is easy.
  313. Below are some values that should work in most cases.
  314. These are for conf/directory/default/example.com.xml
  315. -->
  316. <X-PRE-PROCESS cmd="set" data="default_provider=example.com"/>
  317. <X-PRE-PROCESS cmd="set" data="default_provider_username=joeuser"/>
  318. <X-PRE-PROCESS cmd="set" data="default_provider_password=password"/>
  319. <X-PRE-PROCESS cmd="set" data="default_provider_from_domain=example.com"/>
  320. <!-- true or false -->
  321. <X-PRE-PROCESS cmd="set" data="default_provider_register=false"/>
  322. <X-PRE-PROCESS cmd="set" data="default_provider_contact=5000"/>
  323. <!--
  324. SIP and TLS settings. http://wiki.freeswitch.org/wiki/Tls
  325. valid options: sslv2,sslv3,sslv23,tlsv1,tlsv1.1,tlsv1.2
  326. default: tlsv1,tlsv1.1,tlsv1.2
  327. -->
  328. <X-PRE-PROCESS cmd="set" data="sip_tls_version=tlsv1,tlsv1.1,tlsv1.2"/>
  329. <!--
  330. TLS cipher suite: default ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
  331. The actual ciphers supported will change per platform.
  332. openssl ciphers -v 'ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH'
  333. Will show you what is available in your verion of openssl.
  334. Freeswitch does not support non-Elliptic Curve Diffie Hellman key
  335. exchange.
  336. -->
  337. <X-PRE-PROCESS cmd="set" data="sip_tls_ciphers=ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH"/>
  338. <!-- Internal SIP Profile -->
  339. <X-PRE-PROCESS cmd="set" data="internal_auth_calls=true"/>
  340. <X-PRE-PROCESS cmd="set" data="internal_sip_port=5060"/>
  341. <X-PRE-PROCESS cmd="set" data="internal_tls_port=5061"/>
  342. <X-PRE-PROCESS cmd="set" data="internal_ssl_enable=false"/>
  343. <!-- External SIP Profile -->
  344. <X-PRE-PROCESS cmd="set" data="external_auth_calls=false"/>
  345. <X-PRE-PROCESS cmd="set" data="external_sip_port=5080"/>
  346. <X-PRE-PROCESS cmd="set" data="external_tls_port=5081"/>
  347. <X-PRE-PROCESS cmd="set" data="external_ssl_enable=false"/>
  348. </include>