Installation

Prev Next

This article walks through the process for a first-time Lynx installation.

Step 1 - Run the Installer

The Lynx installer includes the files necessary for Steps 2-5, for configuration of the Lynx Server.

  1. Run the installation file, "Lynx-1.7.x.x-Setup.exe".
    • Note: The actual file name may be slightly different depending on which version you are installing.
  2. Accept the License Agreement to proceed with the installation.
  3. Allow the installation wizard to run to completion.
  4. Click Finish to exit the wizard.

Default Install Path
C:\Program Files (x86)\HealthCast\Lynx


Step 2 - Edit the PowerShell Scripts

The PowerShell script binds the certificate to the port you choose, making it possible to enforce the SSL requirement. It also automatically creates the necessary firewall rules.

  1. Locate the PowerShell script C:\Program Files (x86)\HealthCast\Lynx\Lynx.Config.ps1.

  2. Edit the following two lines to provide values specific to your environment:

    $certificateThumbprint = "your-cert-thumbprint"
    $port = 443
    
    ℹ️ Finding the Certificate Thumbprint

    The certificate's thumbprint can be found by opening the “Certificates – Local Computer” app (certlm.msc) > Personal > Certificates folder. Double-click the certificate you wish to use and click the Details tab and find the “Thumbprint” value.

    ℹ️ Port

    Change this value if needed. If you change this value, it will also need to be changed in the config.ini file. See Step 3 below.


Step 3 - Edit the .ini File

Lynx comes with a default configuration that may be suitable for your situation. However, if you need to configure any Lynx parameters, you may do so by following these steps:

  1. Stop the HealthCast Lynx service.
  2. In server's File Explorer, navigate to C:\ProgramData\HealthCast\Lynx.
    1. Make a copy of the sample-config.ini file in the same folder and rename it to "config.ini".
  3. Edit the config.ini to change the settings as needed (see Lynx Configuration Settings below).
  4. Save your changes.
  5. Start the HealthCast Lynx service.

Lynx Configuration Settings

ServerPort=443   # Same port configured in Step 2
DatabaseType=0   # 0=Embedded database, 1=SQL Server database
DatabaseServer=SqlServerName   # If using SQL, the name of your database server
DatabaseName=MyDatabase   # If using SQL, the name of the database
RequireAdminRole=true  
AdminRoleName=Lynx Admins
ProxCardTableType=0   # 0=Lynx proxcard table, 1=pre-XA 4.11, 2=XA 4.11 and above
ℹ️ RequireAdminRole and AdminRoleName

These two settings only affect who can log in to the Lynx Admin web app. They do not affect who can use their prox card, etc.


When RequireAdminRole is set to true, then Lynx will only allow those users who are members of the Windows group specified in the AdminRoleName setting to log into the Lynx Admin web app.



If the RequireAdminRole setting is false, then any user with a valid Windows login will be able to login to the Lynx Admin web app.

⚠️ Leave Default Settings Alone

If any of the settings are NOT changed or required, like the SQL information because you are using the embedded database, leave the line as is. Any other lines that are "unused" should also be left as they originally appear when opening the file.

If you're unsure of changes that may have been made, you can make a new copy of the sample-config.ini file to start over.



🛑 If you are using the embedded database, Steps 4-5 can be skipped.

Step 4 - SQL

Configure the SQL Login

You will need to create a new login for the Lynx service account if you haven’t already done so.

ℹ️ If you don’t have SQL admin privileges, you will need to enlist the help of your sysadmin or DBA.
  1. In SSMS, expand the Security folder > Logins > right-click New Login.
  2. Fill in the Login name using the Lynx service account.
  3. On the left-hand side, go to User Mapping.
    1. In the main window, check ☑ the Proximity Card Database you’re going to use.
    2. In the bottom section, check ☑ to enable the db_datareader and db_datawriter roles.
    • Note: If you’re using Windows Authentication, the db_owner permission will already be set from the ExactAccess configuration, and the account will not require the additional permissions.

Run the SQL Script

  1. Locate the XA database on the SQL server and note the name.
    1. If one does not exist, create a database on the SQL server and note the name.
  2. Using SQL Server Management Studio, open the SQL script C:\Program Files (x86)\HealthCast\Lynx\CreateDB.sql.
    1. Change the name of the database in the first line of the script to the appropriate database name.
  3. Execute the script and refresh the tables list to verify the tables were created.

Step 5 - Configure Lynx Service Account

This is for the 'Log On As' account.

  1. Open the Services Console.
  2. Locate and double-click the HealthCast Lynx service to open the Properties dialog box.
  3. Click the Log On tab, then select This account.
  4. Enter the username and password of the account you are going to use to connect to the database.
  5. Restart the HealthCast Lynx service. If everything has been configured correctly up to this point then the service should start, and it will indicate a status of “Running”.
ℹ️ Self-Service Password Reset (SSPR)

If you are planning to configure and enable Lynx for Self-Service Password Reset, the account used will require sufficient domain privileges to be able to reset passwords. See our SSPR article for more information.


Validate the Configuration

Once you have successfully installed and configured the Lynx Server software, you will need to log into the Lynx admin tool to verify you can access it.

  1. Open any supported browser (IE 10+, Chrome, Edge, Firefox) and enter the following URL:
    https://ServerFQDN:ServerPort

    ℹ️ Note

    ServerFQDN will be the fully-qualified domain name of the server that Lynx was installed on.
     
    ServerPort will be the port you specified in Step 2 when running the PowerShell configuration script.

    • Note: You do not have to include ServerPort if you are using port 443.
    🛑 Certificate Errors

    If configured correctly, you should not receive any certificate errors or warnings. If you do, please resolve any of these before continuing.

  2. You should be brought to the login. Here, you will log into the system using your Windows credentials.
    Image


    a. If you can successfully authenticate (but are not a member of the Lynx admins group) and you attempt to access an area of the site that requires admin privileges you will see the following screen:
    Image


    b. If you can authenticate successfully, you will be brought to the following menu and screen:
    Image