Multiple revisions 400508,400842-400843,400848
[asterisk/asterisk.git] / UPGRADE-11.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 include 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 === UPGRADE-1.8.txt -- Upgrade info for 1.6 to 1.8
19 === UPGRADE-10.txt -- Upgrade info for 1.8 to 10
20 ===
21 ===========================================================
22 From 11.5 to 11.6:
23 * res_agi will now properly indicate if there was an error in streaming an
24   audio file.  The result code will be -1 and the result returned from the
25   the function will be RESULT_FAILURE instead of the prior behavior of always
26   returning RESULT_SUCCESS even if there was an error.
27
28 From 11.4 to 11.5:
29 * The default settings for chan_sip are now overriden properly by the general
30   settings in sip.conf.  Please look over your settings upon upgrading.
31
32 From 11.3 to 11.4:
33 * Added the 'n' option to MeetMe to prevent application of the DENOISE function
34   to a channel joining a conference. Some channel drivers that vary the number
35   of audio samples in a voice frame will experience significant quality problems
36   if a denoiser is attached to the channel; this option gives them the ability
37   to remove the denoiser without having to unload func_speex.
38
39 * The Registry AMI event for SIP registrations will now always include the
40   Username field. A previous bug fix missed an instance where it was not
41   included; that has been corrected in this release.
42
43 From 11.2.0 to 11.2.1:
44 * Asterisk would previously not output certain error messages when a remote
45   console attempted to connect to Asterisk and no instance of Asterisk was
46   running. This error message is displayed on stderr; as a result, some
47   initialization scripts that used remote consoles to test for the presence
48   of a running Asterisk instance started to display erroneous error messages.
49   The init.d scripts and the safe_asterisk have been updated in the contrib
50   folder to account for this.
51
52 From 11.2 to 11.3:
53
54 * Now by default, when Asterisk is installed in a path other than /usr, the
55   Asterisk binary will search for shared libraries in ${libdir} in addition to
56   searching system libraries. This allows Asterisk to find its shared
57   libraries without having to specify LD_LIBRARY_PATH. This can be disabled by
58   passing --disable-rpath to configure.
59
60 From 10 to 11:
61
62 Voicemail:
63  - All voicemails now have a "msg_id" which uniquely identifies a message. For
64    users of filesystem and IMAP storage of voicemail, this should be transparent.
65    For users of ODBC, you will need to add a "msg_id" column to your voice mail
66    messages table. This should be a string capable of holding at least 32 characters.
67    All messages created in old Asterisk installations will have a msg_id added to
68    them when required. This operation should be transparent as well.
69
70 Parking:
71  - The comebacktoorigin setting must now be set per parking lot. The setting in
72    the general section will not be applied automatically to each parking lot.
73  - The BLINDTRANSFER channel variable is deleted from a channel when it is
74    bridged to prevent subtle bugs in the parking feature.  The channel
75    variable is used by Asterisk internally for the Park application to work
76    properly.  If you were using it for your own purposes, copy it to your
77    own channel variable before the channel is bridged.
78
79 res_ais:
80  - Users of res_ais in versions of Asterisk prior to Asterisk 11 must change
81    to use the res_corosync module, instead.  OpenAIS is deprecated, but
82    Corosync is still actively developed and maintained.  Corosync came out of
83    the OpenAIS project.
84
85 Dialplan Functions:
86  - MAILBOX_EXISTS has been deprecated. Use VM_INFO with the 'exists' parameter
87    instead.
88  - Macro has been deprecated in favor of GoSub.  For redirecting and connected
89    line purposes use the following variables instead of their macro equivalents:
90    REDIRECTING_SEND_SUB, REDIRECTING_SEND_SUB_ARGS,
91    CONNECTED_LINE_SEND_SUB, CONNECTED_LINE_SEND_SUB_ARGS.
92  - The REDIRECTING function now supports the redirecting original party id
93    and reason.
94  - The HANGUPCAUSE and HANGUPCAUSE_KEYS functions have been introduced to
95    provide a replacement for the SIP_CAUSE hash. The HangupCauseClear
96    application has also been introduced to remove this data from the channel
97    when necessary.
98
99
100 func_enum:
101  - ENUM query functions now return a count of -1 on lookup error to
102    differentiate between a failed query and a successful query with 0 results
103    matching the specified type.
104
105 CDR:
106  - cdr_adaptive_odbc now supports specifying a schema so that Asterisk can
107    connect to databases that use schemas.
108
109 Configuration Files:
110  - Files listed below have been updated to be more consistent with how Asterisk
111    parses configuration files.  This makes configuration files more consistent
112    with what is expected across modules.
113
114    - cdr.conf: [general] and [csv] sections
115    - dnsmgr.conf
116    - dsp.conf
117
118  - The 'verbose' setting in logger.conf now takes an optional argument,
119    specifying the verbosity level for each logging destination.  The default,
120    if not otherwise specified, is a verbosity of 3.
121
122 AMI:
123   - DBDelTree now correctly returns an error when 0 rows are deleted just as
124     the DBDel action does.
125   - The IAX2 PeerStatus event now sends a 'Port' header.  In Asterisk 10, this was
126     erroneously being sent as a 'Post' header.
127
128 CCSS:
129  - Macro is deprecated. Use cc_callback_sub instead of cc_callback_macro
130    in channel configurations.
131
132 app_meetme:
133   - The 'c' option (announce user count) will now work even if the 'q' (quiet)
134     option is enabled.
135
136 app_followme:
137  - Answered outgoing calls no longer get cut off when the next step is started.
138    You now have until the last step times out to decide if you want to accept
139    the call or not before being disconnected.
140
141 chan_gtalk:
142  - chan_gtalk has been deprecated in favor of the chan_motif channel driver. It is recommended
143    that users switch to using it as it is a core supported module.
144
145 chan_jingle:
146  - chan_jingle has been deprecated in favor of the chan_motif channel driver. It is recommended
147    that users switch to using it as it is a core supported module.
148
149 SIP
150 ===
151  - A new option "tonezone" for setting default tonezone for the channel driver
152    or individual devices
153  - A new manager event, "SessionTimeout" has been added and is triggered when
154    a call is terminated due to RTP stream inactivity or SIP session timer
155    expiration.
156  - SIP_CAUSE is now deprecated.  It has been modified to use the same
157    mechanism as the HANGUPCAUSE function.  Behavior should not change, but
158    performance should be vastly improved.  The HANGUPCAUSE function should now
159    be used instead of SIP_CAUSE. Because of this, the storesipcause option in
160    sip.conf is also deprecated.
161  - The sip paramater for Originating Line Information (oli, isup-oli, and
162    ss7-oli) is now parsed out of the From header and copied into the channel's
163    ANI2 information field.  This is readable from the CALLERID(ani2) dialplan
164    function.
165  - ICE support has been added and is enabled by default. Some endpoints may have
166    problems with the ICE candidates within the SDP. If this is the case ICE support
167    can be disabled globally or on a per-endpoint basis using the icesupport
168    configuration option. Symptoms of this include one way media or no media flow.
169
170 chan_unistim
171  - Due to massive update in chan_unistim phone keys functions and on-screen 
172    information changed.
173
174 users.conf:
175  - A defined user with hasvoicemail=yes now finally uses a Gosub to stdexten
176    as documented in extensions.conf.sample since v1.6.0 instead of a Macro as
177    documented in v1.4.  Set the asterisk.conf stdexten=macro parameter to
178    invoke the stdexten the old way.
179
180 res_jabber
181  - This module has been deprecated in favor of the res_xmpp module. The res_xmpp
182    module is backwards compatible with the res_jabber configuration file, dialplan
183    functions, and AMI actions. The old CLI commands can also be made available using
184    the res_clialiases template for Asterisk 11.
185
186 From 1.8 to 10:
187
188 cel_pgsql:
189  - This module now expects an 'extra' column in the database for data added
190    using the CELGenUserEvent() application.
191
192 ConfBridge
193  - ConfBridge's dialplan arguments have changed and are not
194    backwards compatible.
195
196 File Interpreters
197  - The format interpreter formats/format_sln16.c for the file extension
198    '.sln16' has been removed. The '.sln16' file interpreter now exists
199    in the formats/format_sln.c module along with new support for sln12,
200    sln24, sln32, sln44, sln48, sln96, and sln192 file extensions.
201
202 HTTP:
203  - A bindaddr must be specified in order for the HTTP server
204    to run. Previous versions would default to 0.0.0.0 if no
205    bindaddr was specified.
206
207 Gtalk:
208  - The default value for 'context' and 'parkinglots' in gtalk.conf has
209    been changed to 'default', previously they were empty.
210
211 chan_dahdi:
212  - The mohinterpret=passthrough setting is deprecated in favor of
213    moh_signaling=notify.
214
215 pbx_lua:
216  - Execution no longer continues after applications that do dialplan jumps
217    (such as app.goto).  Now when an application such as app.goto() is called,
218    control is returned back to the pbx engine and the current extension
219    function stops executing.
220  - the autoservice now defaults to being on by default
221  - autoservice_start() and autoservice_start() no longer return a value.
222
223 Queue:
224  - Mark QUEUE_MEMBER_PENALTY Deprecated it never worked for realtime members
225  - QUEUE_MEMBER is now R/W supporting setting paused, ignorebusy and penalty.
226
227 Asterisk Database:
228  - The internal Asterisk database has been switched from Berkeley DB 1.86 to
229    SQLite 3. An existing Berkeley astdb file can be converted with the astdb2sqlite3
230    utility in the UTILS section of menuselect. If an existing astdb is found and no
231    astdb.sqlite3 exists, astdb2sqlite3 will be compiled automatically. Asterisk will
232    convert an existing astdb to the SQLite3 version automatically at runtime. If
233    moving back from Asterisk 10 to Asterisk 1.8, the astdb2bdb utility can be used
234    to create a Berkeley DB copy of the SQLite3 astdb that Asterisk 10 uses.
235
236 Manager:
237  - The AMI protocol version was incremented to 1.2 as a result of changing two
238    instances of the Unlink event to Bridge events. This change was documented
239    as part of the AMI 1.1 update, but two Unlink events were inadvertently left
240    unchanged.
241
242 Module Support Level
243  - All modules in the addons, apps, bridge, cdr, cel, channels, codecs, 
244    formats, funcs, pbx, and res have been updated to include MODULEINFO data
245    that includes <support_level> tags with a value of core, extended, or deprecated.
246    More information is available on the Asterisk wiki at 
247    https://wiki.asterisk.org/wiki/display/AST/Asterisk+Module+Support+States
248
249    Deprecated modules are now marked to not build by default and must be explicitly
250    enabled in menuselect.
251
252 chan_sip:
253  - Setting of HASH(SIP_CAUSE,<slave-channel-name>) on channels is now disabled
254    by default. It can be enabled using the 'storesipcause' option. This feature
255    has a significant performance penalty.
256
257 UDPTL:
258  - The default UDPTL port range in udptl.conf.sample differed from the defaults
259    in the source. If you didn't have a config file, you got 4500 to 4599. Now the
260    default is 4000 to 4999.
261
262 ===========================================================
263 ===========================================================