Was this page helpful?
Yes No
Tableau Help > Tableau Server for Windows Help > 
Deploy > Automated Install > Configuration Options

Automated Installation Configuration Options

When you install or upgrade Tableau Server interactively by running the Setup program, the Configuration utility runs as part of the process, and you have the opportunity to configure Tableau Server. When you do an automated install or upgrade, you can include a custom configuration file with any non-default configuration values you want set. If you don't specify a custom configuration file while doing an automated installation of Tableau Server, the server is installed with defaults. If you do use a custom configuration file to set some non-default values, you do not need to include any settings that use defaults.

The tables below list configuration options, organized by Tableau Server Configuration utility tab:

A best practice for creating a configuration file for automated Tableau Server installation is to use an existing configuration file as a starting point and modify it for your new installation. For more information, see Best practices for an automated install.

General tab

Server Run As User

Important: For security purposes, we recommend that you do not include the Run As User credentials in a custom configuration file. You can put these separately in a "secrets" file that is secured elsewhere. You can see an example of how to do this in the sample ScriptedInstaller python script on GitHub.

Option Default Value Description
service.runas.username NT AUTHORITY\NetworkService The Windows account that Tableau Server uses when it accesses resources.
service.runas.password <not applicable>  

More information:

  • For detailed information on Run As User, see Run As User.
  • For information about the Run As User option on the General tab, see Server Run As User.

User Authentication

Option Default Value Description
wgserver.authenticate local Specify the type of user authentication to be used:
  • local will use the user-management built in to Tableau Server.
  • activedirectory will use Active Directory to authenticate users. For more information, see Authentication.

Example:

wgserver.authenticate: activedirectory

More information:

Active Directory

For more information, see User Authentication.

Option Default Value Description
wgserver.domain.fqdn <not applicable> Specify the fully qualified domain name for Active Directory.

Example:

wgserver.domain.fqdn: myco.lan

wgserver.domain.nickname <not applicable> Specify the NetBIOS name for Active Directory.

Example:

wgserver.domain.nickname: MYCO

wgserver.sspi.ntlm false Specify whether server should use Microsoft SSPI to automatically sign users in based on their Windows username and password.

Example:

wgserver.sspi.ntlm: true

More information:

Gateway

Option Default Value Description
worker.gateway.port 80 Port number for the gateway process.

Example:

worker.gateway.port: 8080

install.firewall.gatewayhold true Specifies whether Tableau Server should open the port specified by worker.gateway.port in the Windows firewall. This allows HTTP access to the server by other computers on your network.

Example:

install.firewall.gatewayhold: false

More information:

  • For information about the Gateway option on the General tab, see Gateway.

Sample data and users

Option Default Value Description
install.component.samples true Installs Tableau Samples.

Note: This option must be selected during initial install. You cannot go back and add samples after Tableau Server is installed.

Example:

install.component.samples: false

More information:

  • For information about the Sample data option on the General tab, see Sample data.

Server Crash Reporter

Option Default Value Description
servercrashupload.enable false Specifies whether crash report uploading is enabled.

Example:

servercrashupload.enable: true

servercrashupload.scheduled_time   01:00:00 AM Scheduled time for upload of crash logs, in UTC (HH:MM:SS AM/PM).

Example:

servercrashupload.scheduled_time: 03:00:00 AM

More information:

Data Connections tab

Caching

Option Default Value Description
vizqlserver.data_refresh <empty>
  • <empty> = refresh less often. Cache and reuse data for as long as possible.
  • <n> = balanced. <n> is the maximum number of minutes of caching
  • 0 = refresh more often, with the cache being refreshed with each page reload.

Example:

vizqlserver.data_refresh: 20

Initial SQL

Option Default Value Description
vizqlserver.initialsql.disabled false Specify whether to ignore initial SQL statements for all data sources.

Example:

vizqlserver.initialsql.disabled: true

More information:

Servers tab

Important: You must be consistent with the way you reference a particular node. For example, if you specify the primary node by machine name in worker.hosts you need to use the machine name for every configuration value that references the primary node. If you use an IP address to specify a worker node, you need to continue use the IP address for every instance of the worker node.

Worker 0 (primary)

Option Default Value Description
worker0.vizqlserver.procs

Number of cores / 4, up to a maximum of 4

n/4

Number of instances of VizQL Server installed on the node.

Example:

worker0.vizqlserver.procs: 4

worker0.vizportal.procs 1 Number of instances of Application Server installed on the node.

Example:

worker0.vizportal.procs: 1

worker0.backgrounder.procs 2 unless there are fewer than 8 cores, in which case default is 1 instance. Number of instances of Backgrounder installed on the node.

Example:

worker0.backgrounder.procs: 2

worker0.cacheserver.procs 2 unless there are fewer than 8 cores, in which case default is 1 instance. Number of instances of cache server installed on the node.

