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