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