At the request of ManxPower, include the UPGRADE.txt from 1.2 and 1.4, as well.
[asterisk/asterisk.git] / UPGRADE.txt
1 =========================================================
2 === Information for upgrading from Asterisk 1.4 to 1.6
3 ===
4 ===
5 === UPGRADE-1.2.txt -- Upgrade info for 1.0 to 1.2
6 === UPGRADE-1.4.txt -- Upgrade info for 1.2 to 1.4
7 === UPGRADE.txt     -- Upgrade info for 1.4 to 1.6
8 =========================================================
9
10 AEL:
11
12 * Macros are now implemented underneath with the Gosub() application.
13   Heaven Help You if you wrote code depending on any aspect of this!
14   Previous to 1.6, macros were implemented with the Macro() app, which
15   provided a nice feature of auto-returning. The compiler will do its
16   best to insert a Return() app call at the end of your macro if you did
17   not include it, but really, you should make sure that all execution
18   paths within your macros end in "return;".
19
20 * The conf2ael program is 'introduced' in this release; it is in a rather
21   crude state, but deemed useful for making a first pass at converting
22   extensions.conf code into AEL. More intelligence will come with time.
23
24 Core:
25
26 * The 'languageprefix' option in asterisk.conf is now deprecated, and
27   the default sound file layout for non-English sounds is the 'new
28   style' layout introduced in Asterisk 1.4 (and used by the automatic
29   sound file installer in the Makefile).
30
31 * The ast_expr2 stuff has been modified to handle floating-point numbers.
32   Numbers of the format D.D are now acceptable input for the expr parser, 
33   Where D is a string of base-10 digits. All math is now done in "long double",
34   if it is available on your compiler/architecture. This was half-way between
35   a bug-fix (because the MATH func returns fp by default), and an enhancement.
36   Also, for those counting on, or needing, integer operations, a series of
37   'functions' were also added to the expr language, to allow several styles
38   of rounding/truncation, along with a set of common floating point operations,
39   like sin, cos, tan, log, pow, etc. The ability to call external functions
40   like CDR(), etc. was also added, without having to use the ${...} notation.
41  
42 * The delimiter passed to applications has been changed to the comma (','), as
43   that is what people are used to using within extensions.conf.  If you are
44   using realtime extensions, you will need to translate your existing dialplan
45   to use this separator.  To use a literal comma, you need merely to escape it
46   with a backslash ('\').  Another possible side effect is that you may need to
47   remove the obscene level of backslashing that was necessary for the dialplan
48   to work correctly in 1.4 and previous versions.  This should make writing
49   dialplans less painful in the future, albeit with the pain of a one-time
50   conversion.
51
52 * The logger.conf option 'rotatetimestamp' has been deprecated in favor of
53   'rotatestrategy'.  This new option supports a 'rotate' strategy that more
54   closely mimics the system logger in terms of file rotation.
55
56 * The concise versions of various CLI commands are now deprecated. We recommend
57   using the manager interface (AMI) for application integration with Asterisk.
58
59 Voicemail:
60
61 * The voicemail configuration values 'maxmessage' and 'minmessage' have
62   been changed to 'maxsecs' and 'minsecs' to clarify their purpose and
63   to make them more distinguishable from 'maxmsgs', which sets folder
64   size.  The old variables will continue to work in this version, albeit
65   with a deprecation warning.
66 * If you use any interface for modifying voicemail aside from the built in
67   dialplan applications, then the option "pollmailboxes" *must* be set in
68   voicemail.conf for message waiting indication (MWI) to work properly.  This
69   is because Voicemail notification is now event based instead of polling
70   based.  The channel drivers are no longer responsible for constantly manually
71   checking mailboxes for changes so that they can send MWI information to users.
72   Examples of situations that would require this option are web interfaces to
73   voicemail or an email client in the case of using IMAP storage.
74
75 Applications:
76
77 * ChanIsAvail() now has a 't' option, which allows the specified device
78   to be queried for state without consulting the channel drivers. This
79   performs mostly a 'ChanExists' sort of function.
80 * SetCallerPres() has been replaced with the CALLERPRES() dialplan function
81   and is now deprecated.
82 * DISA()'s fifth argument is now an options argument.  If you have previously
83   used 'NOANSWER' in this argument, you'll need to convert that to the new
84   option 'n'.
85 * Macro() is now deprecated.  If you need subroutines, you should use the
86   Gosub()/Return() applications.  To replace MacroExclusive(), we have
87   introduced dialplan functions LOCK(), TRYLOCK(), and UNLOCK().  You may use
88   these functions in any location where you desire to ensure that only one
89   channel is executing that path at any one time.
90 * Read() now sets a READSTATUS variable on exit.  It does NOT automatically
91   return -1 (and hangup) anymore on error.  If you want to hangup on error,
92   you need to do so explicitly in your dialplan.
93 * Privacy() no longer uses privacy.conf, so any options must be specified
94   directly in the application arguments.
95
96 Dialplan Functions:
97
98 * QUEUE_MEMBER_COUNT() has been deprecated in favor of the QUEUE_MEMBER() function. For
99   more information, issue a "show function QUEUE_MEMBER" from the CLI.
100
101 CDR:
102
103 * The cdr_sqlite module has been marked as deprecated in favor of
104   cdr_sqlite3_custom.  It will potentially be removed from the tree
105   after Asterisk 1.6 is released.
106
107 * The cdr_odbc module now uses res_odbc to manage its connections.  The
108   username and password parameters in cdr_odbc.conf, therefore, are no
109   longer used.  The dsn parameter now points to an entry in res_odbc.conf.
110
111 Formats:
112
113 * format_wav: The GAIN preprocessor definition and source code that used it
114   is removed.  This change was made in response to user complaints of
115   choppiness or the clipping of loud signal peaks.  To increase the volume
116   of voicemail messages, use the 'volgain' option in voicemail.conf
117
118 Channel Drivers:
119
120 * SIP: a small upgrade to support the "Record" button on the SNOM360,
121   which sends a sip INFO message with a "Record: on" or "Record: off" 
122   header. If Asterisk is set up (via features.conf) to accept "One Touch Monitor"
123   requests (by default, via '*1'), then the user-configured dialpad sequence
124   is generated, and recording can be started and stopped via this button. The
125   file names and formats are all controlled via the normal mechanisms. If the
126   user has not configured the automon feature, the normal "415 Unsupported media type"
127   is returned, and nothing is done.
128 * SIP: The "call-limit" option is marked as deprecated. It still works in this version of
129   Asterisk, but will be removed in the following version. Please use the groupcount functions
130   in the dialplan to enforce call limits. The "limitonpeer" configuration option is
131   now renamed to "counteronpeer".
132 * SIP: The "username" option is now renamed to "defaultuser" to match "defaultip".
133   These are used only before registration to call a peer with the uri 
134         sip:defaultuser@defaultip
135   The "username" setting still work, but is deprecated and will not work in 
136   the next version of Asterisk.
137
138 * chan_local.c: the comma delimiter inside the channel name has been changed to a
139   semicolon, in order to make the Local channel driver compatible with the comma
140   delimiter change in applications.
141 * H323: The "tos" setting has changed name to "tos_audio" and "cos" to "cos_audio"
142   to be compatible with settings in sip.conf. The "tos" and "cos" configuration
143   is deprecated and will stop working in the next release of Asterisk.
144
145 * Console: A new console channel driver, chan_console, has been added to Asterisk.
146   This new module can not be loaded at the same time as chan_alsa or chan_oss.  The
147   default modules.conf only loads one of them (chan_oss by default).  So, unless you
148   have modified your modules.conf to not use the autoload option, then you will need
149   to modify modules.conf to add another "noload" line to ensure that only one of
150   these three modules gets loaded.
151
152 Configuration:
153
154 * pbx_dundi.c: tos parameter changed to use new values. Old values like lowdelay,
155   lowcost and other is not acceptable now. Look into qos.tex for description of 
156   this parameter.
157
158 Manager:
159
160 * Manager has been upgraded to version 1.1 with a lot of changes. 
161   Please check doc/manager_1_1.txt for information
162
163 * The IAXpeers command output has been changed to more closely resemble the
164   output of the SIPpeers command.
165
166 * cdr_manager now reports at the "cdr" level, not at "call"  You may need to
167    change your manager.conf to add the level to existing AMI users, if they
168    want to see the CDR events generated.
169