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