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