ElevateDB comes with a version of the ElevateDB Server called edbsrvr.exe for Windows and a command-line version of the ElevateDB Server called edbsrvr for Linux. The ElevateDB Server for Windows can be run as a normal application (with a GUI) or as a service. The ElevateDB Server for Linux can be run as a normal command-line application or as a service/daemon.

If running the ElevateDB Server as a normal application there is nothing else to do besides start up the ElevateDB Server from the directory in which the ElevateDB Server binary is located. You can find the ElevateDB Server binaries in the \servers\edbsrvr sub-directory under the main installation directory. There are separate subdirectories for 32-bit Windows, 64-bit Windows, and 64-bit Linux binaries.


Installing the ElevateDB Server as a Windows Service

---

If you wish to run the ElevateDB Server as a Windows service you must install it as a service by running the ElevateDB Server with the /install command-line switch set. For example, to install the ElevateDB Server as a service using the Run command window under Windows you would specify the following command:

edbsrvr.exe /install

To uninstall the ElevateDB Server as a Windows service you must run the ElevateDB Server with the /uninstall command-line switch set. For example, to uninstall the ElevateDB Server as a service using the Run command window under Windows you would specify the following command:

edbsrvr.exe /uninstall

Finally, by default the service will display a "Service installed" dialog box when the service is installed successfully. This is sometimes not desired during installations, and in these cases you can use the /silent command-line switch to suppress the dialog box:

edbsrvr.exe /install /silent

Installing the ElevateDB Server as a Linux Service

---

If you wish to run the ElevateDB Server as a Linux service you must install it as a service so that it can be managed by the systemd service manager. This can be accomplished by completing the following steps:

1. Copy the edbsrvr binary from the installation directory:

<InstallDir>\servers\edbsrvr\linux64

to the following target Linux system's binaries directory:

/usr/sbin

2. Create the systemd service file for the ElevateDB Server by using the following commands from a terminal window:

cd /etc/systemd/system

sudo gedit edbsrvr.service

Copy and paste the following information into the edbsrvr.service file being edited:

[Unit]
Description=ElevateDB Server

[Service]
Type=forking
ExecStart=/usr/sbin/edbsrvr

[Install]
WantedBy=multi-user.target

Save the service file using Ctrl-S and exit the gedit text editor.

3. Reload the service configurations for systemd using the following command in the terminal window:

sudo systemctl daemon-reload

4. Enable the service so that it will be loaded at boot time:

sudo systemctl enable edbsrvr

Starting the ElevateDB Server

---

The main difference between starting the ElevateDB Server as a normal application and starting the ElevateDB Server as a service is that the normal application can be started just like any other application while the service must be started using the operating-system-specific methods for doing so.

Starting the ElevateDB Server as a Normal Application Under Windows

You can start and configure the ElevateDB Server as a normal application by completing the following steps.

1. Start the ElevateDB Server (edbsrvr.exe) by clicking on the ElevateDB Server link in the Start menu.



2. Make sure that the server is using the desired character set and configuration file folder (C:\Tutorial).

a. In the system tray, right-click on the ElevateDB Server icon to bring up the server menu, and click on the Restore option on the server menu.



b. In the Tasks pane, click on the Stop Server link.



c. In the Tasks pane, click on the Edit Server Options link.



d. On the Server page, make sure that the Character Set is set to the desired value - either ANSI or Unicode.




e. On the Configuration page, make sure that the Configuration File - File Folder is set to the desired folder for the ElevateDB Server configuration file (EDBConfig.EDBCfg).



f. Click on the OK button.

g. In the Tasks pane, click on the Start Server link.



e. Click on the close button in the upper-right-hand corner of the ElevateDB Server window to close the server window.



Starting the ElevateDB Server as a Normal Application Under Linux

You can start and configure the command-line ElevateDB Server as a normal application by completing the following steps.

1. Make sure that the ElevateDB Server command-line server binary (edbsrvr) for Linux is copied into the desired location on the target system.

2. Create the edbsrvr.cnf configuration information file using the following commands from a terminal window:

cd /etc

mkdir elevate

cd elevate

mkdir edbsrvr

cd edbsrvr

sudo gedit edbsrvr.cnf

Copy and paste the following information into the edbsrvr.cnf file being edited:

