Was this page helpful?
Yes No

Configure Initial Node Settings

Tableau Server on Windows now includes Tableau Services Manager (TSM), which replaces the Configuration Utility and the tabadmin command line tool. If you need help for an earlier version of Tableau Server, see the Tableau Help page.

This topic describes how to configure essential server settings as part of the initial Tableau Sever installation process.

Prerequisite

Before proceeding with the procedures in this topic, complete the following prerequisites as outlined in Install and Configure Tableau Server:

After you have activated and registered Tableau Server, the installation program will display the Setup page.

If you need to configure Tableau Server to connect to an LDAP directory that is not Active Directory, then you must use the Configure Initial Node Settings.

Identity store settings

You must configure the identity store settings for the Tableau Server computer. The identity store manages Tableau Server accounts. You can configure the identity store to synchronize with an external directory (for example, OpenLDAP or Active Directory) or you can configure the identity store to manage and store accounts on Tableau Server. If you will be using a single sign on solution (OpenID, SAML, Kerberos, etc) then review the following topics before configuring the identity store:

Important: After you have configured and applied settings for the identity store, it cannot be changed. .

If you select Active Directory, Tableau Server will populate the Domain and NetBIOS fields from the computer on which you are running Setup. In some cases, Setup may not display these attributes. For more information about how Tableau Server connects and communicates with Active Directory, see User Management in Active Directory Deployments.

Run As service account

By default, Tableau Server runs under the Network Service account. To use an account that will accommodate NT authentication with data sources, specify a user name and password. See Run As Service Account to learn more about creating and using a specific user account.

Important: Include the domain name with the user name—for example, example\tableaurunas.

Enter the password that you created for this account.

Gateway port

The default port for web access to Tableau Server (via HTTP) is port 80. If the installation program determines that port 80 is in use when you first install Tableau Server, an alternate port (for example 8000) is used and shown in the Port number box.

You may need to change the port for other networking needs, for example, if you have a hardware firewall or proxy in front of the Tableau Server host, this might make running a back-end system on port 80 undesirable.

Sample workbook installation

By default, Tableau Server will install sample workbooks in the Default site when you initialize the server.

Alternatively, you can publish samples after installation by using the publishsamples tabcmd command.

After you have configured the options on this page, click Initialize.

The initialization process can take a while. When initialization is complete the following page is displayed:

First, configure identity store, gateway settings, and sample workbook installation. Then apply the changes, optionally verify your LDAP connection, and then initialize Tableau Server

Configure identity store settings

You must configure the identity store settings for the Tableau Server computer.

Important: After you have configured and applied settings for the identity store, it cannot be changed.

Use the json template in the identityStore Entity to create a json file. After you have filled in the options with the appropriate values, you can then pass the json file with this command:

tsm settings import -f path-to-file.json.

Configure gateway settings (optional)

Depending on your network requirements, you may need to configure the gateway settings for the Tableau Server computer. For example, if you are enabling SSL or configuring access to Tableau Server with a reverse proxy, you may need to configure gateway settings. See gatewaySettings Entity for more information.

Use the json template in the gatewaySettings Entity to create a json file. After you have filled in the options with the appropriate values, you can then pass the json file with this command:

tsm settings import -f path-to-json-file.json.

Configure sample workbook installation (optional)

By default, Tableau Server will install sample workbooks in the Default site when you initialize the server.

If you do not want to install sample workbooks during installation, run the following command:

tsm configuration set -k install.component.samples -v false

You can publish samples after installation by using the publishsamples tabcmd command.

Apply pending configuration changes

Now that you've created and set initial configuration, you must apply them. When you apply configuration changes, tsm will verify the settings you've set before committing them.

To apply configuration changes to Tableau Server, run this command:

tsm pending-changes apply

The pending-changes apply command displays a prompt to let you know this will restart Tableau Server if the server is running. The prompt displays even if the server is stopped, but in that case there is no restart. You can suppress the prompt using the --ignore-prompt option, but this does not change the restart behavior. For more information, see tsm pending-changes apply.

Once this command has completed, TSM processes are running, and Tableau Server is configured but is not running.

Verify LDAP configuration (Optional)

If your identity store uses Active Directory or OpenLDAP, then we recommend verifying LDAP connectivity before proceeding.

To do so, run the following commands before you initialize the server:

tsm user-identity-store verify-user-mappings -v <user name>

tsm user-identity-store verify-group-mappings -v <group name>

User and group names must be valid names that exist in the LDAP server that you are connecting to. If your LDAP connection is set up correctly, then the user or group attributes will be returned to the shell. If your connection is not set up correctly, then an error will be returned.

Initialize and start Tableau Server

  • To initialize and start Tableau Server, use the --start-server option:

    tsm initialize --start-server --request-timeout 1800

    This saves time by starting the server running after initialization.

  • If you are going to reconfigure Tableau Server after initialization, leave the --start-server option off:

    tsm initialize --request-timeout 1800

    This stops the server after initialization.

Start Tableau Server. If you did not use the --start-server option during initialization and are finished configuring Tableau Server, use this command to start the server:

tsm start --request-timeout 900

Next Step

After initialization is complete, create the Tableau Server administrator user account. See Add an Administrator Account.