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