Documentation

Documentation.Migration-3-1-0-to-3-2-0 History

Hide minor edits - Show changes to output

January 31, 2022, at 05:54 PM by liviu -
Changed line 44 from:
* the '''$rT''' pseudo-variable (topmost route type) has been replaced by [[https://www.opensips.org/Documentation/Script-CoreVar-3-2#route|$route]] (route call stack). The equivalent syntax is '''$(route[-1]{s.select,0,[})'''.
to:
* (only for 3.2.4 or earlier) the '''$rT''' pseudo-variable (topmost route type) has been replaced by [[https://www.opensips.org/Documentation/Script-CoreVar-3-2#route|$route]] (route call stack). The equivalent syntax is '''$(route[-1]{s.select,0,[})'''. The '''$rT''' variable has been re-introduced starting with 3.2.5, for backwards-compatibility reasons.
January 31, 2022, at 04:51 PM by liviu -
Changed line 44 from:
* the '''$rT''' pseudo-variable (topmost route type) has been replaced by [[https://www.opensips.org/Documentation/Script-CoreVar-3-2#route|$route]] (route call stack). The equivalent syntax is '''$(route[-1])'''.
to:
* the '''$rT''' pseudo-variable (topmost route type) has been replaced by [[https://www.opensips.org/Documentation/Script-CoreVar-3-2#route|$route]] (route call stack). The equivalent syntax is '''$(route[-1]{s.select,0,[})'''.
September 05, 2021, at 03:11 PM by liviu -
Changed line 86 from:
* the ''timerec'' column syntax has been normalized. Firstly, the '''"dtend"''' field has been added, so the final column value has been made compatible with the input of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]]. Secondly, the leading ''"timezone"'' field has been added, so it must be prepended accordingly -- in order to keep using the system timezone, just prepend a '''"|"''' string.
to:
* the ''timerec'' column syntax has been normalized. Firstly, the '''"dtend"''' field has been added, so the final column value has been made compatible with the input of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]]. Secondly, the leading '''"timezone"''' field has been added, so it must be prepended accordingly -- in order to keep using the system timezone, just prepend a '''"|"''' string.
Changed line 94 from:
* the ''timerec'' column syntax has been normalized. Firstly, the '''"dtend"''' field has been added, so the final column value has been made compatible with the input of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]]. Secondly, the leading ''"timezone"'' field has been added, so it must be prepended accordingly -- in order to keep using the system timezone, just prepend a '''"|"''' string.
to:
* the ''timerec'' column syntax has been normalized. Firstly, the '''"dtend"''' field has been added, so the final column value has been made compatible with the input of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]]. Secondly, the leading '''"timezone"''' field has been added, so it must be prepended accordingly -- in order to keep using the system timezone, just prepend a '''"|"''' string.
June 11, 2021, at 05:22 PM by razvancrainea -
Added lines 63-66:

!!!! ACC module

