Documentation

Documentation.Configure-RC-1-6 History

Hide minor edits - Show changes to markup

August 05, 2013, at 03:53 PM by 109.99.235.212 -
Changed line 4 from:

Page for other versions: devel 1.9 1.8 old versions: 1.7 1.6 1.5 1.4

to:

(:allVersions Configure-RC 1.6:)

May 29, 2013, at 08:13 PM by vlad_paiu -
Changed lines 13-19 from:

The OpenSIPS configuration file contains all the parameters that control the OpenSIPS core and modules, along with the actual routing logic that OpenSIPS will use to route the SIP traffic.


Upon installation, the default configuration file path is :

to:

The opensipsctlrc is the file that contains all the configuration options for the opensipsctl, opensipsdbctl and osipsconsole tools.

Upon installation, the file is located in

Changed line 17 from:

[INSTALL_PATH]/etc/opensips/opensips.cfg

to:

[INSTALL_PATH]/etc/opensips/opensipsctlrc

Changed lines 20-48 from:


The configuration file is text-based, written in an OpenSIPS custom language, very similar to the C language. You will find different variables ( each with different scopes - explained further down the manual ), you can do the classical constructs like if / while / switch, etc, and you can also call sub-routines with parameters, so the script should be fairly easily read-able by somebody with some SIP & programming skills.


If you do any change to the configuration file, in order for them to take effect, you MUST restart OpenSIPS


Due to the fact that you must restart OpenSIPS every time you make a change to the configuration file, it is of vital importance to ensure that all the changes you have made are correct according to the OpenSIPS language syntax.

You can check the OpenSIPS configuration file validity by running


[INSTALL_PATH]/sbin/opensips -C [PATH_TO_CFG]


When checking the configuration file for validity, If the cfg is OK, OpenSIPS will return 0.


If the config file contains any errors, they will be displayed in the console and OpenSIPS will return -1

to:

The file contains control options for interacting with the database, for run-time interaction with OpenSIPS ( eg. via the MI interface ) and also some control options for the provisioning done via the opensipsctl and osipsconsole tools.

The most relevant / used options are the following :

  • SIP_DOMAIN - The SIP domain for your OpenSIPS proxy, useful for when adding new users in the system ( via the opensipsctl tool )
  • DB parameters - Contain the DB credentials use by the opensipsdbctl when creating the DB structure, and also by the opensipsctl when inserting provisioning information
  • CTLENGINE - The transport that will be used by the FIFO engine when running MI commands from the opensipsctl tool. Options are FIFO, XMLRPC and UDP
  • OSIPS_FIFO - Path to the OpenSIPS FIFO file for the current OpenSIPS instance. In case you have multiple OpenSIPS instances deployed on the same machine, you should change this.
  • STORE_PLAINTEXT_PW - Controls whether, when adding a user via the "opensipsctl add username" pass command, the password will be stored in plaintext format in the DB, or if the DB should just contained the HASH version of the provided password.
May 29, 2013, at 08:07 PM by vlad_paiu -
Changed lines 13-52 from:

TO BE DONE

to:

The OpenSIPS configuration file contains all the parameters that control the OpenSIPS core and modules, along with the actual routing logic that OpenSIPS will use to route the SIP traffic.


Upon installation, the default configuration file path is :

[INSTALL_PATH]/etc/opensips/opensips.cfg


The configuration file is text-based, written in an OpenSIPS custom language, very similar to the C language. You will find different variables ( each with different scopes - explained further down the manual ), you can do the classical constructs like if / while / switch, etc, and you can also call sub-routines with parameters, so the script should be fairly easily read-able by somebody with some SIP & programming skills.


If you do any change to the configuration file, in order for them to take effect, you MUST restart OpenSIPS


Due to the fact that you must restart OpenSIPS every time you make a change to the configuration file, it is of vital importance to ensure that all the changes you have made are correct according to the OpenSIPS language syntax.

You can check the OpenSIPS configuration file validity by running


[INSTALL_PATH]/sbin/opensips -C [PATH_TO_CFG]


When checking the configuration file for validity, If the cfg is OK, OpenSIPS will return 0.


If the config file contains any errors, they will be displayed in the console and OpenSIPS will return -1

May 29, 2013, at 01:29 PM by 109.99.235.212 -
Added lines 1-13:
Documentation -> Manuals -> Manual 1.6 -> Configuration RC File

(:title Configuration RC File - ver 1.6 :)


Page for other versions: devel 1.9 1.8 old versions: 1.7 1.6 1.5 1.4


Configuration RC File 1.6
PrevNext

TO BE DONE


Page last modified on August 05, 2013, at 03:53 PM