Summary

A table of the Windows Installer properties for the Tachyon Server.

Mandatory properties must be provided when installing using a command-line.

Tachyon Setup is the only supported method of installing a Tachyon Server. Installation using the MSI is not supported unless advised by 1E, which may be necessary in complex installations, using non-interactive (quiet) command-lines.

PropertyDefaultMandatoryDescription

ACTIVE_DIRECTORY_SERVER

GC://Yes

Sets how the Tachyon Server queries Active Directory. The choice is between GC and LDAP methods.

GC method

Required if Tachyon users or groups exist in multiple domains or multiple trusted forests.

Supports only Universal security groups.

LDAP method

All Tachyon users and groups must exist within a single domain.

Supports Universal and Global security groups.

Required if a Global Catalog (GC) server does not exist in any trusted domain, or if Global AD Security groups must be used.

In either case, any domain(s) which contain Tachyon users and groups must be:

  • trusted by the domain in which the Tachyon Server exists
  • resolvable using DNS from the Tachyon Server

When using the GC method, specify GC:// alternatively you can specify GC://<domain> using the FQDN of any trusted domain, e.g. GC://acme.local. Specifying a domain does not matter because Tachyon uses it to locate the AD forest's root domain; and omitting the domain allows serverless binding to AD to achieve the same thing.

When using the LDAP method, specify LDAP://<domain> using the FQDN of the domain which contains all the Tachyon user accounts and groups, e.g. LDAP://acme.local

The Coordinator Workflow module queries AD for email details of Tachyon users, and the Consumer API queries AD for security details of Tachyon users to support Role-Based Access Control.

ADDLOCAL

ALLNo

Default is ALL when installing all components on a single-server. The following components (MSI features) are selected when installing a Master Stack, Response Stack and Custom configuration. Names are delimited by a comma and are case-sensitive.

Master StackResponse Stack
  • Authentication
  • ConfigurationViewer
  • Consumer
  • Coordinator
  • Database_MASTER
  • Explorer
  • Registration
  • Background
  • Core
  • CoreInternal
  • Database_RESPONSES
  • Switch

DEVICECOUNT

1000No

This is the number of devices supported by the Tachyon server which is being installed.

The number of devices supported by a Tachyon Server determines the number of Switches configured on the server.

The range is 1 to 250,000; default is 1,000.

A single server with suitable resources can support up to five Switches and up to 250,000 devices, with each Switch supporting up to 50,000 devices. Additional servers or configuration may be required according to the design of the Tachyon system. The total number of devices supported across the Tachyon system must not exceed the license file allocation.

DROPOLDDB_MASTER

0No

If set to 1 then the installer will drop the Tachyon Master database and attempt to create a new database. To create the database requires the server installation account has sysadmin rights on the SQL Server instance SQLSERVER_MASTER.

If set to 0 (default) then the installer will keep the existing Tachyon Responses database. This requires the installation account has db_owner rights on the database. This setting is used in the following scenarios.

  • For a new installation and an empty database has been pre-created.
  • When the database has been restored and Tachyon is being re-installed either during a recovery, or because the database has been moved to a new SQL Server instance.
  • Upgrading.

DROPOLDDB_RESPONSES

0No

If set to 1 then the installer will drop the Tachyon Responses database and attempt to create a new database. To create the database requires the server installation account has sysadmin rights on the SQL Server instance SQLSERVER_RESPONSES.

If set to 0 (default) then the installer will keep the existing Tachyon Responses database. This requires the installation account has db_owner rights on the database. This setting is used in the following scenarios.

  • For a new installation and an empty database has been pre-created.
  • When the database has been restored and Tachyon is being re-installed either during a recovery, or because the database has been moved to a new SQL Server instance.
  • Upgrading.

EXTERNALIISHOSTHEADER

TACHYON.<DomainFQDN>

Yes
Sets the host header used by the HTTPS binding of the Tachyon Website. This must be the same as the DNS Alias FQDN.

EXTERNALIISHOSTHEADER and HTTPSIISPORT configure the HTTPS binding that uniquely identifies the Tachyon Website used by the following:

  • Browsers connection to the Explorer (Explorer and Admin)
  • Tachyon Agent retrieving Agent resources from the Background Channel
  • Internal Tachyon services

HTTPSIISPORT

443Yes
Sets the port used by the HTTPS binding of the Tachyon Website.

EXTERNALIISHOSTHEADER and HTTPSIISPORT configure the HTTPS binding that uniquely identifies the Tachyon Website used by the following:

  • Browsers connection to the Explorer (Explorer and Admin)
  • Tachyon Agent retrieving Agent resources from the Background Channel
  • Internal Tachyon services

IISIPADDRESS

*Yes

Sets the IP Address used by the HTTP and HTTPS bindings of the Tachyon Website.

The default value of * sets IIS to listen on all IP addresses. On multihomed servers with multiple IP addresses you may optionally set this value, but in general we recommend leaving this as * to bind to all IP addresses.

If this value is set it must correspond to one of the IP addresses configured for the DNS Alias FQDN.

INTERNALIISHOSTHEADER, IISIPADDRESS and IISPORT configure the HTTP binding that uniquely identifies the Tachyon Website used by Tachyon Switches to forward responses from Agents to the Tachyon Core web application. This is the only Tachyon web application that permits HTTP, as the other web applications are all configured to require SSL.

