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