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