Fix a few fax gateway failures
[asterisk/asterisk.git] / UPGRADE.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 === UPGRADE-11.txt -- Upgrade info for 10 to 11
21 ===
22 ===========================================================
23
24
25 AMI:
26  - The SIP SIPqualifypeer action now sends a response indicating it will qualify
27    a peer once a peer has been found to qualify.  Once the qualify has been
28    completed it will now issue a SIPqualifypeerdone event.
29  - Version 1.4 - The details of what happens to a channel when a masquerade
30    happens (transfers, parking, etc) have changed.
31    - The Masquerade event now includes the Uniqueid's of the clone and original
32      channels.
33    - Channels no longer swap Uniqueid's as a result of the masquerade.
34    - Instead of a shell game of renames, there's now a single rename, appending
35      <ZOMBIE> to the name of the original channel.
36
37 CEL:
38  - The Uniqueid field for a channel is now a stable identifier, and will not
39    change due to transfers, parking, etc.
40
41 Queues:
42  - Queue logging for PAUSEALL/UNPAUSEALL now only occurs if the interface this is
43    performed on is a member of at least one queue.
44  - Queue strategy rrmemory now has a predictable order similar to strategy
45    rrordered. Members will be called in the order that they are added to the
46    queue.
47  - CDR behavior in app_queue has been modified slightly.  The CDR record will
48    now only record a disposition of BUSY if all Queue members were actually
49    busy on a call or some Queue members were busy or paused.  Previously, any
50    Queue member being paused would result in a disposition of BUSY.
51  - Removed the queues.conf check_state_unknown option.  It is no longer
52    necessary.
53
54 Dial:
55  - Now recognizes 'W' to pause sending DTMF for one second in addition to
56    the previously existing 'w' that paused sending DTMF for half a second.
57
58 ExternalIVR:
59  - Now recognizes 'W' to pause sending DTMF for one second in addition to
60    the previously existing 'w' that paused sending DTMF for half a second.
61
62 SendDTMF:
63  - Now recognizes 'W' to pause sending DTMF for one second in addition to
64    the previously existing 'w' that paused sending DTMF for half a second.
65
66 chan_dahdi:
67  - Analog port dialing and deferred DTMF dialing for PRI now distinguishes
68    between 'w' and 'W'.  The 'w' pauses dialing for half a second.  The 'W'
69    pauses dialing for one second.
70  - The default for inband_on_proceeding has changed to no.
71
72 chan_local:
73  - The /b option is removed.
74
75 Dialplan:
76  - All channel and global variable names are evaluated in a case-sensitive manner.
77    In previous versions of Asterisk, variables created and evaluated in the
78    dialplan were evaluated case-insensitively, but built-in variables and variable
79    evaluation done internally within Asterisk was done case-sensitively.
80  - Asterisk has always had code to ignore dash '-' characters that are not
81    part of a character set in the dialplan extensions.  The code now
82    consistently ignores these characters when matching dialplan extensions.
83  - BRIDGE_FEATURES channel variable is now casesensitive for feature letter codes.
84    Uppercase variants apply them to the calling party while lowercase variants
85    apply them to the called party.
86
87 Features:
88  - The features.conf [applicationmap] <FeatureName>  ActivatedBy option is
89    no longer honored.  The feature is activated by which channel
90    DYNAMIC_FEATURES includes the feature is on.  Use predial to set different
91    values of DYNAMIC_FEATURES on the channels
92
93 Parking:
94  - The arguments for the Park, ParkedCall, and ParkAndAnnounce applications have
95    been modified significantly. See the application documents for specific details.
96    Also parking lot configuration is now done in res_parking.conf instead of
97    features.conf
98
99 From 10 to 11:
100
101 Voicemail:
102  - All voicemails now have a "msg_id" which uniquely identifies a message. For
103    users of filesystem and IMAP storage of voicemail, this should be transparent.
104    For users of ODBC, you will need to add a "msg_id" column to your voice mail
105    messages table. This should be a string capable of holding at least 32 characters.
106    All messages created in old Asterisk installations will have a msg_id added to
107    them when required. This operation should be transparent as well.
108
109 Parking:
110  - The comebacktoorigin setting must now be set per parking lot. The setting in
111    the general section will not be applied automatically to each parking lot.
112  - The BLINDTRANSFER channel variable is deleted from a channel when it is
113    bridged to prevent subtle bugs in the parking feature.  The channel
114    variable is used by Asterisk internally for the Park application to work
115    properly.  If you were using it for your own purposes, copy it to your
116    own channel variable before the channel is bridged.
117
118 res_ais:
119  - Users of res_ais in versions of Asterisk prior to Asterisk 11 must change
120    to use the res_corosync module, instead.  OpenAIS is deprecated, but
121    Corosync is still actively developed and maintained.  Corosync came out of
122    the OpenAIS project.
123
124 Dialplan Functions:
125  - MAILBOX_EXISTS has been deprecated. Use VM_INFO with the 'exists' parameter
126    instead.
127  - Macro has been deprecated in favor of GoSub.  For redirecting and connected
128    line purposes use the following variables instead of their macro equivalents:
129    REDIRECTING_SEND_SUB, REDIRECTING_SEND_SUB_ARGS,
130    CONNECTED_LINE_SEND_SUB, CONNECTED_LINE_SEND_SUB_ARGS.
131  - The REDIRECTING function now supports the redirecting original party id
132    and reason.
133  - The HANGUPCAUSE and HANGUPCAUSE_KEYS functions have been introduced to
134    provide a replacement for the SIP_CAUSE hash. The HangupCauseClear
135    application has also been introduced to remove this data from the channel
136    when necessary.
137
138
139 func_enum:
140  - ENUM query functions now return a count of -1 on lookup error to
141    differentiate between a failed query and a successful query with 0 results
142    matching the specified type.
143
144 CDR:
145  - cdr_adaptive_odbc now supports specifying a schema so that Asterisk can
146    connect to databases that use schemas.
147
148 Configuration Files:
149  - Files listed below have been updated to be more consistent with how Asterisk
150    parses configuration files.  This makes configuration files more consistent
151    with what is expected across modules.
152
153    - cdr.conf: [general] and [csv] sections
154    - dnsmgr.conf
155    - dsp.conf
156
157  - The 'verbose' setting in logger.conf now takes an optional argument,
158    specifying the verbosity level for each logging destination.  The default,
159    if not otherwise specified, is a verbosity of 3.
160
161 AMI:
162   - DBDelTree now correctly returns an error when 0 rows are deleted just as
163     the DBDel action does.
164   - The IAX2 PeerStatus event now sends a 'Port' header.  In Asterisk 10, this was
165     erroneously being sent as a 'Post' header.
166
167 CCSS:
168  - Macro is deprecated. Use cc_callback_sub instead of cc_callback_macro
169    in channel configurations.
170
171 app_meetme:
172   - The 'c' option (announce user count) will now work even if the 'q' (quiet)
173     option is enabled.
174
175 app_followme:
176  - Answered outgoing calls no longer get cut off when the next step is started.
177    You now have until the last step times out to decide if you want to accept
178    the call or not before being disconnected.
179
180 chan_gtalk:
181  - chan_gtalk has been deprecated in favor of the chan_motif channel driver. It is recommended
182    that users switch to using it as it is a core supported module.
183
184 chan_jingle:
185  - chan_jingle has been deprecated in favor of the chan_motif channel driver. It is recommended
186    that users switch to using it as it is a core supported module.
187
188 SIP
189 ===
190  - A new option "tonezone" for setting default tonezone for the channel driver
191    or individual devices
192  - A new manager event, "SessionTimeout" has been added and is triggered when
193    a call is terminated due to RTP stream inactivity or SIP session timer
194    expiration.
195  - SIP_CAUSE is now deprecated.  It has been modified to use the same
196    mechanism as the HANGUPCAUSE function.  Behavior should not change, but
197    performance should be vastly improved.  The HANGUPCAUSE function should now
198    be used instead of SIP_CAUSE. Because of this, the storesipcause option in
199    sip.conf is also deprecated.
200  - The sip paramater for Originating Line Information (oli, isup-oli, and
201    ss7-oli) is now parsed out of the From header and copied into the channel's
202    ANI2 information field.  This is readable from the CALLERID(ani2) dialplan
203    function.
204  - ICE support has been added and is enabled by default. Some endpoints may have
205    problems with the ICE candidates within the SDP. If this is the case ICE support
206    can be disabled globally or on a per-endpoint basis using the icesupport
207    configuration option. Symptoms of this include one way media or no media flow.
208
209 chan_unistim
210  - Due to massive update in chan_unistim phone keys functions and on-screen
211    information changed.
212
213 users.conf:
214  - A defined user with hasvoicemail=yes now finally uses a Gosub to stdexten
215    as documented in extensions.conf.sample since v1.6.0 instead of a Macro as
216    documented in v1.4.  Set the asterisk.conf stdexten=macro parameter to
217    invoke the stdexten the old way.
218
219 res_jabber
220  - This module has been deprecated in favor of the res_xmpp module. The res_xmpp
221    module is backwards compatible with the res_jabber configuration file, dialplan
222    functions, and AMI actions. The old CLI commands can also be made available using
223    the res_clialiases template for Asterisk 11.
224
225 From 1.8 to 10:
226
227 cel_pgsql:
228  - This module now expects an 'extra' column in the database for data added
229    using the CELGenUserEvent() application.
230
231 ConfBridge
232  - ConfBridge's dialplan arguments have changed and are not
233    backwards compatible.
234
235 File Interpreters
236  - The format interpreter formats/format_sln16.c for the file extension
237    '.sln16' has been removed. The '.sln16' file interpreter now exists
238    in the formats/format_sln.c module along with new support for sln12,
239    sln24, sln32, sln44, sln48, sln96, and sln192 file extensions.
240
241 HTTP:
242  - A bindaddr must be specified in order for the HTTP server
243    to run. Previous versions would default to 0.0.0.0 if no
244    bindaddr was specified.
245
246 Gtalk:
247  - The default value for 'context' and 'parkinglots' in gtalk.conf has
248    been changed to 'default', previously they were empty.
249
250 chan_dahdi:
251  - The mohinterpret=passthrough setting is deprecated in favor of
252    moh_signaling=notify.
253
254 pbx_lua:
255  - Execution no longer continues after applications that do dialplan jumps
256    (such as app.goto).  Now when an application such as app.goto() is called,
257    control is returned back to the pbx engine and the current extension
258    function stops executing.
259  - the autoservice now defaults to being on by default
260  - autoservice_start() and autoservice_start() no longer return a value.
261
262 Queue:
263  - Mark QUEUE_MEMBER_PENALTY Deprecated it never worked for realtime members
264  - QUEUE_MEMBER is now R/W supporting setting paused, ignorebusy and penalty.
265
266 Asterisk Database:
267  - The internal Asterisk database has been switched from Berkeley DB 1.86 to
268    SQLite 3. An existing Berkeley astdb file can be converted with the astdb2sqlite3
269    utility in the UTILS section of menuselect. If an existing astdb is found and no
270    astdb.sqlite3 exists, astdb2sqlite3 will be compiled automatically. Asterisk will
271    convert an existing astdb to the SQLite3 version automatically at runtime. If
272    moving back from Asterisk 10 to Asterisk 1.8, the astdb2bdb utility can be used
273    to create a Berkeley DB copy of the SQLite3 astdb that Asterisk 10 uses.
274
275 Manager:
276  - The AMI protocol version was incremented to 1.2 as a result of changing two
277    instances of the Unlink event to Bridge events. This change was documented
278    as part of the AMI 1.1 update, but two Unlink events were inadvertently left
279    unchanged.
280
281 Module Support Level
282  - All modules in the addons, apps, bridge, cdr, cel, channels, codecs,
283    formats, funcs, pbx, and res have been updated to include MODULEINFO data
284    that includes <support_level> tags with a value of core, extended, or deprecated.
285    More information is available on the Asterisk wiki at
286    https://wiki.asterisk.org/wiki/display/AST/Asterisk+Module+Support+States
287
288    Deprecated modules are now marked to not build by default and must be explicitly
289    enabled in menuselect.
290
291 chan_sip:
292  - Setting of HASH(SIP_CAUSE,<slave-channel-name>) on channels is now disabled
293    by default. It can be enabled using the 'storesipcause' option. This feature
294    has a significant performance penalty.
295  - In order to improve compliance with RFC 3261, SIP usernames are now properly
296    escaped when encoding reserved characters. Prior to this change, the use of
297    these characters in certain SIP settings affecting usernames could cause
298    injections of these characters in their raw form into SIP headers which could
299    in turn cause all sorts of nasty behaviors. All characters that are not
300    alphanumeric or are not contained in the the following lists specified by
301    RFC 3261 section 25.1 will be escaped as %XX when encoding a SIP username:
302     * mark: "-" / "_" / "." / "!" / "~" / "*" / "'" / "(" / ")"
303     * user-unreserved: "&" / "=" / "+" / "$" / "," / ";" / "?" / "/"
304
305 UDPTL:
306  - The default UDPTL port range in udptl.conf.sample differed from the defaults
307    in the source. If you didn't have a config file, you got 4500 to 4599. Now the
308    default is 4000 to 4999.
309
310 ===========================================================
311 ===========================================================