* the '''"W"''' flag of ''do_routing()'' has been removed in favour of specifying it via the database (specifically, the ''dr_rules.sort_alg'' column). If you were using weight-based routing before, you need to update '''all''' of your dr_rules to use the '''"W"''' sorting algorithm instead of '''"N"''' ("None", the current default).

!!!! RLS module
* the [[https://opensips.org/docs/modules/3.0.x/rls.html#param_server_address|server_address]] module parameter has been dropped - its functionality was replaced by the new [[https://opensips.org/docs/modules/3.1.x/rls.html#idp5574560|contact_user]] parameter.

* the [[https://opensips.org/docs/modules/3.0.x/presence.html#param_server_address|server_address]] module parameter has been dropped - its functionality was replaced by the new [[https://opensips.org/docs/modules/3.1.x/presence.html#idp5574560|contact_user]] parameter.

* the '''"W"''' flag of ''do_routing()'' has been removed in favour of specifying it via the database (specifically, the ''dr_rules.sort_alg'' column). If you were using weight-based routing before, you need to update '''all''' of your dr_rules to use the '''"W"''' algorithm instead of '''"N"''' (default).

* the '''carrier flags''' have shifted as seen below. This breaks the code of any provisioning UIs written for OpenSIPS 3.0 which are using the old flags (e.g. OpenSIPS Control Panel 8.3.0).

* the '''carrier flags''' have shifted as seen below. This will break the code of any provisioning UIs which were using these flags (e.g. OpenSIPS Control Panel).

* the '''carrier flags''' have shifted as follows:
** '''WEIGHT_ROUTING''' (%red%removed%%, replaced by the new ''sort_alg'' column)
** '''USE_FIRST_GW''' (''2'' -> ''1'')
** '''DISABLED''' (''4'' -> ''2'')
** '''DIRTY''' (''8'' -> ''4'')

!!!! DROUTING module

* the '''carrier flags''' have shifted as follows: '''WEIGHT_ROUTING''' (%red%removed%%, replaced by the new ''sort_alg'' column), '''USE_FIRST_GW''' (''2'' -> ''1''), '''DISABLED''' (''4'' -> ''2''), '''DIRTY''' (''8'' -> ''4'').

* '''[[https://www.opensips.org/Documentation/Script-CoreFunctions-3-1#toc22|isbflagset()]]''''s, '''[[https://www.opensips.org/Documentation/Script-CoreFunctions-3-1#toc33|resetbflagset()]]''''s and '''[[https://www.opensips.org/Documentation/Script-CoreFunctions-3-1#toc49|setbflagset()]]''''s ''flag'' parameter is now a quoted string
* the order of '''[[https://www.opensips.org/Documentation/Script-CoreFunctions-3-1#toc22|isbflagset()]]''''s, '''[[https://www.opensips.org/Documentation/Script-CoreFunctions-3-1#toc33|resetbflagset()]]''''s and '''[[https://www.opensips.org/Documentation/Script-CoreFunctions-3-1#toc49|setbflagset()]]''''s ''flag'' and ''branch_idx'' parameters has been inverted
* '''[[https://www.opensips.org/Documentation/Script-CoreFunctions-3-1#toc28|raise_event()]]''''s third parameter should now be always provided if you want the raised event to include attributes (eg. @@raise_event("E_MY_EVENT", $avp(attr-val))@@ calls should be replaced with @@raise_event("E_MY_EVENT", , $avp(attr-val))@@ calls)
* the migration requirements caused by the the changes in the core functions parameter interface have been described above; nevertheless you can also check the 2-4 to 3-0 module functions migration guidelines described [[https://www.opensips.org/Documentation/Migration-2-4-0-to-3-0-0#toc4| here]] as the changes are similar.

* the order of '''[[https://www.opensips.org/Documentation/Script-CoreFunctions-3-1#toc22|isbflagset()]]''''s, '''[[https://www.opensips.org/Documentation/Script-CoreFunctions-3-1#toc33|resetbflagset()]]''''s and '''[[https://www.opensips.org/Documentation/Script-CoreFunctions-3-1#toc49|setbflagset()]]''''s ''flag'' and ''branch_idx'' parameters has been inverted.

* '''[[https://www.opensips.org/Documentation/Script-CoreFunctions-3-1#toc21|isflagset()]]''''s, '''[[https://www.opensips.org/Documentation/Script-CoreFunctions-3-1#toc32|resetflag()]]''''s and '''[[https://www.opensips.org/Documentation/Script-CoreFunctions-3-1#toc48|setflag()]]''''s parameter is now a quoted string
* '''[[https://www.opensips.org/Documentation/Script-CoreFunctions-3-1#toc22|isbflagset()]]''''s, '''[[https://www.opensips.org/Documentation/Script-CoreFunctions-3-1#toc33|resetbflagset()]]''''s and '''[[https://www.opensips.org/Documentation/Script-CoreFunctions-3-1#toc49|setbflagset()]]''''s ''flag'' parameter is now a quoted string.

* the default [[https://opensips.org/html/docs/modules/3.1.x/tls_mgm.html#param_tls_method|@@tls_method@@]] has been changed from @@SSLv23@@ to @@TLSv1_2@@. Therefore if you were not setting the @@tls_method@@ parameter in your script, you will now have to explicitly set it: @@modparam("tls_mgm", "tls_method", "[default]SSLv23")@@

!!!! TM module
* '''fr_timer''' and '''fr_inv_timer''' are now completely removed (not just deprecated). Use [[https://opensips.org/docs/modules/3.1.x/tm.html#param_fr_timeout|fr_timeout]] and [[https://opensips.org/docs/modules/3.1.x/tm.html#param_fr_inv_timeout|fr_inv_timeout]] instead!

!!!! AUTH module
* the "qop" parameter of the [[https://opensips.org/docs/modules/3.1.x/auth.html#func_www_challenge|www_challenge()]] and [[https://opensips.org/docs/modules/3.1.x/auth.html#func_proxy_challenge|proxy_challenge()]] functions is now optional and accepts the values: @@auth@@, @@auth-int@@ or both (separated by ',').

!!!! B2B_ENTITIES module
* dropped the '''replication_mode''' module parameter.

!!!! PRESENCE module
* switch to string values instead of integers for the [[https://opensips.org/docs/modules/3.1.x/presence.html#param_cluster_federation_mode|cluster_federation_mode]] module parameter (@@disabled@@ instead of @@0@@ and @@on-demand-sharing@@ instead of @@1@@)

!!!! EVENT_DATAGRAM module
* The event payload is now formated as a JSON-RPC notification instead of the custom OpenSIPS line oriented formatting, so you have to change the parsing of the event in your external applications.

!!!! EVENT_JSONRPC module
* the '''event_jsonrpc''' module has been renamed to '''event_stream'''. you have to replace your @@modparam("event_jsonrpc"...@@ lines with @@modparam("event_stream"...@@ lines
* the transport protocol token from the event socket has been changed from @@jsonrpc@@ to @@tcp@@ (for example, you have to use @@tcp:127.0.0.1:8080/block_ip@@ instead of @@jsonrpc:127.0.0.1:8080/block_ip@@).

!!!! EVENT_RABBITMQ module
* The event payload is now formated as a JSON-RPC notification instead of the custom OpenSIPS line oriented formatting, so you have to change the parsing of the event in your external applications.

See [[https://github.com/OpenSIPS/opensips-cli/blob/master/docs/modules/database.md#database-migration-mysql-only|the opensips-cli documentation]] for more details.

You can migrate your 3.0.x MySQL DB to the 3.1.x format using the '''opensips-cli''' tool :

# opensips-cli -x database migrate 3.0_to_3.1 opensips_3_0 opensips_3_1

See [[https://github.com/OpenSIPS/opensips-cli/blob/master/docs/modules/database.md#database-migration-mysql-only|the opensips-cli documentation]] for more details.

* the '''dlg_list''' MI command no longer outputs the DB id as the ID of the dialog, but a @@hex(entry).hex(id)@@ representation of its id. The DB id field has been moved in the '''db_id''' node.

!!!! DIALOG module

* the '''$DLG_did''' format has been changed from printing the @@entry:id@@ of the dialog to @@hex(entry).hex(id)@@, just as the Record-Route parameter is added
* the '''dlg_list''' MI command no longer outputs the DB id as the ID of the dialog, but a @@hex(entry).hex(id)@@ representation of its id. The DB id field has been moved in the '''db_id'' node.
* the '''dlg_end_dlg''' MI command no longer receives the DB id as an identifier for finding the dialog to terminate, but the same @@hex(entry).hex(id)@@ printed by the '''$DLG_did''' variable and by the '''dlg_list''' command.

* script variable [[Documentation.Script-CoreVar-3-1#af|$af]] to be replaced with [[Documentation.Script-CoreVar-3-1#socket_in|$socket_in(af)]]

* script variable [[Documentation.Script-CoreVar-3-1#fs|$fs]] to be replaced with [[Documentation.Script-CoreVar-3-1#socket_out|$socket_out]]
* script variable [[Documentation.Script-CoreVar-3-1#Ri|$Ri]] to be replaced with [[Documentation.Script-CoreVar-3-1#socket_in|$socket_in(ip)]]
* script variable [[Documentation.Script-CoreVar-3-1#Rp|$Rp]] to be replaced with [[Documentation.Script-CoreVar-3-1#socket_in|$socket_in(port)]]
* script variables [[Documentation.Script-CoreVar-3-1#proto|$proto/$pr]] to be replaced with [[Documentation.Script-CoreVar-3-1#socket_in|$socket_in(proto)]]

* the '''tcp_listen_backlog''' parameter was renamed as '''tcp_socket_backlog''' parameter, with the same definition and behavior.

The following is the full list of backwards-incompatible syntax or functional changes in the OpenSIPS configuration script:
* the '''listen''' parameter was renamed as '''socket''' parameter, with the same definition and behavior.

!!!! TLS_MGM module

* the default [[https://opensips.org/html/docs/modules/3.1.x/tls_mgm.html#param_tls_method|@@tls_method@@]] has been changed from @@SSLv23@@ to @@TLSv1_2@@. Therefore if you were not setting the @@tls_method@@ parameter in your script, you will now have to explicitly set it: @@modparam("tls_mgm", "tls_method", "[default]SSLv23")@@

* the @@tls_handshake_timeout@@ and @@tls_send_timeout@@ from the '''tls_mgm''' module have been removed, thus they can no longer be used to tune the '''proto_wss''' module. Instead of those parameters, we've added the [[[https://opensips.org/html/docs/modules/3.1.x/proto_wss.html#param_wss_tls_handshake_timeout|@wss_tls_handshake_timeout@@]] and [[[https://opensips.org/html/docs/modules/3.1.x/proto_wss.html#param_wss_send_timeout|@@wss_send_timeout@@]], that are now part of the '''proto_wss''' module. To migrate your script, you should replace any of your lines as it follows:

@]

!!!! PROTO_WSS module

* the default [[https://opensips.org/html/docs/modules/3.1.x/tls_mgm.html#param_tls_method|@@tls_method@@]] has been changed from @@SSLv23@@ to @@TLSv1_2@@. Therefore if you were not setting the @@tls_method@@ parameter in your script, you will now have to explicitly set it to the @@SSLv23@@ value in your script.

# Before 3.1 was modparam("tls_mgm", "tls_handshake_timeout", 200)
modparam("proto_tls", "tls_handshake_timeout", 200)
# Before 3.1 was modparam("tls_mgm", "tls_send_timeout", 200)
modparam("proto_tls", "tls_send_timeout", 200)

# Before 3.1 was modparam("tls_mgm", "tls_handshake_timeout", 200)
modparam("proto_wss", "wss_tls_handshake_timeout", 200)
# Before 3.1 was modparam("tls_mgm", "tls_send_timeout", 200)
modparam("proto_wss", "wss_send_timeout", 200)

!!!! PROTO_TLS module

* the '''tls_handshake_timeout''' and '''tls_send_timeout''' parameters have been moved from the '''tls_mgm''' module to the '''proto_tls''' module. Check out the new documentation [[[https://opensips.org/html/docs/modules/3.1.x/proto_tls.html#param_tls_handshake_timeout|here]]]. To migrate your script, you should replace any of your lines as it follows:
[@
modparam("proto_tls", "tls_handshake_timeout", 200) # OLD was modparam("tls_mgm", "tls_handshake_timeout", 200)
modparam("proto_tls", "tls_send_timeout", 200) # OLD was modparam("tls_mgm", "tls_send_timeout", 200)
@]

!!!! PROTO_WSS module

* the '''tls_handshake_timeout''' and '''tls_send_timeout''' from the '''tls_mgm''' module have been removed, thus they can no longer be used to tune the '''proto_wss''' module. Instead of those parameters, we've added the [[[https://opensips.org/html/docs/modules/3.1.x/proto_wss.html#param_wss_tls_handshake_timeout|wss_tls_handshake_timeout]]] and [[[https://opensips.org/html/docs/modules/3.1.x/proto_wss.html#param_wss_send_timeout|wss_send_timeout]]], that are now part of the '''proto_wss''' module. To migrate your script, you should replace any of your lines as it follows:
[@
modparam("proto_wss", "wss_tls_handshake_timeout", 200) # OLD was modparam("tls_mgm", "tls_handshake_timeout", 200)
modparam("proto_wss", "wss_send_timeout", 200) # OLD was modparam("tls_mgm", "tls_send_timeout", 200)
@]

* the '''auto_aliases''' is now by default off, so if you had no setting of it in the old script you should set it explicitly to "on" to keep the same behavior.

* '''[[https://www.opensips.org/Documentation/Script-CoreFunctions-3-1#toc10|cache_raw_query()]]''''s last parameter is now an unquoted variable
* '''[[https://www.opensips.org/Documentation/Script-CoreFunctions-3-1#toc12|construct_uri()]]''''s ''user'', ''port'' and ''extra'' are now optional parameters

!!!!!Documentation -> [[Documentation.Migration|Migration]] -> Migration from 3.0.x to 3.1.0

This section is meant to provide useful help in migrating your OpenSIPS installations from the '''3.0.0''' version to '''3.1.0'''.

You can migrate your 3.0.x MySQL DB to the 3.1.x format by using the '''opensipsdbctl''' tool :

* opensips_3_0 is the existing DB name corresponding to version 3.0.x format

!!!! Core functions

* The following alias names were dropped:
** '''rewritehost()''' for '''sethost()'''
** '''rewritehostport()''' for '''sethostport()'''
** '''rewriteuser()''' for '''setuser()'''
** '''rewriteuserpass()''' for '''setuserpass()'''
** '''rewriteport()''' for '''setport()'''
** '''rewriteuri()''' for '''seturi()'''

!!!!!Documentation -> [[Documentation.Migration|Migration]] -> Migration from 3.1.x to 3.1.0
This page has been visited {$PageCount} times.
(:toc-float Table of Contents:)
----

This section is meant to provide useful help in migrating your OpenSIPS installations from the '''3.1.0''' version to '''3.1.0'''.

You can find the all the new additions in the '''3.1.0''' release compiled [[ About.Version-3-1-0| under this page]]. The ChangeLog may help your understanding of the migration / update process.

%red% Make sure you don't have any '''Makefile.conf''' files in your sources' root before starting the migration. The configuration file generated by '''menuconfig'' is not compatible with the one in older version! %%

----
!!! DB migration

You can migrate your 3.1.x MySQL DB to the 3.1.x format by using the '''opensipsdbctl''' tool :
[@
# opensipsdbctl migrate opensips_3_0 opensips_3_1
@]
where :
* opensips_3_0 is the existing DB name corresponding to version 3.1.x format
* opensips_3_1 is the DB name to be created for 3.1.x format


NOTE:
* the old database will not be deleted, altered or changed - it will not be touched at all
* new database will be created and data from old DB will be imported into it


%red% NOTE that the migration tool is available only for MYSQL databases! %%

%red% NOTE that the default MySQL DB engine is now InnoDB! %%

(:toc-back Back to Table of Contents:)

----
!!! Script migration
The following is the full list of backwards-incompatible syntax or functional changes in the OpenSIPS configuration script (some of them are fixes):

!!!! Global Parameters

* example

!!!! Core keywords

* example

!!!! Core MI commands

* example

!!!! Statistics migration

* example

!!! Module migration

* example