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