IISPORT

80Yes
Sets the port used by the HTTP binding of the Tachyon Website.

INTERNALIISHOSTHEADER, IISIPADDRESS and IISPORT configure the HTTP binding that uniquely identifies the Tachyon Website used by Tachyon Switches to forward responses from Agents to the Tachyon Core web application. This is the only Tachyon web application that permits HTTP, as the other web applications are all configured to require SSL.

INTERNALIISHOSTHEADER

<HOSTNAME>.<DomainFQDN>

Yes
Sets the host header used by the HTTP binding of the Tachyon Website. This should be the hostname FQDN of the Tachyon Server.

INTERNALIISHOSTHEADER, IISIPADDRESS and IISPORT configure the HTTP binding that uniquely identifies the Tachyon Website used by Tachyon Switches to forward responses from Agents to the Tachyon Core web application. This is the only Tachyon web application that permits HTTP, as the other web applications are all configured to require SSL.

INSTALLDIR

%ProgramFiles%\1E\Tachyon\No

Sets the installation folder for all the Tachyon components.

For a non-default installation please refer to Services and NTFS Security.

LICENSEFILEPATH

 Yes

The full path, including the file name, must be provided for a valid Tachyon license file.

1E will provide you with a Tachyon.lic license file that defines the products and features your Tachyon System is able to use, for how long, and how many devices it supports, this may be an evaluation or subscription license.

  • The license must be activated. Once activated it may be used only by the Tachyon System that activated it.
  • Licences can be renewed or updated, but if allowed to expire then the affected products or features will not be usable.
  • For a new installation the license file must exist in the folder required by the Server Installer.
  • For an existing installation the license file is copied into the folder: %PROGRAMDATA%\1E\Licensing on your Tachyon Server.

LOGPATH

%AllUsersProfile%\1E\Tachyon\

No

Sets the path to the Tachyon server log files. It does not set the filename of each log.

See Tachyon Log Files for more details.

For a non-default installation please refer to Services and NTFS Security.

Not supported by Tachyon Setup. If you need to change the default location, please contact 1E.

MAILFROM

 Yes

Sets the mail-from email address used by the Tachyon Server when it sends emails.

For guidance about the Mail-From address see Email Requirements.

SERVERCERTIFICATETHUMBPRINT


No

Used by Tachyon Setup to uniquely identify which certificate was selected by the user for use by Tachyon components. Tachyon Setup uses the selected certificate to create the Switch certificate files, and then passes the certificate's thumbprint to the Tachyon installer to complete the installation.

If you are using the installer with command-line properties, instead of Tachyon Setup, then you can optionally specify a certificate's thumbprint. You will also need to manually create the Switch certificate files using the same certificate.

SERVERCERTIFICATETHUMBPRINT=3d699d8f28c2d7e0514cb0e047a1fd2f9db9bf4f

If you are using the installer instead of Tachyon Setup, and do not specify a thumbprint property in the command-line, the Tachyon installer will automatically select the first suitable certificate it finds in the server's Personal certificate store. In which case you must ensure there is only one suitable certificate, otherwise you may find Switches, and the bindings for the website and coordinator using different certificates. See Verify the Tachyon website HTTPS binding for details of how to change bindings after installation.

See Tachyon Server Certificates for requirements.

SMTPENABLED

1No

Determines whether Tachyon uses email for notifications.

If email is disabled then so is two-factor authentication which relies on email.

For guidance about using non-default SMTP settings, see Email Requirements.

If email notifications need to be disabled after installation, then see Changing the SMTP Host configuration.

If set to 1 then email is enabled.

If set to 0 then the following are disabled:

SMTPPORT

25No

Sets the port used to connect to the SMTP relay/gateway

Default is 25.

If the port needs to be changed after installation, then see Changing the SMTP Host configuration.

SMTPSERVER

 Yes

Sets the FQDN of the SMTP relay/gateway.

If the FQDN needs to be changed after installation, then see Changing the SMTP Host configuration.

SQLSERVER_MASTER

(local)Yes

Sets the name for the SQL Server instance that hosts the Tachyon Master database.

This can be set in one of the following formats depending on the setup of the instance.

(local)
ServerName
ServerName,PortNumber
ServerName\InstanceName
ServerName\InstanceName,PortNumber

SQLSERVER_RESPONSES

(local)Yes

Sets the name for the SQL Server instance that hosts the Tachyon Responses database.

This can be set in one of the following formats depending on the setup of the instance.

(local)
ServerName
ServerName,PortNumber
ServerName\InstanceName
ServerName\InstanceName,PortNumber

STARTSWITCH




TWOFACTORAUTHENABLED

1No

Determines whether Tachyon uses two-factor authentication.

If email is disabled then so is two-factor authentication which relies on email.

See Two-factor Authentication Requirements.

Default is same as SMTPENABLED.

WORKFLOWWEBPORT

8080No

Sets the port used by HTTPS binding of the Coordinator Workflow module. This is separate from the Tachyon Website.

Default is 8080.

This option should not need to be changed. It is provided to avoid conflicts in a lab installation where Tachyon is co-hosted with other services. To see if there may be a conflict, please check network port or firewall requirements in the vendor documentation.