* The '''acc_created_avp_name''' parameter has been completely dropped, as it was no longer being used.
May 29, 2021, at 11:36 PM by rvlad_patrascu -
Changed line 71 from:
* if the ''tls_mgm'' module is only used for the management of TLS certificates and parameters by modules like [[https://opensips.org/docs/modules/3.2.x/db_mysql.html|'''db_mysql''']], [[https://opensips.org/docs/modules/3.2.x/rabbitmq.html|'''rabbitmq''']] etc. (and not for TLS operations by transport modules like [[https://opensips.org/docs/modules/3.2.x/proto_tls.html|'''proto_tls''']], which also require loading [[https://opensips.org/docs/modules/3.2.x/tls_wolfssl.html|'''tls_wolfssl''']] or [[https://opensips.org/docs/modules/3.2.x/tls_wolfssl.html|'''tls_wolfssl''']]) then the new [[https://opensips.org/docs/modules/3.2.x/tls_mgm.html#param_tls_library|'''tls_library''']] module parameter must be set to ''none''.
to:
* if the ''tls_mgm'' module is only used for the management of TLS certificates and parameters by modules like [[https://opensips.org/docs/modules/3.2.x/db_mysql.html|'''db_mysql''']], [[https://opensips.org/docs/modules/3.2.x/rabbitmq.html|'''rabbitmq''']] etc. (and not for TLS operations by transport modules like [[https://opensips.org/docs/modules/3.2.x/proto_tls.html|'''proto_tls''']] etc.) then the new [[https://opensips.org/docs/modules/3.2.x/tls_mgm.html#param_tls_library|'''tls_library''']] module parameter must be set to ''none''. Otherwise, ''tls_mgm'' will not start unless you also load [[https://opensips.org/docs/modules/3.2.x/tls_openssl.html|'''tls_openssl''']] or [[https://opensips.org/docs/modules/3.2.x/tls_wolfssl.html|'''tls_wolfssl''']], even though they are not actually used in this case.
May 29, 2021, at 11:29 PM by rvlad_patrascu -
Added lines 63-71:

!!!! PROTO_TLS module
* one of the [[https://opensips.org/docs/modules/3.2.x/tls_wolfssl.html|'''tls_wolfssl''']] or [[https://opensips.org/docs/modules/3.2.x/tls_openssl.html|'''tls_openssl''']] TLS library modules has to be loaded before ''tls_mgm''

!!!! PROTO_WSS module
* one of the [[https://opensips.org/docs/modules/3.2.x/tls_wolfssl.html|'''tls_wolfssl''']] or [[https://opensips.org/docs/modules/3.2.x/tls_openssl.html|'''tls_openssl''']] TLS library modules has to be loaded before ''tls_mgm''

!!!! TLS_MGM module
* if the ''tls_mgm'' module is only used for the management of TLS certificates and parameters by modules like [[https://opensips.org/docs/modules/3.2.x/db_mysql.html|'''db_mysql''']], [[https://opensips.org/docs/modules/3.2.x/rabbitmq.html|'''rabbitmq''']] etc. (and not for TLS operations by transport modules like [[https://opensips.org/docs/modules/3.2.x/proto_tls.html|'''proto_tls''']], which also require loading [[https://opensips.org/docs/modules/3.2.x/tls_wolfssl.html|'''tls_wolfssl''']] or [[https://opensips.org/docs/modules/3.2.x/tls_wolfssl.html|'''tls_wolfssl''']]) then the new [[https://opensips.org/docs/modules/3.2.x/tls_mgm.html#param_tls_library|'''tls_library''']] module parameter must be set to ''none''.
May 28, 2021, at 11:21 AM by liviu -
Changed line 82 from:
* time recurrences: the '''byyearday''', '''bymonth''' and '''byweekno''' integers are now '''1-indexed''' instead of '''0-indexed''' (per RFC 5545)! Make sure to convert any such data accordingly, otherwise your time recurrence strings will no longer match as expected following an upgrade to 3.2
to:
* time recurrences: the '''byyearday''', '''bymonth''' and '''byweekno''' integers are now '''1-indexed''' instead of '''0-indexed''' (i.e. week 0 becomes week 1, per RFC 5545)! Make sure to convert any such data accordingly, otherwise your time recurrence strings will no longer match as expected following an upgrade to 3.2
May 27, 2021, at 07:48 PM by rvlad_patrascu -
Added lines 63-66:

!!!! B2B_LOGIC module
* the B2B scenario logic is now implemented via OpenSIPS scripting instead of XML files. Check this [[https://www.opensips.org/Documentation/Tutorials-B2BUA-3-2|'''tutorial''']] for more details and examples of XML scenarios and their equivalent OpenSIPS script implementation.
* In order to simplify the migration effort, you have the option to use a legacy '''b2b_logic_xml''' module, that will be '''obsoleted''' with the next OpenSIPS 3.3 release. Use this only as a temporary solution until you properly migrate to the new variant of the b2b_logic_module.
April 09, 2021, at 05:17 PM by razvancrainea -
Changed line 68 from:
!!!! DROUTING module
to:
!!!! DIALPLAN module
Changed lines 72-76 from:
!!!! DIALPLAN module
to:

!!!! Dialog module
* the ''E_DLG_STATE_CHANGED'' parameters have changed. The '''hash_id''' and '''hash_entry''' parameters were replaced by '''id''' and '''db_id''', to be more consistent with the output of '''dlg_list''' and what OpenSIPS advertises in the Record-Route header. If you are listening for this event in your external application, or directly in OpenSIPS script using the EVI interface, make sure you adapt the '''$param''' names to the new format.

!!!! DROUTING module
December 10, 2020, at 08:38 PM by liviu -
Changed line 44 from:
* the '''$rT''' (topmost route type) has been replaced by [[https://www.opensips.org/Documentation/Script-CoreVar-3-2#route|$route]] (route call stack). The equivalent syntax is '''$(route[-1])'''.
to:
* the '''$rT''' pseudo-variable (topmost route type) has been replaced by [[https://www.opensips.org/Documentation/Script-CoreVar-3-2#route|$route]] (route call stack). The equivalent syntax is '''$(route[-1])'''.
November 25, 2020, at 01:50 PM by liviu -
Changed line 44 from:
* the '''$rT''' (topmost route type) has been replaced by [[https://www.opensips.org/Documentation/Script-CoreVar-3-2#route|$route]]. The equivalent syntax is '''$(route[-1])'''.
to:
* the '''$rT''' (topmost route type) has been replaced by [[https://www.opensips.org/Documentation/Script-CoreVar-3-2#route|$route]] (route call stack). The equivalent syntax is '''$(route[-1])'''.
November 25, 2020, at 01:49 PM by liviu -
Added lines 41-44:

!!!! Core Variables

* the '''$rT''' (topmost route type) has been replaced by [[https://www.opensips.org/Documentation/Script-CoreVar-3-2#route|$route]]. The equivalent syntax is '''$(route[-1])'''.
October 31, 2020, at 08:24 PM by liviu -
Changed lines 62-63 from:
* time recurrences: the '''byyearday''', '''bymonth''' and '''byweekno''' integers are now '''1-indexed''' instead of '''0-indexed'''!! Make sure to convert any such data accordingly, otherwise your time recurrence strings will no longer match as expected following an upgrade to 3.2
to:
* time recurrences: the '''byyearday''', '''bymonth''' and '''byweekno''' integers are now '''1-indexed''' instead of '''0-indexed''' (per RFC 5545)! Make sure to convert any such data accordingly, otherwise your time recurrence strings will no longer match as expected following an upgrade to 3.2
Changed lines 66-67 from:
* time recurrences: the '''byyearday''', '''bymonth''' and '''byweekno''' integers are now '''1-indexed''' instead of '''0-indexed'''!! Make sure to convert any such data accordingly, otherwise your time recurrence strings will no longer match as expected following an upgrade to 3.2
to:
* time recurrences: the '''byyearday''', '''bymonth''' and '''byweekno''' integers are now '''1-indexed''' instead of '''0-indexed''' (per RFC 5545)! Make sure to convert any such data accordingly, otherwise your time recurrence strings will no longer match as expected following an upgrade to 3.2
Changed line 70 from:
* time recurrences: the '''byyearday''', '''bymonth''' and '''byweekno''' integers are now '''1-indexed''' instead of '''0-indexed'''!! Make sure to convert any such data accordingly, otherwise your time recurrence strings will no longer match as expected following an upgrade to 3.2
to:
* time recurrences: the '''byyearday''', '''bymonth''' and '''byweekno''' integers are now '''1-indexed''' instead of '''0-indexed''' (per RFC 5545)! Make sure to convert any such data accordingly, otherwise your time recurrence strings will no longer match as expected following an upgrade to 3.2
October 31, 2020, at 08:23 PM by liviu -
Changed lines 62-63 from:
to:
* time recurrences: the '''byyearday''', '''bymonth''' and '''byweekno''' integers are now '''1-indexed''' instead of '''0-indexed'''!! Make sure to convert any such data accordingly, otherwise your time recurrence strings will no longer match as expected following an upgrade to 3.2
Changed lines 66-67 from:
to:
* time recurrences: the '''byyearday''', '''bymonth''' and '''byweekno''' integers are now '''1-indexed''' instead of '''0-indexed'''!! Make sure to convert any such data accordingly, otherwise your time recurrence strings will no longer match as expected following an upgrade to 3.2
Changed lines 69-70 from:
* the ''timerec'' column syntax has been normalized. Firstly, the '''"dtend"''' field has been added, so the final column value has been made compatible with the input of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]]. Secondly, the leading ''"timezone"'' field has been added, so it must be prepended accordingly -- in order to keep using the system timezone, just prepend a '''"|"''' string.
to:
* the ''timerec'' column syntax has been normalized. Firstly, the '''"dtend"''' field has been added, so the final column value has been made compatible with the input of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]]. Secondly, the leading ''"timezone"'' field has been added, so it must be prepended accordingly -- in order to keep using the system timezone, just prepend a '''"|"''' string.
* time recurrences: the '''byyearday''', '''bymonth''' and '''byweekno''' integers are now '''1-indexed''' instead of '''0-indexed'''!! Make sure to convert any such data accordingly, otherwise your time recurrence strings will no longer match as expected following an upgrade to 3.2
October 07, 2020, at 08:25 PM by liviu -
Changed line 10 from:
%red% Make sure you don't carry a left-over '''Makefile.conf''' file in your OpenSIPS source tree if checking out a new branch! This configuration file, generated by ''make menuconfig'', is usually not compatible with the one of a previous major release! %%
to:
%red% Make sure you don't carry a left-over '''Makefile.conf''' file in your OpenSIPS source tree if migrating to a new branch! This configuration file, generated by ''make menuconfig'', is usually not compatible with the one of a previous major release! %%
October 07, 2020, at 08:24 PM by liviu -
Changed line 10 from:
%red% Make sure you don't have a left-over '''Makefile.conf''' file in your OpenSIPS source tree if checking out a new branch! This configuration file, generated by ''make menuconfig'', is usually not compatible with the one of a previous major release! %%
to:
%red% Make sure you don't carry a left-over '''Makefile.conf''' file in your OpenSIPS source tree if checking out a new branch! This configuration file, generated by ''make menuconfig'', is usually not compatible with the one of a previous major release! %%
October 07, 2020, at 08:23 PM by liviu -
Changed line 10 from:
%red% Make sure you don't have any left-over '''Makefile.conf''' file in your OpenSIPS source tree if checking out a new branch! This configuration file, generated by ''make menuconfig'', is usually not compatible with the one of a previous major release! %%
to:
%red% Make sure you don't have a left-over '''Makefile.conf''' file in your OpenSIPS source tree if checking out a new branch! This configuration file, generated by ''make menuconfig'', is usually not compatible with the one of a previous major release! %%
October 07, 2020, at 08:23 PM by liviu -
Changed line 10 from:
%red% Make sure you don't have any left-over '''Makefile.conf''' file in your OpenSIPS source tree if checking out a new branch! This configuration file, generated by ''make menuconfig'', is usually not compatible with the one of an older major release! %%
to:
%red% Make sure you don't have any left-over '''Makefile.conf''' file in your OpenSIPS source tree if checking out a new branch! This configuration file, generated by ''make menuconfig'', is usually not compatible with the one of a previous major release! %%
October 07, 2020, at 08:22 PM by liviu -
Changed line 10 from:
%red% Make sure you don't have any left-over '''Makefile.conf''' file in your OpenSIPS source tree before starting the migration! This configuration file, generated by ''make menuconfig'', is usually not compatible with the one of an older major release! %%
to:
%red% Make sure you don't have any left-over '''Makefile.conf''' file in your OpenSIPS source tree if checking out a new branch! This configuration file, generated by ''make menuconfig'', is usually not compatible with the one of an older major release! %%
October 07, 2020, at 08:22 PM by liviu -
Changed line 10 from:
%red% Make sure you don't have any '''Makefile.conf''' files in your sources' root before starting the migration! This configuration file, generated by '''menuconfig'', is not compatible with the one of an older version! %%
to:
%red% Make sure you don't have any left-over '''Makefile.conf''' file in your OpenSIPS source tree before starting the migration! This configuration file, generated by ''make menuconfig'', is usually not compatible with the one of an older major release! %%
October 07, 2020, at 08:20 PM by liviu -
Changed line 10 from:
%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! %%
to:
%red% Make sure you don't have any '''Makefile.conf''' files in your sources' root before starting the migration! This configuration file, generated by '''menuconfig'', is not compatible with the one of an older version! %%
October 07, 2020, at 07:53 PM by liviu -
Changed line 61 from:
* the '''time_string''' parameter of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]] has been extended with a leading ''timezone'' field. Although we made strings such as "20200101T...|..." '''backwards-compatible''' with the current implementation, strings such as "|20200101T..." '''will now break your logic''' unless you prepend your input with the '''"timezone |"''' string. To use the system timezone, just prepend an empty-string timezone, followed by the delimiter, i.e. '''"|"'''.
to:
* the '''time_string''' parameter of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]] has been extended with a leading ''timezone'' field. Although we made strings such as "20200101T...|..." '''backwards-compatible''' with the current implementation, strings such as "|20200101T..." '''will now break your logic''' unless you prepend your input with the '''"timezone |"''' string. To use the system timezone, just prepend an empty-string timezone followed by the delimiter, i.e. '''"|"'''.
October 07, 2020, at 07:52 PM by liviu -
October 07, 2020, at 07:52 PM by liviu -
Changed line 61 from:
* the '''time_string''' parameter of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]] has been extended with a leading ''timezone'' field. Although we made strings such as "20200101T...|..." '''backwards-compatible''' with the current implementation, strings such as "|20200101T..." '''will now break your logic''' unless you prepend your input with the '''"timezone |"''' string. To use the system timezone, just prepend '''"|"'''.
to:
* the '''time_string''' parameter of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]] has been extended with a leading ''timezone'' field. Although we made strings such as "20200101T...|..." '''backwards-compatible''' with the current implementation, strings such as "|20200101T..." '''will now break your logic''' unless you prepend your input with the '''"timezone |"''' string. To use the system timezone, just prepend an empty-string timezone, followed by the delimiter, i.e. '''"|"'''.
October 07, 2020, at 07:51 PM by liviu -
Changed lines 61-62 from:
* the '''time_string''' parameter of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]] has been extended with a leading '''timezone''' field. Although we made strings such as "20200101T...|..." ''backwards-compatible'' with the current implementation, strings such as "|20200101T..." ''will now break your logic'' unless you prepend your input with the ''"timezone |"'' string. To use the system timezone, just prepend ''"|"''.
to:
* the '''time_string''' parameter of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]] has been extended with a leading ''timezone'' field. Although we made strings such as "20200101T...|..." '''backwards-compatible''' with the current implementation, strings such as "|20200101T..." '''will now break your logic''' unless you prepend your input with the '''"timezone |"''' string. To use the system timezone, just prepend '''"|"'''.
Changed lines 64-65 from:
* the '''time_rec''' column syntax has been normalized. Firstly, the '''"dtend"''' field has been added, so the final column value has been made compatible with the input of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]]. Secondly, the leading '''"timezone"''' field has been added, so it must be prepended accordingly -- in order to keep using the system timezone, just prepend a ''"|"'' string.
to:
* the ''timerec'' column syntax has been normalized. Firstly, the '''"dtend"''' field has been added, so the final column value has been made compatible with the input of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]]. Secondly, the leading ''"timezone"'' field has been added, so it must be prepended accordingly -- in order to keep using the system timezone, just prepend a '''"|"''' string.
Changed line 67 from:
* the '''time_rec''' column syntax has been normalized. Firstly, the '''"dtend"''' field has been added, so the final column value has been made compatible with the input of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]]. Secondly, the leading '''"timezone"''' field has been added, so it must be prepended accordingly -- in order to keep using the system timezone, just prepend a ''"|"'' string.
to:
* the ''timerec'' column syntax has been normalized. Firstly, the '''"dtend"''' field has been added, so the final column value has been made compatible with the input of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]]. Secondly, the leading ''"timezone"'' field has been added, so it must be prepended accordingly -- in order to keep using the system timezone, just prepend a '''"|"''' string.
October 07, 2020, at 07:50 PM by liviu -
Changed line 61 from:
* the '''time_string''' parameter of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]] has been extended with a leading '''timezone''' field. Although we made strings such as "20200101T...|..." ''backwards-compatible'' with the current implementation, strings such as "|20200101T..." will now break your code unless you prepend your input with the ''"timezone |"'' string. To use the system timezone, just prepend ''"|"''.
to:
* the '''time_string''' parameter of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]] has been extended with a leading '''timezone''' field. Although we made strings such as "20200101T...|..." ''backwards-compatible'' with the current implementation, strings such as "|20200101T..." ''will now break your logic'' unless you prepend your input with the ''"timezone |"'' string. To use the system timezone, just prepend ''"|"''.
October 07, 2020, at 07:49 PM by liviu -
Changed line 61 from:
* the '''time_string''' parameter has been extended with a leading '''timezone''' field. Although we made strings such as "20200101T...|..." ''backwards-compatible'' with the current implementation, strings such as "|20200101T..." will now break your code unless you prepend your input with the ''"timezone |"'' string. To use the system timezone, just prepend ''"|"''.
to:
* the '''time_string''' parameter of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]] has been extended with a leading '''timezone''' field. Although we made strings such as "20200101T...|..." ''backwards-compatible'' with the current implementation, strings such as "|20200101T..." will now break your code unless you prepend your input with the ''"timezone |"'' string. To use the system timezone, just prepend ''"|"''.
October 07, 2020, at 07:49 PM by liviu -
Changed lines 35-42 from:
* the '''listen''' parameter was renamed as '''socket''' parameter, with the same definition and behavior.
* the '''tcp_listen_backlog''' parameter was renamed as '''tcp_socket_backlog''' parameter, with the same definition and behavior.
* 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 variable [[Documentation.Script-CoreVar-3-1#af|$af]] to be replaced with [[Documentation.Script-CoreVar-3-1#socket_in|$socket_in(af)]]
* script variables [[Documentation.Script-CoreVar-3-1#proto|$proto/$pr]] to be replaced with [[Documentation.Script-CoreVar-3-1#socket_in|$socket_in(proto)]]
to:

* example
Deleted lines 39-42:
* 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.

!!!! Core keywords
Added lines 42-45:
!!!! Core keywords

* example
Deleted lines 47-58:
* The following alias names were dropped:
** '''rewritehost()''' for '''sethost()'''
** '''rewritehostport()''' for '''sethostport()'''
** '''rewriteuser()''' for '''setuser()'''
** '''rewriteuserpass()''' for '''setuserpass()'''
** '''rewriteport()''' for '''setport()'''
** '''rewriteuri()''' for '''seturi()'''
* '''[[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

!!!! Core MI commands
Added lines 50-53:
!!!! Core MI commands

* example
Changed lines 60-61 from:
!!!! FOOBAR module
* example
to:
!!!! CFGUTILS module
* the '''time_string''' parameter has been extended with a leading '''timezone''' field. Although we made strings such as "20200101T...|..." ''backwards-compatible'' with the current implementation, strings such as "|20200101T..." will now break your code unless you prepend your input with the ''"timezone |"'' string. To use the system timezone, just prepend ''"|"''.

!!!! DROUTING module
* the '''time_rec''' column syntax has been normalized. Firstly, the '''"dtend"''' field has been added, so the final column value has been made compatible with the input of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]]. Secondly, the leading '''"timezone"''' field has been added, so it must be prepended accordingly -- in order to keep using the system timezone, just prepend a ''"|"'' string.

!!!! DIALPLAN module
* the '''time_rec''' column syntax has been normalized. Firstly, the '''"dtend"''' field has been added, so the final column value has been made compatible with the input of [[https://opensips.org/docs/modules/3.2.x/cfgutils.html#func_check_time_rec|check_time_rec()]]. Secondly, the leading '''"timezone"''' field has been added, so it must be prepended accordingly -- in order to keep using the system timezone, just prepend a ''"|"'' string.
October 07, 2020, at 07:39 PM by liviu -
Changed line 1 from:
!!!!!Documentation -> [[Documentation.Migration|Migration]] -> Migration from 3.0.x to 3.1.0
to:
!!!!!Documentation -> [[Documentation.Migration|Migration]] -> Migration from 3.1.x to 3.2.0
Changed lines 6-9 from:
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 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.
to:
This section is meant to provide useful help in migrating your OpenSIPS installations from the '''3.1.0''' version to '''3.2.0'''.

You can find the all the new additions in the '''3.2.0''' release compiled [[ About.Version-3-2-0| under this page]]. The ChangeLog may help your understanding of the migration / update process.
Changed line 15 from:
You can migrate your 3.0.x MySQL DB to the 3.1.x format using the '''opensips-cli''' tool :
to:
You can migrate your 3.1.x MySQL DB to the 3.2.x format using the '''opensips-cli''' tool :
Changed line 17 from:
# opensips-cli -x database migrate 3.0_to_3.1 opensips_3_0 opensips_3_1
to:
# opensips-cli -x database migrate 3.1_to_3.2 opensips_3_1 opensips_3_2
Changed lines 20-23 from:
* opensips_3_0 is the existing DB name corresponding to version 3.0.x format
* opensips_3_1 is the DB name to be created for 3.1.x format

to:
* opensips_3_1 is the existing DB name corresponding to version 3.1.x format
* opensips_3_2 is the DB name to be created for 3.2.x format

Changed lines 73-117 from:
!!!! B2B_ENTITIES module
* dropped the '''replication_mode''' module parameter.

!!!! 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.

!!!! 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.

!!!! 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@@)

!!!! 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:
[@
# 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)
@]

!!!! 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:
[@
# 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)
@]

!!!! 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")@@
to:
!!!! FOOBAR module
* example
May 27, 2020, at 02:47 AM by rvlad_patrascu -
May 27, 2020, at 02:16 AM by rvlad_patrascu -
May 27, 2020, at 02:03 AM by rvlad_patrascu -
Added lines 73-75:
!!!! B2B_ENTITIES module
* dropped the '''replication_mode''' module parameter.
Added lines 91-93:

!!!! 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@@)
May 27, 2020, at 12:35 AM by rvlad_patrascu -
Added lines 78-87:

!!!! 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.
May 26, 2020, at 07:40 PM by liviu -
Added lines 23-25:

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

See [[https://github.com/OpenSIPS/opensips-cli/blob/master/docs/modules/database.md#database-migration-mysql-only|the opensips-cli documentation]] for more details.
May 26, 2020, at 07:39 PM by liviu -
Changed line 15 from:
You can migrate your 3.0.x MySQL DB to the 3.1.x format by using the '''opensipsdbctl''' tool :
to:
You can migrate your 3.0.x MySQL DB to the 3.1.x format using the '''opensips-cli''' tool :
Changed line 17 from:
# opensipsdbctl migrate opensips_3_0 opensips_3_1
to:
# opensips-cli -x database migrate 3.0_to_3.1 opensips_3_0 opensips_3_1
Deleted line 22:
Changed lines 27-30 from:

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

%red% NOTE that the default MySQL DB engine is now InnoDB! %%
to:
See [[https://github.com/OpenSIPS/opensips-cli/blob/master/docs/modules/database.md#database-migration-mysql-only|the opensips-cli documentation]] for more details.
May 26, 2020, at 02:00 PM by razvancrainea -
Changed line 79 from:
* 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.
to:
* 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.
May 26, 2020, at 01:59 PM by razvancrainea -
Added lines 75-80:

!!!! 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.
April 23, 2020, at 02:14 PM by 109.98.32.84 -
Added line 43:
* script variable [[Documentation.Script-CoreVar-3-1#af|$af]] to be replaced with [[Documentation.Script-CoreVar-3-1#socket_in|$socket_in(af)]]
April 23, 2020, at 01:24 PM by 109.98.32.84 -
Added lines 40-43:
* 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)]]
April 23, 2020, at 12:22 PM by 109.98.32.84 -
Added line 39:
* the '''tcp_listen_backlog''' parameter was renamed as '''tcp_socket_backlog''' parameter, with the same definition and behavior.
April 23, 2020, at 11:59 AM by 109.98.32.84 -
Changed lines 37-38 from:
The following is the full list of backwards-incompatible syntax or functional changes in the OpenSIPS configuration script (some of them are fixes):
to:
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.
January 16, 2020, at 05:54 PM by razvancrainea -
Changed lines 89-91 from:
!!!! 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.
to:
!!!! 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")@@
January 16, 2020, at 05:52 PM by razvancrainea -
Changed line 81 from:
* 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:
to:
* 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:
Changed lines 87-91 from:
@]
to:
@]

!!!! 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.
January 10, 2020, at 11:38 AM by razvancrainea -
Changed lines 73-74 from:
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)
to:
# 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)
Changed lines 83-84 from:
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)
to:
# 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)
January 10, 2020, at 11:37 AM by razvancrainea -
Changed lines 69-83 from:
* example
to:
!!!! 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)
@]
November 14, 2019, at 03:11 PM by 109.99.227.30 -
Changed line 41 from:
* example
to:
* 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.
August 20, 2019, at 07:56 PM by rvlad_patrascu -
Added lines 56-57:
* '''[[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
August 20, 2019, at 07:46 PM by rvlad_patrascu -
Changed line 1 from:
!!!!!Documentation -> [[Documentation.Migration|Migration]] -> Migration from 3.1.x to 3.1.0
to:
!!!!!Documentation -> [[Documentation.Migration|Migration]] -> Migration from 3.0.x to 3.1.0
Changed lines 6-7 from:
This section is meant to provide useful help in migrating your OpenSIPS installations from the '''3.1.0''' version to '''3.1.0'''.
to:
This section is meant to provide useful help in migrating your OpenSIPS installations from the '''3.0.0''' version to '''3.1.0'''.
Changed line 15 from:
You can migrate your 3.1.x MySQL DB to the 3.1.x format by using the '''opensipsdbctl''' tool :
to:
You can migrate your 3.0.x MySQL DB to the 3.1.x format by using the '''opensipsdbctl''' tool :
Changed line 20 from:
* opensips_3_0 is the existing DB name corresponding to version 3.1.x format
to:
* opensips_3_0 is the existing DB name corresponding to version 3.0.x format
Added lines 46-55:

!!!! 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()'''
April 16, 2019, at 09:55 PM by razvancrainea -
Added lines 1-57:
!!!!!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

Page last modified on January 31, 2022, at 05:54 PM