Skip to content

Installing Configuration Server on Linux

Installing the Configuration Server

Installing the Configuration Server on a Linux system involves downloading and running a product installation. The installation can be downloaded from to be determined.

The name of the installation file will be as shown below, where n.n.n-n is the version number of the product you have downloaded.

sip-config-server-n.n.n-n.el9.x86\_64.rpm

The installation is started using the package manager and requires root privileges, like this:

sudo dnf install sip-config-server-n.n.n-n.el9.x86_64.rpm

The product will be installed into the directory:

/usr/lib/synergex/sip/config-server

Configuring the Configuration Server

By default the Configuration Server runs on port 5120 and the service should be auto-registered and started by the installer. If you want to make configuration changes, you can do so by editing the configuration file:

/usr/lib/synergex/sip/config-server/appsettings.json

The default configuration looks like this:

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*",
  "HttpsPort": 5120,
  "TlsCertFile": "ConfigServer.pfx",
  "TlsCertPassword": "p@ssw0rd",
  "WaitForDebuggerAttach": false,
  "ConfigServer": {
    "AllowedClients": [
      "sip-isam-agent",
      "sip-message-broker",
      "sip-snapshot-agent",
      "sip-sql-agent"
    ],
   "ClientPassword": "p@ssw0rd"
  }
}

If you want to change the TCP/IP port number used by the Configuration Server or the password that must be supplied by other components in order to use the Configuration Server, you can do so by changing the values of the HttpsPort and ClientPassword properties. If you change either or both of these, you must also alter that port number in the configuration files of all other components in use in the environment, and then restart those services.

Under normal circumstances, it should not be necessary to change the other properties.

Managing the Service

The Configuration Server runs as a standard Linux systemd service and can be controlled using the systemctl utility. Some examples of common systemctl command are as follows:

To show the status of the service:

sudo systemctl status sip-config-server

To restart the service:

sudo systemctl restart sip-config-server

To stop the service:

sudo systemctl stop sip-config-server

To unregister the service:

sudo systemctl disable sip-config-server

To reregister the service:

sudo systemctl enable sip-config-server

Upgrading the Configuration Server

To upgrade the Configuration Server to a new version:

  • Review the release notes for the new version so you're aware of any prerequisite tasks or tasks that must be completed after the upgrade.
  • Download the installer for the new version and copy it to the target system.
  • Make sure you still have the installer for the version you're currently running, in case you need to revert to that version for any reason.
  • Perform any prerequisite tasks as defined in the release notes.
  • When you're ready to perform the upgrade, stop the service:

bash sudo systemctl stop sip-config-server

  • Execute the installer for the new version. You don't need to remove the old version; the installer for the new version will perform an in-place upgrade.

bash sudo dnf install sip-config-server-n.n.n-n.el10.x86\_64.rpm

  • Perform any post-upgrade tasks as defined in the release notes.
  • Restart the service.

bash sudo systemctl start sip-config-server

Removing the Configuration Server

To remove the Configuration Server from a Linux origin system,

  • Ensure the Configuration Server service is stopped.
  • Similar to when the product was installed, remove the product using the package manager:

bash sudo dnf remove sip-config-server