ebafedd9e418debdcd16678fb82ba6a7105f7527
[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 outgoing directory (where .call files are read) now uses inotify to
147   detect file changes instead of polling the directory on a regular basis.
148   If your outgoing folder is on a NFS mount or another network file system,
149   changes to the files will not be detected.  You can revert to polling the
150   directory by specifying --without-inotify to configure before compiling.
151
152 From 1.6.1 to 1.6.2:
153
154 * SIP no longer sends the 183 progress message for early media by
155   default.  Applications requiring early media should use the
156   progress() dialplan app to generate the progress message. 
157
158 * The firmware for the IAXy has been removed from Asterisk.  It can be
159   downloaded from http://downloads.digium.com/pub/iaxy/.  To have Asterisk
160   install the firmware into its proper location, place the firmware in the
161   contrib/firmware/iax/ directory in the Asterisk source tree before running
162   "make install".
163
164 * T.38 FAX error correction mode can no longer be configured in udptl.conf;
165   instead, it is configured on a per-peer (or global) basis in sip.conf, with
166   the same default as was present in udptl.conf.sample.
167
168 * T.38 FAX maximum datagram size can no longer be configured in updtl.conf;
169   instead, it is either supplied by the application servicing the T.38 channel
170   (for a FAX send or receive) or calculated from the bridged endpoint's
171   maximum datagram size (for a T.38 FAX passthrough call). In addition, sip.conf
172   allows for overriding the value supplied by a remote endpoint, which is useful
173   when T.38 connections are made to gateways that supply incorrectly-calculated
174   maximum datagram sizes.
175
176 * There have been some changes to the IAX2 protocol to address the security
177   concerns documented in the security advisory AST-2009-006.  Please see the
178   IAX2 security document, doc/IAX2-security.pdf, for information regarding
179   backwards compatibility with versions of Asterisk that do not contain these
180   changes to IAX2.
181
182 * The 'canreinvite' option support by the SIP, MGCP and Skinny channel drivers
183   has been renamed to 'directmedia', to better reflect what it actually does.
184   In the case of SIP, there are still re-INVITEs issued for T.38 negotiation,
185   starting and stopping music-on-hold, and other reasons, and the 'canreinvite'
186   option never had any effect on these cases, it only affected the re-INVITEs
187   used for direct media path setup. For MGCP and Skinny, the option was poorly
188   named because those protocols don't even use INVITE messages at all. For
189   backwards compatibility, the old option is still supported in both normal
190   and Realtime configuration files, but all of the sample configuration files,
191   Realtime/LDAP schemas, and other documentation refer to it using the new name.
192
193 * The default console now will use colors according to the default background
194   color, instead of forcing the background color to black.  If you are using a
195   light colored background for your console, you may wish to use the option
196   flag '-W' to present better color choices for the various messages.  However,
197   if you'd prefer the old method of forcing colors to white text on a black
198   background, the compatibility option -B is provided for this purpose.
199
200 * SendImage() no longer hangs up the channel on transmission error or on
201   any other error; in those cases, a FAILURE status is stored in
202   SENDIMAGESTATUS and dialplan execution continues.  The possible
203   return values stored in SENDIMAGESTATUS are: SUCCESS, FAILURE, and
204   UNSUPPORTED. ('OK' has been replaced with 'SUCCESS', and 'NOSUPPORT'
205   has been replaced with 'UNSUPPORTED').  This change makes the
206   SendImage application more consistent with other applications.
207
208 * skinny.conf now has separate sections for lines and devices.
209   Please have a look at configs/skinny.conf.sample and update
210   your skinny.conf.
211
212 * Queue names previously were treated in a case-sensitive manner,
213   meaning that queues with names like "sales" and "sALeS" would be
214   seen as unique queues. The parsing logic has changed to use
215   case-insensitive comparisons now when originally hashing based on
216   queue names, meaning that now the two queues mentioned as examples
217   earlier will be seen as having the same name.
218
219 * The SPRINTF() dialplan function has been moved into its own module,
220   func_sprintf, and is no longer included in func_strings. If you use this
221   function and do not use 'autoload=yes' in modules.conf, you will need
222   to explicitly load func_sprintf for it to be available.
223
224 * The res_indications module has been removed.  Its functionality was important
225   enough that most of it has been moved into the Asterisk core.
226   Two applications previously provided by res_indications, PlayTones and
227   StopPlayTones, have been moved into a new module, app_playtones.
228
229 * Support for Taiwanese was incorrectly supported with the "tw" language code.
230   In reality, the "tw" language code is reserved for the Twi language, native
231   to Ghana.  If you were previously using the "tw" language code, you should
232   switch to using either "zh" (for Mandarin Chinese) or "zh_TW" for Taiwan
233   specific localizations.  Additionally, "mx" should be changed to "es_MX",
234   Georgian was incorrectly specified as "ge" but should be "ka", and Czech is
235   "cs", not "cz".
236
237 * DAHDISendCallreroutingFacility() parameters are now comma-separated,
238   instead of the old pipe.
239
240 * res_jabber: autoprune has been disabled by default, to avoid misconfiguration 
241   that would end up being interpreted as a bug once Asterisk started removing 
242   the contacts from a user list.
243
244 * The cdr.conf file must exist and be configured correctly in order for CDR
245   records to be written.
246
247 From 1.6.0.1 to 1.6.1:
248
249 * The ast_agi_register_multiple() and ast_agi_unregister_multiple()
250   API calls were added in 1.6.0, so that modules that provide multiple
251   AGI commands could register/unregister them all with a single
252   step. However, these API calls were not implemented properly, and did
253   not allow the caller to know whether registration or unregistration
254   succeeded or failed. They have been redefined to now return success
255   or failure, but this means any code using these functions will need
256   be recompiled after upgrading to a version of Asterisk containing
257   these changes. In addition, the source code using these functions
258   should be reviewed to ensure it can properly react to failure
259   of registration or unregistration of its API commands.
260
261 * The ast_agi_fdprintf() API call has been renamed to ast_agi_send()
262   to better match what it really does, and the argument order has been
263   changed to be consistent with other API calls that perform similar
264   operations.
265
266 From 1.6.0.x to 1.6.1:
267
268 * In previous versions of Asterisk, due to the way objects were arranged in
269   memory by chan_sip, the order of entries in sip.conf could be adjusted to
270   control the behavior of matching against peers and users.  The way objects
271   are managed has been significantly changed for reasons involving performance
272   and stability.  A side effect of these changes is that the order of entries
273   in sip.conf can no longer be relied upon to control behavior.
274
275 * The following core commands dealing with dialplan have been deprecated: 'core
276   show globals', 'core set global' and 'core set chanvar'. Use the equivalent
277   'dialplan show globals', 'dialplan set global' and 'dialplan set chanvar'
278   instead.
279
280 * In the dialplan expression parser, the logical value of spaces
281   immediately preceding a standalone 0 previously evaluated to
282   true. It now evaluates to false.  This has confused a good many
283   people in the past (typically because they failed to realize the
284   space had any significance).  Since this violates the Principle of
285   Least Surprise, it has been changed.
286
287 * While app_directory has always relied on having a voicemail.conf or users.conf file
288   correctly set up, it now is dependent on app_voicemail being compiled as well.
289
290 * SIP: All of the functionality in SIPCHANINFO() has been implemented in CHANNEL(),
291   and you should start using that function instead for retrieving information about
292   the channel in a technology-agnostic way.
293
294 * If you have any third party modules which use a config file variable whose
295   name ends in a '+', please note that the append capability added to this
296   version may now conflict with that variable naming scheme.  An easy
297   workaround is to ensure that a space occurs between the '+' and the '=',
298   to differentiate your variable from the append operator.  This potential
299   conflict is unlikely, but is documented here to be thorough.
300
301 * The "Join" event from app_queue now uses the CallerIDNum header instead of
302   the CallerID header to indicate the CallerID number.
303
304 * If you use ODBC storage for voicemail, there is a new field called "flag"
305   which should be a char(8) or larger.  This field specifies whether or not a
306   message has been designated to be "Urgent", "PRIORITY", or not.
307