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