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