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