Move an entry from CHANGES to UPGRADE.txt.
[asterisk/asterisk.git] / UPGRADE.txt
1 ===========================================================
2 ===
3 === Information for upgrading between Asterisk 1.6 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 From 1.6.1 to 1.6.2:
65
66 * SIP no longer sends the 183 progress message for early media by
67   default.  Applications requiring early media should use the
68   progress() dialplan app to generate the progress message. 
69
70 * The firmware for the IAXy has been removed from Asterisk.  It can be
71   downloaded from http://downloads.digium.com/pub/iaxy/.  To have Asterisk
72   install the firmware into its proper location, place the firmware in the
73   contrib/firmware/iax/ directory in the Asterisk source tree before running
74   "make install".
75
76 * T.38 FAX error correction mode can no longer be configured in udptl.conf;
77   instead, it is configured on a per-peer (or global) basis in sip.conf, with
78   the same default as was present in udptl.conf.sample.
79
80 * T.38 FAX maximum datagram size can no longer be configured in updtl.conf;
81   instead, it is either supplied by the application servicing the T.38 channel
82   (for a FAX send or receive) or calculated from the bridged endpoint's
83   maximum datagram size (for a T.38 FAX passthrough call). In addition, sip.conf
84   allows for overriding the value supplied by a remote endpoint, which is useful
85   when T.38 connections are made to gateways that supply incorrectly-calculated
86   maximum datagram sizes.
87
88 * There have been some changes to the IAX2 protocol to address the security
89   concerns documented in the security advisory AST-2009-006.  Please see the
90   IAX2 security document, doc/IAX2-security.pdf, for information regarding
91   backwards compatibility with versions of Asterisk that do not contain these
92   changes to IAX2.
93
94 * The 'canreinvite' option support by the SIP, MGCP and Skinny channel drivers
95   has been renamed to 'directmedia', to better reflect what it actually does.
96   In the case of SIP, there are still re-INVITEs issued for T.38 negotiation,
97   starting and stopping music-on-hold, and other reasons, and the 'canreinvite'
98   option never had any effect on these cases, it only affected the re-INVITEs
99   used for direct media path setup. For MGCP and Skinny, the option was poorly
100   named because those protocols don't even use INVITE messages at all. For
101   backwards compatibility, the old option is still supported in both normal
102   and Realtime configuration files, but all of the sample configuration files,
103   Realtime/LDAP schemas, and other documentation refer to it using the new name.
104
105 * The default console now will use colors according to the default background
106   color, instead of forcing the background color to black.  If you are using a
107   light colored background for your console, you may wish to use the option
108   flag '-W' to present better color choices for the various messages.  However,
109   if you'd prefer the old method of forcing colors to white text on a black
110   background, the compatibility option -B is provided for this purpose.
111
112 * SendImage() no longer hangs up the channel on transmission error or on
113   any other error; in those cases, a FAILURE status is stored in
114   SENDIMAGESTATUS and dialplan execution continues.  The possible
115   return values stored in SENDIMAGESTATUS are: SUCCESS, FAILURE, and
116   UNSUPPORTED. ('OK' has been replaced with 'SUCCESS', and 'NOSUPPORT'
117   has been replaced with 'UNSUPPORTED').  This change makes the
118   SendImage application more consistent with other applications.
119
120 * skinny.conf now has separate sections for lines and devices.
121   Please have a look at configs/skinny.conf.sample and update
122   your skinny.conf.
123
124 * Queue names previously were treated in a case-sensitive manner,
125   meaning that queues with names like "sales" and "sALeS" would be
126   seen as unique queues. The parsing logic has changed to use
127   case-insensitive comparisons now when originally hashing based on
128   queue names, meaning that now the two queues mentioned as examples
129   earlier will be seen as having the same name.
130
131 * The SPRINTF() dialplan function has been moved into its own module,
132   func_sprintf, and is no longer included in func_strings. If you use this
133   function and do not use 'autoload=yes' in modules.conf, you will need
134   to explicitly load func_sprintf for it to be available.
135
136 * The res_indications module has been removed.  Its functionality was important
137   enough that most of it has been moved into the Asterisk core.
138   Two applications previously provided by res_indications, PlayTones and
139   StopPlayTones, have been moved into a new module, app_playtones.
140
141 * Support for Taiwanese was incorrectly supported with the "tw" language code.
142   In reality, the "tw" language code is reserved for the Twi language, native
143   to Ghana.  If you were previously using the "tw" language code, you should
144   switch to using either "zh" (for Mandarin Chinese) or "zh_TW" for Taiwan
145   specific localizations.  Additionally, "mx" should be changed to "es_MX",
146   Georgian was incorrectly specified as "ge" but should be "ka", and Czech is
147   "cs", not "cz".
148
149 * DAHDISendCallreroutingFacility() parameters are now comma-separated,
150   instead of the old pipe.
151
152 * res_jabber: autoprune has been disabled by default, to avoid misconfiguration 
153   that would end up being interpreted as a bug once Asterisk started removing 
154   the contacts from a user list.
155
156 From 1.6.0.1 to 1.6.1:
157
158 * The ast_agi_register_multiple() and ast_agi_unregister_multiple()
159   API calls were added in 1.6.0, so that modules that provide multiple
160   AGI commands could register/unregister them all with a single
161   step. However, these API calls were not implemented properly, and did
162   not allow the caller to know whether registration or unregistration
163   succeeded or failed. They have been redefined to now return success
164   or failure, but this means any code using these functions will need
165   be recompiled after upgrading to a version of Asterisk containing
166   these changes. In addition, the source code using these functions
167   should be reviewed to ensure it can properly react to failure
168   of registration or unregistration of its API commands.
169
170 * The ast_agi_fdprintf() API call has been renamed to ast_agi_send()
171   to better match what it really does, and the argument order has been
172   changed to be consistent with other API calls that perform similar
173   operations.
174
175 From 1.6.0.x to 1.6.1:
176
177 * In previous versions of Asterisk, due to the way objects were arranged in
178   memory by chan_sip, the order of entries in sip.conf could be adjusted to
179   control the behavior of matching against peers and users.  The way objects
180   are managed has been significantly changed for reasons involving performance
181   and stability.  A side effect of these changes is that the order of entries
182   in sip.conf can no longer be relied upon to control behavior.
183
184 * The following core commands dealing with dialplan have been deprecated: 'core
185   show globals', 'core set global' and 'core set chanvar'. Use the equivalent
186   'dialplan show globals', 'dialplan set global' and 'dialplan set chanvar'
187   instead.
188
189 * In the dialplan expression parser, the logical value of spaces
190   immediately preceding a standalone 0 previously evaluated to
191   true. It now evaluates to false.  This has confused a good many
192   people in the past (typically because they failed to realize the
193   space had any significance).  Since this violates the Principle of
194   Least Surprise, it has been changed.
195
196 * While app_directory has always relied on having a voicemail.conf or users.conf file
197   correctly set up, it now is dependent on app_voicemail being compiled as well.
198
199 * SIP: All of the functionality in SIPCHANINFO() has been implemented in CHANNEL(),
200   and you should start using that function instead for retrieving information about
201   the channel in a technology-agnostic way.
202
203 * If you have any third party modules which use a config file variable whose
204   name ends in a '+', please note that the append capability added to this
205   version may now conflict with that variable naming scheme.  An easy
206   workaround is to ensure that a space occurs between the '+' and the '=',
207   to differentiate your variable from the append operator.  This potential
208   conflict is unlikely, but is documented here to be thorough.
209
210 * The "Join" event from app_queue now uses the CallerIDNum header instead of
211   the CallerID header to indicate the CallerID number.
212
213 * If you use ODBC storage for voicemail, there is a new field called "flag"
214   which should be a char(8) or larger.  This field specifies whether or not a
215   message has been designated to be "Urgent", "PRIORITY", or not.
216