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