UPGRADE-1.8.txt

   1 ===========================================================
   2 ===
   3 === Information for upgrading between Asterisk versions
   4 ===
   5 === These files document all the changes that MUST be taken
   6 === into account when upgrading between the Asterisk
   7 === versions listed below. These changes may require that
   8 === you modify your configuration files, dialplan or (in
   9 === some cases) source code if you have your own Asterisk
  10 === modules or patches. These files also includes advance
  11 === notice of any functionality that has been marked as
  12 === 'deprecated' and may be removed in a future release,
  13 === along with the suggested replacement functionality.
  14 ===
  15 === UPGRADE-1.2.txt -- Upgrade info for 1.0 to 1.2
  16 === UPGRADE-1.4.txt -- Upgrade info for 1.2 to 1.4
  17 === UPGRADE-1.6.txt -- Upgrade info for 1.4 to 1.6
  18 ===
  19 ===========================================================
  20
  21 From 1.8.13 to 1.8.14:
  22 * permitdirectmedia/denydirectmedia now controls whether peers can be
  23   bridged via directmedia by comparing the ACL to the bridging peer's
  24   address rather than its own address.
  25
  26 From 1.8.12 to 1.8.13:
  27 * The complex processor detection and optimization has been removed from
  28   the makefile in favor of using native optimization suppport when available.
  29   BUILD_NATIVE can be disabled via menuselect under "Compiler Flags".
  30
  31 From 1.8.10 to 1.8.11:
  32
  33 * If no transport is specified in sip.conf, transport will default to UDP.
  34   Also, if multiple transport= lines are used, only the last will be used.
  35
  36 From 1.6.2 to 1.8:
  37
  38 * chan_sip no longer sets HASH(SIP_CAUSE,<chan name>) on channels by default.
  39   This must now be enabled by setting 'sipstorecause' to 'yes' in sip.conf.
  40   This carries a performance penalty.
  41
  42 * Asterisk now requires libpri 1.4.11+ for PRI support.
  43
  44 * A couple of CLI commands in res_ais were changed back to their original form:
  45     "ais show clm members" --> "ais clm show members"
  46     "ais show evt event channels" --> "ais evt show event channels"
  47
  48 * The default value for 'autofill' and 'shared_lastcall' in queues.conf has
  49   been changed to 'yes'.
  50
  51 * The default value for the alwaysauthreject option in sip.conf has been changed
  52   from "no" to "yes".
  53
  54 * The behavior of the 'parkedcallstimeout' has changed slightly.  The formulation
  55   of the extension name that a timed out parked call is delivered to when this
  56   option is set to 'no' was modified such that instead of converting '/' to '0',
  57   the '/' is converted to an underscore '_'.  See the updated documentation in
  58   features.conf.sample for more information on the behavior of the
  59   'parkedcallstimeout' option.
  60
  61 * Asterisk-addons no longer exists as an independent package.  Those modules
  62   now live in the addons directory of the main Asterisk source tree.  They
  63   are not enabled by default.  For more information about why modules live in
  64   addons, see README-addons.txt.
  65
  66 * The rarely used 'event_log' and LOG_EVENT channel have been removed; the few
  67   users of this channel in the tree have been converted to LOG_NOTICE or removed
  68   (in cases where the same message was already generated to another channel).
  69
  70 * The usage of RTP inside of Asterisk has now become modularized. This means
  71   the Asterisk RTP stack now exists as a loadable module, res_rtp_asterisk.
  72   If you are not using autoload=yes in modules.conf you will need to ensure
  73   it is set to load. If not, then any module which uses RTP (such as chan_sip)
  74   will not be able to send or receive calls.
  75
  76 * The app_dahdiscan.c file has been removed, but the dialplan app DAHDIScan still
  77   remains. It now exists within app_chanspy.c and retains the exact same
  78   functionality as before.
  79
  80 * The default behavior for Set, AGI, and pbx_realtime has been changed to implement
  81   1.6 behavior by default, if there is no [compat] section in asterisk.conf.  In
  82   prior versions, the behavior defaulted to 1.4 behavior, to assist in upgrades.
  83   Specifically, that means that pbx_realtime and res_agi expect you to use commas
  84   to separate arguments in applications, and Set only takes a single pair of
  85   a variable name/value.  The old 1.4 behavior may still be obtained by setting
  86   app_set, pbx_realtime, and res_agi each to 1.4 in the [compat] section of
  87   asterisk.conf.
  88
  89 * The PRI channels in chan_dahdi can no longer change the channel name if a
  90   different B channel is selected during call negotiation.  To prevent using
  91   the channel name to infer what B channel a call is using and to avoid name
  92   collisions, the channel name format is changed.
  93   The new channel naming for PRI channels is:
  94   DAHDI/i<span>/<number>[:<subaddress>]-<sequence-number>
  95
  96 * Added CHANNEL(dahdi_span), CHANNEL(dahdi_channel), and CHANNEL(dahdi_type)
  97   so the dialplan can determine the B channel currently in use by the channel.
  98   Use CHANNEL(no_media_path) to determine if the channel even has a B channel.
  99
 100 * Added AMI event DAHDIChannel to associate a DAHDI channel with an Asterisk
 101   channel so AMI applications can passively determine the B channel currently
 102   in use.  Calls with "no-media" as the DAHDIChannel do not have an associated
 103   B channel.  No-media calls are either on hold or call-waiting.
 104
 105 * The ChanIsAvail application has been changed so the AVAILSTATUS variable
 106   no longer contains both the device state and cause code. The cause code
 107   is now available in the AVAILCAUSECODE variable. If existing dialplan logic
 108   is written to expect AVAILSTATUS to contain the cause code it needs to be
 109   changed to use AVAILCAUSECODE.
 110
 111 * ExternalIVR will now send Z events for invalid or missing files, T events
 112   now include the interrupted file and bugs in argument parsing have been
 113   fixed so there may be arguments specified in incorrect ways that were
 114   working that will no longer work. Please see
 115   https://wiki.asterisk.org/wiki/display/AST/External+IVR+Interface for details.
 116
 117 * OSP lookup application changes following variable names:
 118   OSPPEERIP to OSPINPEERIP
 119   OSPTECH to OSPOUTTECH
 120   OSPDEST to OSPDESTINATION
 121   OSPCALLING to OSPOUTCALLING
 122   OSPCALLED to OSPOUTCALLED
 123   OSPRESULTS to OSPDESTREMAILS
 124
 125 * The Manager event 'iax2 show peers' output has been updated.  It now has a
 126   similar output of 'sip show peers'.
 127
 128 * VoiceMailMain and VMAuthenticate, if a '*' is entered in the first position
 129   of a Mailbox or Password, will, if it exists, jump to the 'a' extension in
 130   the current dialplan context.
 131
 132 * The CALLERPRES() dialplan function is deprecated in favor of
 133   CALLERID(num-pres) and CALLERID(name-pres).
 134
 135 * Environment variables that start with "AST_" are reserved to the system and
 136   may no longer be set from the dialplan.
 137
 138 * When a call is redirected inside of a Dial, the app and appdata fields of the
 139   CDR will now be set to "AppDial" and "(Outgoing Line)" instead of being blank.
 140
 141 * The CDR handling of billsec and duration field has changed. If your table
 142   definition specifies those fields as float,double or similar they will now
 143   be logged with microsecond accuracy instead of a whole integer.
 144
 145 * chan_sip will no longer set up a local call forward when receiving a
 146   482 Loop Detected response. The dialplan will just continue from where it
 147   left off.
 148
 149 * The 'stunaddr' option has been removed from chan_sip.  This feature did not
 150   behave as expected, had no correct use case, and was not RFC compliant. The
 151   removal of this feature will hopefully be followed by a correct RFC compliant
 152   STUN implementation in chan_sip in the future.
 153
 154 * The default value for the pedantic option in sip.conf has been changed
 155   from "no" to "yes".
 156
 157 * The ConnectedLineNum and ConnectedLineName headers were added to many AMI
 158   events/responses if the CallerIDNum/CallerIDName headers were also present.
 159   The addition of connected line support changes the behavior of the channel
 160   caller ID somewhat.  The channel caller ID value no longer time shares with
 161   the connected line ID on outgoing call legs.  The timing of some AMI
 162   events/responses output the connected line ID as caller ID.  These party ID's
 163   are now separate.
 164
 165 * The Dial application d and H options do not automatically answer the call
 166   anymore.  It broke DTMF attended transfers.  Since many SIP and ISDN phones
 167   cannot send DTMF before a call is connected, you need to answer the call
 168   leg to those phones before using Dial with these options for them to have
 169   any effect before the dialed party answers.
 170
 171 * The outgoing directory (where .call files are read) now uses inotify to
 172   detect file changes instead of polling the directory on a regular basis.
 173   If your outgoing folder is on a NFS mount or another network file system,
 174   changes to the files will not be detected.  You can revert to polling the
 175   directory by specifying --without-inotify to configure before compiling.
 176
 177 * The 'sipusers' realtime table has been removed completely. Use the 'sippeers'
 178   table with type 'user' for user type objects.
 179
 180 * The sip.conf allowoverlap option now accepts 'dtmf' as a value.  If you
 181   are using the early media DTMF overlap dialing method you now need to set
 182   allowoverlap=dtmf.
 183
 184 From 1.6.1 to 1.6.2:
 185
 186 * SIP no longer sends the 183 progress message for early media by
 187   default.  Applications requiring early media should use the
 188   progress() dialplan app to generate the progress message.
 189
 190 * The firmware for the IAXy has been removed from Asterisk.  It can be
 191   downloaded from http://downloads.digium.com/pub/iaxy/.  To have Asterisk
 192   install the firmware into its proper location, place the firmware in the
 193   contrib/firmware/iax/ directory in the Asterisk source tree before running
 194   "make install".
 195
 196 * T.38 FAX error correction mode can no longer be configured in udptl.conf;
 197   instead, it is configured on a per-peer (or global) basis in sip.conf, with
 198   the same default as was present in udptl.conf.sample.
 199
 200 * T.38 FAX maximum datagram size can no longer be configured in updtl.conf;
 201   instead, it is either supplied by the application servicing the T.38 channel
 202   (for a FAX send or receive) or calculated from the bridged endpoint's
 203   maximum datagram size (for a T.38 FAX passthrough call). In addition, sip.conf
 204   allows for overriding the value supplied by a remote endpoint, which is useful
 205   when T.38 connections are made to gateways that supply incorrectly-calculated
 206   maximum datagram sizes.
 207
 208 * There have been some changes to the IAX2 protocol to address the security
 209   concerns documented in the security advisory AST-2009-006.  Please see the
 210   IAX2 security document, doc/IAX2-security.pdf, for information regarding
 211   backwards compatibility with versions of Asterisk that do not contain these
 212   changes to IAX2.
 213
 214 * The 'canreinvite' option support by the SIP, MGCP and Skinny channel drivers
 215   has been renamed to 'directmedia', to better reflect what it actually does.
 216   In the case of SIP, there are still re-INVITEs issued for T.38 negotiation,
 217   starting and stopping music-on-hold, and other reasons, and the 'canreinvite'
 218   option never had any effect on these cases, it only affected the re-INVITEs
 219   used for direct media path setup. For MGCP and Skinny, the option was poorly
 220   named because those protocols don't even use INVITE messages at all. For
 221   backwards compatibility, the old option is still supported in both normal
 222   and Realtime configuration files, but all of the sample configuration files,
 223   Realtime/LDAP schemas, and other documentation refer to it using the new name.
 224
 225 * The default console now will use colors according to the default background
 226   color, instead of forcing the background color to black.  If you are using a
 227   light colored background for your console, you may wish to use the option
 228   flag '-W' to present better color choices for the various messages.  However,
 229   if you'd prefer the old method of forcing colors to white text on a black
 230   background, the compatibility option -B is provided for this purpose.
 231
 232 * SendImage() no longer hangs up the channel on transmission error or on
 233   any other error; in those cases, a FAILURE status is stored in
 234   SENDIMAGESTATUS and dialplan execution continues.  The possible
 235   return values stored in SENDIMAGESTATUS are: SUCCESS, FAILURE, and
 236   UNSUPPORTED. ('OK' has been replaced with 'SUCCESS', and 'NOSUPPORT'
 237   has been replaced with 'UNSUPPORTED').  This change makes the
 238   SendImage application more consistent with other applications.
 239
 240 * skinny.conf now has separate sections for lines and devices.
 241   Please have a look at configs/skinny.conf.sample and update
 242   your skinny.conf.
 243
 244 * Queue names previously were treated in a case-sensitive manner,
 245   meaning that queues with names like "sales" and "sALeS" would be
 246   seen as unique queues. The parsing logic has changed to use
 247   case-insensitive comparisons now when originally hashing based on
 248   queue names, meaning that now the two queues mentioned as examples
 249   earlier will be seen as having the same name.
 250
 251 * The SPRINTF() dialplan function has been moved into its own module,
 252   func_sprintf, and is no longer included in func_strings. If you use this
 253   function and do not use 'autoload=yes' in modules.conf, you will need
 254   to explicitly load func_sprintf for it to be available.
 255
 256 * The res_indications module has been removed.  Its functionality was important
 257   enough that most of it has been moved into the Asterisk core.
 258   Two applications previously provided by res_indications, PlayTones and
 259   StopPlayTones, have been moved into a new module, app_playtones.
 260
 261 * Support for Taiwanese was incorrectly supported with the "tw" language code.
 262   In reality, the "tw" language code is reserved for the Twi language, native
 263   to Ghana.  If you were previously using the "tw" language code, you should
 264   switch to using either "zh" (for Mandarin Chinese) or "zh_TW" for Taiwan
 265   specific localizations.  Additionally, "mx" should be changed to "es_MX",
 266   Georgian was incorrectly specified as "ge" but should be "ka", and Czech is
 267   "cs", not "cz".
 268
 269 * DAHDISendCallreroutingFacility() parameters are now comma-separated,
 270   instead of the old pipe.
 271
 272 * res_jabber: autoprune has been disabled by default, to avoid misconfiguration
 273   that would end up being interpreted as a bug once Asterisk started removing
 274   the contacts from a user list.
 275
 276 * The cdr.conf file must exist and be configured correctly in order for CDR
 277   records to be written.
 278
 279 * cdr_pgsql now assumes the encoding of strings it is handed are in LATIN9,
 280   which should cover most uses of the extended ASCII set.  If your strings
 281   use a different encoding in Asterisk, the "encoding" parameter may be set
 282   to specify the correct character set.
 283
 284 From 1.6.0.1 to 1.6.1:
 285
 286 * The ast_agi_register_multiple() and ast_agi_unregister_multiple()
 287   API calls were added in 1.6.0, so that modules that provide multiple
 288   AGI commands could register/unregister them all with a single
 289   step. However, these API calls were not implemented properly, and did
 290   not allow the caller to know whether registration or unregistration
 291   succeeded or failed. They have been redefined to now return success
 292   or failure, but this means any code using these functions will need
 293   be recompiled after upgrading to a version of Asterisk containing
 294   these changes. In addition, the source code using these functions
 295   should be reviewed to ensure it can properly react to failure
 296   of registration or unregistration of its API commands.
 297
 298 * The ast_agi_fdprintf() API call has been renamed to ast_agi_send()
 299   to better match what it really does, and the argument order has been
 300   changed to be consistent with other API calls that perform similar
 301   operations.
 302
 303 From 1.6.0.x to 1.6.1:
 304
 305 * In previous versions of Asterisk, due to the way objects were arranged in
 306   memory by chan_sip, the order of entries in sip.conf could be adjusted to
 307   control the behavior of matching against peers and users.  The way objects
 308   are managed has been significantly changed for reasons involving performance
 309   and stability.  A side effect of these changes is that the order of entries
 310   in sip.conf can no longer be relied upon to control behavior.
 311
 312 * The following core commands dealing with dialplan have been deprecated: 'core
 313   show globals', 'core set global' and 'core set chanvar'. Use the equivalent
 314   'dialplan show globals', 'dialplan set global' and 'dialplan set chanvar'
 315   instead.
 316
 317 * In the dialplan expression parser, the logical value of spaces
 318   immediately preceding a standalone 0 previously evaluated to
 319   true. It now evaluates to false.  This has confused a good many
 320   people in the past (typically because they failed to realize the
 321   space had any significance).  Since this violates the Principle of
 322   Least Surprise, it has been changed.
 323
 324 * While app_directory has always relied on having a voicemail.conf or users.conf file
 325   correctly set up, it now is dependent on app_voicemail being compiled as well.
 326
 327 * SIP: All of the functionality in SIPCHANINFO() has been implemented in CHANNEL(),
 328   and you should start using that function instead for retrieving information about
 329   the channel in a technology-agnostic way.
 330
 331 * If you have any third party modules which use a config file variable whose
 332   name ends in a '+', please note that the append capability added to this
 333   version may now conflict with that variable naming scheme.  An easy
 334   workaround is to ensure that a space occurs between the '+' and the '=',
 335   to differentiate your variable from the append operator.  This potential
 336   conflict is unlikely, but is documented here to be thorough.
 337
 338 * The "Join" event from app_queue now uses the CallerIDNum header instead of
 339   the CallerID header to indicate the CallerID number.
 340
 341 * If you use ODBC storage for voicemail, there is a new field called "flag"
 342   which should be a char(8) or larger.  This field specifies whether or not a
 343   message has been designated to be "Urgent", "PRIORITY", or not.
 344