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