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