Example:

worker0.cacheserver.procs: 2

worker0.dataserver.procs 2 unless there are fewer than 8 cores, in which case default is 1 instance. Number of instances of data server installed on the node.

Example:

worker0.dataserver.procs: 2

worker0.dataengine.procs 1 Number of instances of data engine installed on the node.

Example:

worker0.dataengine.procs: 1

Note: If > 0, file store should also be installed (see below).

worker0.filestore.enabled true (when data engine is also installed) Specifies whether the file store is on the node. File store is only installed when data engine is installed.

Example:

worker0.filestore.enabled: true

worker0.searchserver.procs 1 Specifies whether the Search & Browse process is installed on the node. By default Search & Browse is installed.

Example:

worker0.searchserver.enabled: 0

worker0.gateway.enabled true Specifies whether the gateway service is installed on the node.

Example:

worker0.gateway.enabled: true

Worker 1 - n (workers)

Option Default Value Description
worker.hosts

<not applicable>

Machine name or IP address of the primary node and any worker nodes.

Example:

worker.hosts: tabserver, 10.32.139.21, 10.32.139.6

worker<n>.vizqlserver.procs

Number of cores / 4, up to a maximum of 4.

n/4

Number of instances of VizQL Server installed on the node.

Example:

worker1.vizqlserver.procs: 2

worker<n>.vizportal.procs 1 Number of instances of Application Server installed on the node.

Example:

worker1.vizportal.procs: 1

worker<n>.backgrounder.procs 2 unless there are fewer than 8 cores, in which case default is 1 instance. Number of instances of Backgrounder installed on the node.

Example:

worker2.backgrounder.procs: 2

worker<n>.cacheserver.procs 2 unless there are fewer than 8 cores, in which case default is 1 instance. Number of instances of cache server installed on the node.

Example:

worker1.cacheserver.procs: 1

worker<n>.dataserver.procs 2 unless there are fewer than 8 cores, in which case default is 1 instance. Number of instances of data server installed on the node.

Example:

worker1.dataserver.procs: 1

worker<n>.dataengine.procs 1 Number of instances of data engine installed on the node.

Note: If > 0, file store should also be installed (see below).

Example:

worker1.dataengine.procs: 0

worker<n>.filestore.enabled true (when data engine is also installed) Specifies whether the file store is on the node. File store is only installed when data engine is installed.

Example:

worker1.filestore.enabled: false

worker<n>.searchserver.procs 1 Specifies whether the Search & Browse process is installed on the node. By default Search & Browse is installed.

Example:

worker1.searchserver.procs: 0

worker<n>.gateway.enabled true Specifies whether the gateway service is installed on the node.

Example:

worker2.gateway.enabled: false

More information:

  • For more information about options on the Servers tab, see Servers.

Repository

Option Default Value Description
pgsql0.host <not applicable> Machine name or IP address of the node on which the repository is installed.

Example:

pgsql0.host: tabserver

pgsql1.host <not applicable> Machine name or IP address of the node if the repository installed on a second node.

Example:

pgsql1.host: 10.32.139.6

pgsql.preferred_host <not applicable> Machine name or IP address of the node with the preferred repository installed, if specified. This is only applicable if the cluster includes two instances of the repository.

Example:

pgsql.preferred_host: 10.32.139.6

More information:

SMTP tab

Option Default Value Description
svcmonitor.notification.smtp.server <not applicable> Address of SMTP server.

Example:

svcmonitor.notification.smtp.server: mail.example.com

svcmonitor.notification.smtp.send_account <not applicable> User name for SMTP account.
svcmonitor.notification.smtp.port 25 Port number for SMTP server.
svcmonitor.notification.smtp.password <not applicable> Password for SMTP server account.

Example:

svcmonitor.notification.smtp.password: password

svcmonitor.notification.smtp.ssl_enabled false Specifies whether the connection to the SMTP server is encrypted.

Note: This should be left as false. Encrypted SMTP connections are not supported for alerts or subscriptons.

svcmonitor.notification.smtp.from_address <not applicable> Email address that sends alerts. If email alerts are enabled, this needs to be in a valid email address format but does not need to be a valid address on Tableau Server.

Example:

svcmonitor.notification.smtp.from_address: donot-reply@example.com

svcmonitor.notification.smtp.target_addresses <not applicable> Email address to receive alerts. If email alerts are enabled, you need to include at least one address. Separate multiple addresses with commas.

Example:

svcmonitor.notification.smtp.target_addresses: iluvdata@example.com

svcmonitor.notification.smtp.canonical_url <not applicable> URL of the Tableau Server. Used in the footer of subscription email.

Example:

svcmonitor.notification.smtp.canonical_url: http://myserver.example.com

More information:

Alerts and Subscriptions tab

