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