November 28, 2016, at 11:28 AM by-
Changed line 1 from:
March 20, 2014, at 08:16 PM by-
Added lines 1-78:
Documentation -> Manuals -> Manual devel -> Generating Config Files
(:title Generating Config Files - 2.2:)
(:allVersions Generating-Configs 2.2:)
(:toc-float Table of Content:)
Generating OpenSIPS config files is accomplished by using the menuconfig tool. Because the graphical interface is ncurses based, please make sure to first install the ncurses development library ( typically libncurses5-dev ).
Using the Menuconfig Tool
The menuconfig can be ran either directly from the OpenSIPS sources, or post installation, from the installation path :
Once in the menuconfig tool, navigate to the 'Generate OpenSIPS Script' option, and then choose your desired script type. Once you have chosen you script type, you will be able to go to configure the various available options for that script ( described below ). Enabling certain options per script is done by using the spacebar key. Once you have configured your desired options, you can hit the 'q' key to go to the previous menu, and hit 'Save Changes'. Then, you can generate the OpenSIPS script with your configurations. At the end, the graphical tool will give you the path for your newly generated config file ( eg : Config generated : /usr/local/opensips_proxy_1.12/etc/opensips/opensips_residential_2013-5-21_12:39:48.cfg )
Types of Configs
So far, the OpenSIPS 1.12 menuconfig automated script generator supports 3 types of scripts. Here are the types of scripts, along with the available options per script :
Post-Generation Script editing
After generating your OpenSIPS script with the menuconfig tool, you need to open the script with your favorite editor, and go through all the '# CUSTOMIZE ME' comments in the script. Those comments mark the places where user attention is needed, and usually refer to customizing the OpenSIPS listening address or setting the proper database URL.
Upon making the appropriate '# CUSTOMIZE ME' changes, you can save your script and take it for a test drive.