Skip to content

Installing Configuration Server on Linux

The Configuration Server is an optional component that can be installed on Linux or Windows. Tt can be installed on any system that is network accessible from the systems that host the other components. If your system of record is Linux or Windows, that's a reasonable place to also host the Configuration Server. The overhead of Configuration Server on its host system is very low.

Preparing to Install

The Configuration Server runs as a systemd service. Default values are used for the user account name and user group to be used, but can be customized. For more information, refer to Preparing to Install on Linux.

Installation

Installing Configuration Server on a Linux system involves downloading and running an RPM installer. The installation can be downloaded from the Synergex Resource Center.

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

Configuration Server installer
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:

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

The product will be installed into the directory:

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

Configuation

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 edit the configuration file:

```text "Application settings file" /usr/lib/synergex/sip/config-server/appsettings.json 

The default configuration looks like this:

```json title="Default configuration"
{
  "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.

Service Management

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:

Show service status:
sudo systemctl status sip-config-server
Restart service:
sudo systemctl restart sip-config-server
Stop service:
sudo systemctl stop sip-config-server
Disable service:
sudo systemctl disable sip-config-server
Enable service:
sudo systemctl enable sip-config-server

Upgrades

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.
  • 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.
  • Perform any post-upgrade tasks as defined in the release notes.
  • Restart the service.
Upgrading Configuration Server
sudo systemctl stop sip-config-server
sudo systemctl status sip-config-server
sudo dnf install sip-config-server-n.n.n-n.el10.x86_64.rpm
sudo systemctl start sip-config-server

Removal

To remove the Configuration Server from a Linux system:

  • Ensure the Configuration Server service is stopped.
  • Remove the product using the package manager:
Removing Configuration Server
sudo systemctl stop sip-config-server
sudo systemctl status sip-config-server
sudo dnf remove sip-config-server