named_acl: Remove systemname option from acl.conf, use asterisk.conf value
[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.8.12 to 1.8.13:
22 * The complex processor detection and optimization has been removed from
23   the makefile in favor of using native optimization suppport when available.
24   BUILD_NATIVE can be disabled via menuselect under "Compiler Flags".
25
26 From 1.8.10 to 1.8.11:
27
28 * If no transport is specified in sip.conf, transport will default to UDP.
29   Also, if multiple transport= lines are used, only the last will be used.
30
31 From 1.6.2 to 1.8:
32
33 * chan_sip no longer sets HASH(SIP_CAUSE,<chan name>) on channels by default.
34   This must now be enabled by setting 'sipstorecause' to 'yes' in sip.conf.
35   This carries a performance penalty.
36
37 * Asterisk now requires libpri 1.4.11+ for PRI support.
38
39 * A couple of CLI commands in res_ais were changed back to their original form:
40     "ais show clm members" --> "ais clm show members"
41     "ais show evt event channels" --> "ais evt show event channels"
42
43 * The default value for 'autofill' and 'shared_lastcall' in queues.conf has
44   been changed to 'yes'.
45
46 * The default value for the alwaysauthreject option in sip.conf has been changed
47   from "no" to "yes".
48
49 * The behavior of the 'parkedcallstimeout' has changed slightly.  The formulation
50   of the extension name that a timed out parked call is delivered to when this
51   option is set to 'no' was modified such that instead of converting '/' to '0',
52   the '/' is converted to an underscore '_'.  See the updated documentation in
53   features.conf.sample for more information on the behavior of the
54   'parkedcallstimeout' option.
55
56 * Asterisk-addons no longer exists as an independent package.  Those modules
57   now live in the addons directory of the main Asterisk source tree.  They
58   are not enabled by default.  For more information about why modules live in
59   addons, see README-addons.txt.
60
61 * The rarely used 'event_log' and LOG_EVENT channel have been removed; the few
62   users of this channel in the tree have been converted to LOG_NOTICE or removed
63   (in cases where the same message was already generated to another channel).
64
65 * The usage of RTP inside of Asterisk has now become modularized. This means
66   the Asterisk RTP stack now exists as a loadable module, res_rtp_asterisk.
67   If you are not using autoload=yes in modules.conf you will need to ensure
68   it is set to load. If not, then any module which uses RTP (such as chan_sip)
69   will not be able to send or receive calls.
70
71 * The app_dahdiscan.c file has been removed, but the dialplan app DAHDIScan still 
72   remains. It now exists within app_chanspy.c and retains the exact same 
73   functionality as before. 
74
75 * The default behavior for Set, AGI, and pbx_realtime has been changed to implement
76   1.6 behavior by default, if there is no [compat] section in asterisk.conf.  In
77   prior versions, the behavior defaulted to 1.4 behavior, to assist in upgrades.
78   Specifically, that means that pbx_realtime and res_agi expect you to use commas
79   to separate arguments in applications, and Set only takes a single pair of
80   a variable name/value.  The old 1.4 behavior may still be obtained by setting
81   app_set, pbx_realtime, and res_agi each to 1.4 in the [compat] section of
82   asterisk.conf.
83
84 * The PRI channels in chan_dahdi can no longer change the channel name if a
85   different B channel is selected during call negotiation.  To prevent using
86   the channel name to infer what B channel a call is using and to avoid name
87   collisions, the channel name format is changed.
88   The new channel naming for PRI channels is:
89   DAHDI/i<span>/<number>[:<subaddress>]-<sequence-number>
90
91 * Added CHANNEL(dahdi_span), CHANNEL(dahdi_channel), and CHANNEL(dahdi_type)
92   so the dialplan can determine the B channel currently in use by the channel.
93   Use CHANNEL(no_media_path) to determine if the channel even has a B channel.
94
95 * Added AMI event DAHDIChannel to associate a DAHDI channel with an Asterisk
96   channel so AMI applications can passively determine the B channel currently
97   in use.  Calls with "no-media" as the DAHDIChannel do not have an associated
98   B channel.  No-media calls are either on hold or call-waiting.
99
100 * The ChanIsAvail application has been changed so the AVAILSTATUS variable
101   no longer contains both the device state and cause code. The cause code
102   is now available in the AVAILCAUSECODE variable. If existing dialplan logic
103   is written to expect AVAILSTATUS to contain the cause code it needs to be
104   changed to use AVAILCAUSECODE.
105
106 * ExternalIVR will now send Z events for invalid or missing files, T events
107   now include the interrupted file and bugs in argument parsing have been
108   fixed so there may be arguments specified in incorrect ways that were
109   working that will no longer work. Please see 
110   https://wiki.asterisk.org/wiki/display/AST/External+IVR+Interface for details.
111
112 * OSP lookup application changes following variable names:
113   OSPPEERIP to OSPINPEERIP
114   OSPTECH to OSPOUTTECH
115   OSPDEST to OSPDESTINATION
116   OSPCALLING to OSPOUTCALLING
117   OSPCALLED to OSPOUTCALLED
118   OSPRESULTS to OSPDESTREMAILS
119
120 * The Manager event 'iax2 show peers' output has been updated.  It now has a
121   similar output of 'sip show peers'.
122
123 * VoiceMailMain and VMAuthenticate, if a '*' is entered in the first position
124   of a Mailbox or Password, will, if it exists, jump to the 'a' extension in
125   the current dialplan context.
126
127 * The CALLERPRES() dialplan function is deprecated in favor of
128   CALLERID(num-pres) and CALLERID(name-pres).
129
130 * Environment variables that start with "AST_" are reserved to the system and
131   may no longer be set from the dialplan.
132
133 * When a call is redirected inside of a Dial, the app and appdata fields of the
134   CDR will now be set to "AppDial" and "(Outgoing Line)" instead of being blank.
135
136 * The CDR handling of billsec and duration field has changed. If your table
137   definition specifies those fields as float,double or similar they will now
138   be logged with microsecond accuracy instead of a whole integer.
139
140 * chan_sip will no longer set up a local call forward when receiving a
141   482 Loop Detected response. The dialplan will just continue from where it
142   left off.
143
144 * The 'stunaddr' option has been removed from chan_sip.  This feature did not
145   behave as expected, had no correct use case, and was not RFC compliant. The
146   removal of this feature will hopefully be followed by a correct RFC compliant
147   STUN implementation in chan_sip in the future.
148
149 * The default value for the pedantic option in sip.conf has been changed
150   from "no" to "yes".
151
152 * The ConnectedLineNum and ConnectedLineName headers were added to many AMI
153   events/responses if the CallerIDNum/CallerIDName headers were also present.
154   The addition of connected line support changes the behavior of the channel
155   caller ID somewhat.  The channel caller ID value no longer time shares with
156   the connected line ID on outgoing call legs.  The timing of some AMI
157   events/responses output the connected line ID as caller ID.  These party ID's
158   are now separate.
159
160 * The Dial application d and H options do not automatically answer the call
161   anymore.  It broke DTMF attended transfers.  Since many SIP and ISDN phones
162   cannot send DTMF before a call is connected, you need to answer the call
163   leg to those phones before using Dial with these options for them to have
164   any effect before the dialed party answers.
165
166 * The outgoing directory (where .call files are read) now uses inotify to
167   detect file changes instead of polling the directory on a regular basis.
168   If your outgoing folder is on a NFS mount or another network file system,
169   changes to the files will not be detected.  You can revert to polling the
170   directory by specifying --without-inotify to configure before compiling.
171
172 * The 'sipusers' realtime table has been removed completely. Use the 'sippeers'
173   table with type 'user' for user type objects.
174
175 * The sip.conf allowoverlap option now accepts 'dtmf' as a value.  If you
176   are using the early media DTMF overlap dialing method you now need to set
177   allowoverlap=dtmf.
178
179 From 1.6.1 to 1.6.2:
180
181 * SIP no longer sends the 183 progress message for early media by
182   default.  Applications requiring early media should use the
183   progress() dialplan app to generate the progress message. 
184
185 * The firmware for the IAXy has been removed from Asterisk.  It can be
186   downloaded from http://downloads.digium.com/pub/iaxy/.  To have Asterisk
187   install the firmware into its proper location, place the firmware in the
188   contrib/firmware/iax/ directory in the Asterisk source tree before running
189   "make install".
190
191 * T.38 FAX error correction mode can no longer be configured in udptl.conf;
192   instead, it is configured on a per-peer (or global) basis in sip.conf, with
193   the same default as was present in udptl.conf.sample.
194
195 * T.38 FAX maximum datagram size can no longer be configured in updtl.conf;
196   instead, it is either supplied by the application servicing the T.38 channel
197   (for a FAX send or receive) or calculated from the bridged endpoint's
198   maximum datagram size (for a T.38 FAX passthrough call). In addition, sip.conf
199   allows for overriding the value supplied by a remote endpoint, which is useful
200   when T.38 connections are made to gateways that supply incorrectly-calculated
201   maximum datagram sizes.
202
203 * There have been some changes to the IAX2 protocol to address the security
204   concerns documented in the security advisory AST-2009-006.  Please see the
205   IAX2 security document, doc/IAX2-security.pdf, for information regarding
206   backwards compatibility with versions of Asterisk that do not contain these
207   changes to IAX2.
208
209 * The 'canreinvite' option support by the SIP, MGCP and Skinny channel drivers
210   has been renamed to 'directmedia', to better reflect what it actually does.
211   In the case of SIP, there are still re-INVITEs issued for T.38 negotiation,
212   starting and stopping music-on-hold, and other reasons, and the 'canreinvite'
213   option never had any effect on these cases, it only affected the re-INVITEs
214   used for direct media path setup. For MGCP and Skinny, the option was poorly
215   named because those protocols don't even use INVITE messages at all. For
216   backwards compatibility, the old option is still supported in both normal
217   and Realtime configuration files, but all of the sample configuration files,
218   Realtime/LDAP schemas, and other documentation refer to it using the new name.
219
220 * The default console now will use colors according to the default background
221   color, instead of forcing the background color to black.  If you are using a
222   light colored background for your console, you may wish to use the option
223   flag '-W' to present better color choices for the various messages.  However,
224   if you'd prefer the old method of forcing colors to white text on a black
225   background, the compatibility option -B is provided for this purpose.
226
227 * SendImage() no longer hangs up the channel on transmission error or on
228   any other error; in those cases, a FAILURE status is stored in
229   SENDIMAGESTATUS and dialplan execution continues.  The possible
230   return values stored in SENDIMAGESTATUS are: SUCCESS, FAILURE, and
231   UNSUPPORTED. ('OK' has been replaced with 'SUCCESS', and 'NOSUPPORT'
232   has been replaced with 'UNSUPPORTED').  This change makes the
233   SendImage application more consistent with other applications.
234
235 * skinny.conf now has separate sections for lines and devices.
236   Please have a look at configs/skinny.conf.sample and update
237   your skinny.conf.
238
239 * Queue names previously were treated in a case-sensitive manner,
240   meaning that queues with names like "sales" and "sALeS" would be
241   seen as unique queues. The parsing logic has changed to use
242   case-insensitive comparisons now when originally hashing based on
243   queue names, meaning that now the two queues mentioned as examples
244   earlier will be seen as having the same name.
245
246 * The SPRINTF() dialplan function has been moved into its own module,
247   func_sprintf, and is no longer included in func_strings. If you use this
248   function and do not use 'autoload=yes' in modules.conf, you will need
249   to explicitly load func_sprintf for it to be available.
250
251 * The res_indications module has been removed.  Its functionality was important
252   enough that most of it has been moved into the Asterisk core.
253   Two applications previously provided by res_indications, PlayTones and
254   StopPlayTones, have been moved into a new module, app_playtones.
255
256 * Support for Taiwanese was incorrectly supported with the "tw" language code.
257   In reality, the "tw" language code is reserved for the Twi language, native
258   to Ghana.  If you were previously using the "tw" language code, you should
259   switch to using either "zh" (for Mandarin Chinese) or "zh_TW" for Taiwan
260   specific localizations.  Additionally, "mx" should be changed to "es_MX",
261   Georgian was incorrectly specified as "ge" but should be "ka", and Czech is
262   "cs", not "cz".
263
264 * DAHDISendCallreroutingFacility() parameters are now comma-separated,
265   instead of the old pipe.
266
267 * res_jabber: autoprune has been disabled by default, to avoid misconfiguration 
268   that would end up being interpreted as a bug once Asterisk started removing 
269   the contacts from a user list.
270
271 * The cdr.conf file must exist and be configured correctly in order for CDR
272   records to be written.
273
274 * cdr_pgsql now assumes the encoding of strings it is handed are in LATIN9,
275   which should cover most uses of the extended ASCII set.  If your strings
276   use a different encoding in Asterisk, the "encoding" parameter may be set
277   to specify the correct character set.
278
279 From 1.6.0.1 to 1.6.1:
280
281 * The ast_agi_register_multiple() and ast_agi_unregister_multiple()
282   API calls were added in 1.6.0, so that modules that provide multiple
283   AGI commands could register/unregister them all with a single
284   step. However, these API calls were not implemented properly, and did
285   not allow the caller to know whether registration or unregistration
286   succeeded or failed. They have been redefined to now return success
287   or failure, but this means any code using these functions will need
288   be recompiled after upgrading to a version of Asterisk containing
289   these changes. In addition, the source code using these functions
290   should be reviewed to ensure it can properly react to failure
291   of registration or unregistration of its API commands.
292
293 * The ast_agi_fdprintf() API call has been renamed to ast_agi_send()
294   to better match what it really does, and the argument order has been
295   changed to be consistent with other API calls that perform similar
296   operations.
297
298 From 1.6.0.x to 1.6.1:
299
300 * In previous versions of Asterisk, due to the way objects were arranged in
301   memory by chan_sip, the order of entries in sip.conf could be adjusted to
302   control the behavior of matching against peers and users.  The way objects
303   are managed has been significantly changed for reasons involving performance
304   and stability.  A side effect of these changes is that the order of entries
305   in sip.conf can no longer be relied upon to control behavior.
306
307 * The following core commands dealing with dialplan have been deprecated: 'core
308   show globals', 'core set global' and 'core set chanvar'. Use the equivalent
309   'dialplan show globals', 'dialplan set global' and 'dialplan set chanvar'
310   instead.
311
312 * In the dialplan expression parser, the logical value of spaces
313   immediately preceding a standalone 0 previously evaluated to
314   true. It now evaluates to false.  This has confused a good many
315   people in the past (typically because they failed to realize the
316   space had any significance).  Since this violates the Principle of
317   Least Surprise, it has been changed.
318
319 * While app_directory has always relied on having a voicemail.conf or users.conf file
320   correctly set up, it now is dependent on app_voicemail being compiled as well.
321
322 * SIP: All of the functionality in SIPCHANINFO() has been implemented in CHANNEL(),
323   and you should start using that function instead for retrieving information about
324   the channel in a technology-agnostic way.
325
326 * If you have any third party modules which use a config file variable whose
327   name ends in a '+', please note that the append capability added to this
328   version may now conflict with that variable naming scheme.  An easy
329   workaround is to ensure that a space occurs between the '+' and the '=',
330   to differentiate your variable from the append operator.  This potential
331   conflict is unlikely, but is documented here to be thorough.
332
333 * The "Join" event from app_queue now uses the CallerIDNum header instead of
334   the CallerID header to indicate the CallerID number.
335
336 * If you use ODBC storage for voicemail, there is a new field called "flag"
337   which should be a char(8) or larger.  This field specifies whether or not a
338   message has been designated to be "Urgent", "PRIORITY", or not.
339