[Server]
Configuration Folder=<Configuration File Location>
Configuration Name=EDBConfig
Large File Support=1
Maximum Log File Size=1048576
Log Information Events=0
Log Warning Events=1
Log Error Events=1
Catalog Name=EDBDatabase
Configuration File Extension=.EDBCfg
Lock Files Extension=.EDBLck
Log File Extension=.EDBLog
Backup Files Extension=.EDBBkp
Catalog Files Extension=.EDBCat
Table Files Extension=.EDBTbl
Table Index Files Extension=.EDBIdx
Table BLOB Files Extension=.EDBBlb
Temporary Tables Folder=/tmp
Server Name=EDBSrvr
Server Description=ElevateDB Server
Server Run Jobs=1
Server Job Category=
Server Job Retries=10
Server Address=
Server Port=12010
Server Thread Cache Size=128
Server Encrypted Only=0
Server Session Timeout=60
Server Dead Session Interval=30
Server Dead Session Expiration=30
Server Maximum Dead Sessions=64
Server Authorized Addresses=*<#CR#><#LF#>
Server Blocked Addresses=<#CR#><#LF#><#CR#><#LF#>
Update Files Extension=.EDBUpd
Table Publish Files Extension=.EDBPbl
Signature=edb_signature
Licensed Sessions=4096
Encryption Password=elevatesoft
Configuration In Memory=0
Show User Passwords=0
Character Set=0
Show Database Catalog Information=1
Server Encryption Password=elevatesoft
Cache Modules=1
Buffered File IO=0
Buffered File IO Settings=
Buffered File IO Flush Check Interval=60
Trace=0
Trace File Name=edbtrace.log
Auto-Increment Trace File Name=1
Max Trace File Size=134217728
Max Auto-Increment Trace File Name=64

Save the file using Ctrl-S and exit the gedit text editor.


3. Execute the ElevateDB Server binary using the following commands from a terminal window:

cd <Target Location>

./edbsrvr

where <Target Location> is the location where the ElevateDB Server binary was copied in step 1.

Starting the ElevateDB Server as a Windows Service

To start the ElevateDB Server as a Windows service, you can use the following command from the command-line:

net start edbsrvr

Starting the ElevateDB Server as a Linux Service

To start the ElevateDB Server as a Linux service, you can use the following commmands from a terminal window:

net start edbsrvr

Configuration Reference

---

On Windows, the ElevateDB Server stores its configuration information in an .ini file that is, by default, located in the following directory:

C:\ProgramData\Elevate Software\ElevateDB Server

On Linux, the ElevateDB Server stores its configuration information in a .cnf file that is, by default, located in the following directory:

/etc/elevate/edbsrvr

The name of the .ini or .cnf configuration file is determined by the name of the binary. For example, for the edbsrvr.exe Windows binary, the name of the .ini file would be edbsrvr.ini, and for the edbsrvr Linux binary, the name of the .cnf file would be edbsrvr.cnf.


All of the configuration entries in the ElevateDB Server .ini or .cnf configuration files are stored under a section called "Server" (see below for how multiple server instances can change this). Each of the individual configuration entries in this section are as follows:


Multiple Server Instances

---

Multiple instances of the ElevateDB Server can be run on the same physical machine through named server instances. Named server instances are simply instances of the ElevateDB Server that were executed using two special command-line switches:

edbsrvr.exe /name=<Server Instance Name> /desc=<Server Instance Description>

Named server instances use the passed name and description to provide the name of the ElevateDB Server instance, as well as the description. The name parameter is also used to determine which section of the edbsrvr.ini (Windows) or edbsrvr.cnf (Linux) file is used for configuration purposes. Instead of just the normal "Server" section being used, the section is named using the provided server name. For example, if the named server instance is called "MyServer", then the section where the configuration is stored will be the following:

[Server_MyServer]

The description parameter, if also specified, is immediately written to the named server instance section. All other configuration options described above in the Configuration Reference must be modified by running the ElevateDB Server as a normal application on Windows and using the Edit Server Options in the ElevateDB Server's user interface. You can run the ElevateDB Server as a normal application on Windows in order to modify the configuration of a named server instance. For example, to modify the MyServer configuration you would use the following from the command-line:

edbsrvr.exe /name=MyServer"

In order to use a named server instance as a Windows service, the /name parameter must be specified during the installation of the service. For example, if the named server instance is called "MyServer", then the service installation would be accomplished using the following from the command-line:

edbsrvr.exe /install /name=MyServer /desc="My Server"

When you want to start the named server instance as a Windows service, you would simply just use the following from the command-line:

net start MyServer

The following example shows how you would install two ElevateDB Server named server instances as Windows services, and then start them:

edbsrvr.exe /install /name=MyFirstServer /desc="My First Server"

edbsrvr.exe /install /name=MySecondServer /desc="My Second Server"

net start MyFirstServer

net start MySecondServer