Installing the Helix Plan server - Linux

Make sure the computer you upgrading the server version on meets the current system requirements.

Use one of the following methods to download the newest version:

  • If using a web browser, download the latest Helix Plan Server version for Linux
  • If using Wget, run the following command:

    • Copy 
    $ wget -O NewHelixPlanServer.zip https://hansoft.com/downloads/latest-linux-server/

Run the installation and when asked, install the program where you want the database files to be located. You can later move the database, backup and transaction log location. The default location is however under the server program directory. /opt is a common install location for optional software on Linux.

To encrypt all data stored on the Helix Plan Server, use an encrypted disk. If you do not use an encrypted disk, some data related to Helix Plan on the server will remain unencrypted. Only the user running the server should have access to the database, installation, and backup folders.

Installation process

The following actions are performed by the interactive installer:

  • Create a server state
  • Create a database
  • Create user and group to run as unless they already exists
  • Register server as a system service allowing it to start at boot
  • Start the service

Interactive setup

When installing, make sure that you have the appropriate installation files adjusted for your OS.(32 or 64 bit)

Start by extracting the contents of the zip file

unzip "Helix Plan Server 10.2017 Linux2.6 x64.zip"

Once you have extracted the package at a desired location, navigate to the Helix Plan server directory.

Run the -Install command from the HPMServer.

sudo ./HPMServer -Install

The sudo command gives you root access, which is required in order to install the server.

Server name The name of the server
Server hostname The server address
Server port The port that will be used by the server
Server admin password This is the password used to log in to the server administrator client and is used to perform administrative tasks such as backup and restore.
Database name The name of the database. You can later create several more databases in order to attain data isolation.
Database admin password The password for the Administrator user of the database. This password is used to log in to the Helix Plan client and perform administrative actions for this database.
Service name The name of the service
User to run service as The user that will run the service. If the username you provided is not already associated with an existing user, Helix Plan will create one for you.
Group to run service as If the groupname you provided is not already associated with an existing group, Helix Plan will create one for you.

Non-interactive setup

If you do not wish to install interactively, for example when using an installation script, you can add these commands after -Install in order to pre-define some or all settings.

Command Description
-ServerName <name> Name of server.
-ServerHostname <name> Hostname server is accessed through.
-Port <port> Port server should listen to.
-ServerAdminPassword <password> The password for the server administrator client.
-DatabaseName <name> Create database with name.
-DatabaseAdminPassword <password> Password for 'Administrator' in created database.
-SMTPServer <server address> Email notifications SMTP server.
-SMTPPort <port> Email server port.
-EmailFromName <name> Name appearing as from on emails.
-EmailFrom <email address> Email address appearing on the emails sent from the server.
-EmailSubject <subject> Subject of email notifications.
-EmailToEmail <target address> Email to send notifications to.
-Service <name> The unique name of the service.
-RunAsUser <name> The user to run the service as.
-RunAsGroup <name> The group to run the service as.
-SDKUser <username>:<password> Create an SDK user.

Example:

Copy 
sudo ./HPMServer -Install -ServerName ExampleServer -ServerHostname Bigserver01 -Port 50256 -ServerAdminPassword qwerty -DatabaseName "Example Database" -DatabaseAdminPassword qwerty2 -ServiceName HPServer1 -RunAsUser hansoft -RunAsGroup hansoft

Check the server log for any problems after the installation has finished. See Configuring logging options and email notifications.

Setting up the Helix Plan service manually

Follow the steps below to manually setup the Helix Plan Server as a service on your Linux machine:

1. Create a group and user that will run the service. Remember to set a sudo password for this user.

2. Download the Helix Plan Server.

3. Move the Helix Plan Server zip file to the directory of your choice (“opt” for instance).

4. Unzip the Helix Plan Server files in the new location.

5. Change ownership of the Helix Plan Server and all its content to the user and group made in step 1.

6. Switch to the above mentioned user.

7. Run the command ./HPMServer -Service <service name> & from the HelixPlanServer directory. This will add and start the service.

9. If you have not downloaded and installed the Helix Plan client separately, copy it from ServerSync/Client/Linux/x64/HelixPlan

10. Launch HelixPlan -AdminServer

11. Connect to your server, which is usually localhost, port 50256.

12. Login using the default password hpmadm

13.Change your password by clicking the Administrator Password button under the Server Settings section in the right-hand side vertical panel.

You can now use either the command line or the Using the Helix Plan Server Administrator client to create a database and setting database administrator passwords.

Next steps

You can also use the command line or the Using the Helix Plan Server Administrator client to create additional databases and changing database administrator passwords.