Skip to content

Database Deployment

After installing your OpenSIPS, most likely you will need to also deploy a database that you could use for various reasons ( DB user authentication, persistent registrations, dialogs, etc ).

The [Install_Path] token used throughout this page represents the installation path of OpenSIPS. This depends on the method of installation you chose. Common values you should look for are / if you installed OpenSIPS from public packages, or /usr if you installed it from sources, or whatever you explicitly set in your prefix variable.

Configuring DB Credentials

Section titled “Configuring DB Credentials”

Go to the [Install_Path]/etc/opensips/ folder and open the opensipsctlrc file

There take care of the following lines :

  • DBENGINE=
    • the currently available options MYSQL, PGSQL, ORACLE, DB_BERKELEY, or DBTEXT
  • DBHOST=
    • enter the host for your DB engine
  • DBPORT=
    • enter the port for your DB engine
  • DBNAME=
    • the name of the database which will be created
  • DBRWUSER=
    • the username that will be created in the database for OpenSIPS read/write access
  • DBRWPW=
    • the password that will be set for the DBRWUSER username
  • DBROOTUSER=
    • the user that will be used for creating the database, tables and DBRWUSER

Creating the Database

Section titled “Creating the Database”

In order to create the DBNAME database that you have provisioned above, run

[Install_Path]/sbin/opensipsdbctl create

When prompted by the opensipsdbctl tool, please enter your DBROOTUSER password.

If you want to create a different database other than the default DBNAME, you can call

[Install_Path]/sbin/opensipsdbctl create my_custom_db_name

The opensipsdbctl tool can also be used for things like taking backups, doing restores, and more. If you want to see the capabilities and help manual for the opensipsdbctl tool, you can run it with no parameters :

[Install_Path]/sbin/opensipsdbctl