Alerts and Subscriptions

Option Default Value Description
subscriptions.enabled false Specifies if users can receive email for subscriptions to view.

Example:

subscriptions.enabled: true

svcmonitor.notification.smtp.enabled false Specifies whether email alerts are sent for server health events (components going up or down, failover occurring).

Example:

svcmonitor.notification.smtp.enabled: true

Disk Space Monitoring

Option Default Value Description
storage.monitoring.record_history_enabled true Specifies whether disk space usage should be saved in the repository.

Example:

storage.monitoring.record_history_enabled: false

storage.monitoring.email_enabled false Specifies whether email alerts will be sent if thresholds are crossed.

Example:

storage.monitoring.email_enabled: true

storage.monitoring.warning_percent 20 Warning threshold as a percentage of unused disk space.

Example:

storage.monitoring.warning_percent: 30

storage_monitoring.critical_percent 10 Critical threshold as a percentage of unused disk space.

Example:

storage.monitoring.critical_percent: 20

storage.monitoring.email_interval_min 60 Interval in minutes of disk space email alerts.

Example:

storage.monitoring.email_interval_min: 45

More information:

SSL tab

SSL requires that the SSL certificate and key pair be installed in in an \SSL folder parallel to the \<version> folder where Tableau Server is installed. For example, C:\Program Files\Tableau\Tableau Server\SSL.

External Webserver SSL

Option Default Value Description
ssl.enabled false Specifies whether SSL is enabled for connections between clients and Tableau Server.
ssl.cert.file <not applicable> Fully-qualified path to the certificate file (.crt).
ssl.key.file <not applicable> Fully-qualified path to the key file (.key).
ssl.chain.file <not applicable> Fully-qualified path to the certificate chain file (optional).
ssl.client_certificate_login.required false Specifies whether mutual SSL and automatic login should be used. Only valid if ssl.enabled is set to true.
ssl.cacert.file <not applicable> Fully-qualified path to CA certificate file (.crt).

More information:

Internal Repository Database SSL

Option Default Value Description
pgsql.ssl.enabled false   Specifies whether SSL is enabled for connections to the repository.
pgsql.ssl.required false
  • Required for all connections: if true and pgsql.ssl.enable = true
  • Optional for client connection: if false and pgsql.ssl.enable = true
  • Off for all connections: if false and pgsql.ssl.enable = false

More information:

SAML tab

SAML requires that the SAML XML and certificate and key pair be installed in in an \SAML folder parallel to the \<version> folder where Tableau Server is installed. For example, C:\Program Files\Tableau\Tableau Server\SAML.

Option Default Value Description
wgserver.authentication.login <not applicable> Specifies whether SAML is enabled.

Example:

wgserver.authentication.login: saml

wgserver.saml.returnurl <not applicable> The URL that Tableau Server users will access.
wgserver.saml.entityid <not applicable> The entity ID that identifies the Tableau Server installation to the IdP.
wgserver.saml.cert.file <not applicable> Fully-qualified path to SAML certificate file (.crt).
wgserver.saml.key.file <not applicable> Fully-qualified path to SAML key file (.key).
wgserver.saml.idpmetadata.file <not applicable> Fully-qualified path to SAML XML metadata file (.xml).
wgserver.saml.protocol http (if SAML is enabled) The protocol used by SAML. Required if SAML is enabled.
wgserver.saml.domain localhost (if SAML is enabled) The SAML domain. Required if SAML is enabled.
wgserver.saml.port 80 (if SAML is enabled)

 

More information:

Kerberos tab

To use Kerberos, you need to generate .keytab file by running the configuration script and publish that file.

Option Default Value Description
wgserver.kerberos.enabled false Specifies whether Kerberos is enabled.

More information:

  • For more information about options on the Kerberos tab, see Configure Kerberos.
  • For more information about Kerberos and Tableau Server, see Kerberos.

SAP HANA tab

Requires external configuration in addition to setting configuration values.

Option Default Value Description
wgserver.sap_hana_sso.enabled false Specifies whether SAP HANA is enabled.
wgserver.sap_hana_sso.username.format username Specifies how Tableau Server will use for the SAP HANA username:
  • username will use only the user name
  • domain_and_username will use a combination of the domain and the username
  • email will use the email address.
wgserver.sap_hana_sso.username.case preserve Specifies how to handle the case of the usename. By default the username is left unchanged.
  • preserve
  • upper
  • lower

More information:

OpenID Connect tab

Option Default Value Description
wgserver.authentication.login <not applicable> Specifies whether OpenID is enabled.

Example:

wgserver.authentication.login: openid

vizportal.openid.client_id <not applicable>  
vizportal.openid.client_secret <not applicable>  
vizportal.openid.config_url <not applicable> URL the IdP uses for OpenID Connect discovery.

More information: