Was this page helpful?
Yes No

Install and Initialize TSM

This topic guides you through the process of installing Tableau Server and initializing Tableau Services Manager (TSM).

Important: Do not install a beta version of Tableau Server in your production environment. You should also never restore a production Tableau Server installation using a backup of a beta version.

Prerequisites

Before proceeding, review the topic, Before you install....

Review optional initialization parameters

Before you install and initialize TSM, it is critical that you review the parameters that you may optionally set as part of the initialization operation. You can only run initialize-tsm once, so be sure to run it with all of the options that your organization needs. Some options, such as non-default system user and group can only be configured as part of the initialization operation. Other configurations, such as forward proxy and dynamic port settings can be manually set after you run initialization, but doing so is a much more labor-intensive process.

For a complete list of optional parameters, see Help Output for initialize-tsm Script.

Some common scenarios where optional initialization parameters are used :

  • Configuring Tableau Server to work with a forward proxy server. See Optional: common initalize-tsm parameters, later in this topic, to configure Tableau Server during installation. You can also configure Tableau Server after you install, see Configuring Tableau Server on Linux to work with a forward proxy
  • Specifying dynamic port mapping. By default, most ports needed by Tableau Server are assigned (mapped) dynamically from a predefined range of ports. The port assignments are made for each service or process during installation. If you want to modify port mapping, we recommend configuring this during installation, see Controlling port remapping with initialize-tsm.
  • Specifying non-default system user or group This configuration change can only be performed during initialization. See System user and groups.
  • Specifying a non-default data directory. This configuration change can only be performed during initialization. See Data directory.

Install Tableau Server

Install Tableau Server with your distribution’s package manager, then run a script to initialize TSM. The script is included with the installed package.

Important: The hostname of the server must not change after you start TSM. For example, this might happen if you use the cloud-init package to initialize a virtual machine, and you install Tableau Server on that virtual machine.

Install the Tableau Server package

By default, Tableau Server is installed in the /opt directory. On RHEL-like distributions you can specify a different install location.

  1. Log on as a user with sudo access to the computer where you want to install Tableau Server.

  2. Download the .rpm or .deb installer package from the Tableau Server Downloads and Release Notes page.

  3. Navigate to the directory where you copied the .rpm or .deb package.

  4. Use the package manager to install the Tableau Server package.

    • On RHEL-like distributions, including CentOS, you have the option to install Tableau to a non-default location. If you choose to do so, you need to

      • Default location—To install to the default location (/opt/tableau/tableau_server), run the following commands:

        sudo yum update

        sudo yum install tableau-server-<version>.x86_64.rpm

      • Non-default location—To install to a non-default location, you must use rpm -i. You will also need to install all dependent packages. See the note below.

        Run the following command:

        sudo rpm -i --prefix /preferred/install/path tableau-server.rpm

      Note: When you use yum to install Tableau Server, all dependent packages are automatically downloaded and installed. This is the preferred method for installing Tableau. If you want to install to a non-default location, or your organization does not allow you to use yum and you must install using rpm -i, you must also install all dependent packages separately. For information about installing dependent packages, see Installing Tableau Server on an Air-Gapped Computer Running Linux.

    • On Ubuntu, run the following commands:

      sudo apt-get update
      sudo apt-get -y install gdebi-core
      sudo gdebi -n tableau-server-<version>_amd64.deb
      

Initialize TSM

You can specify a separate location for data (extracts and extract metadata) storage, whether or not you install Tableau to the default location.

  1. Navigate to the scripts directory:

    cd /opt/tableau/tableau_server/packages/scripts.<version_code>/
  2. Run the following script to start TSM:

    sudo ./initialize-tsm --accepteula --<optional_parameters>

    The only required parameter for the initialize-tsm script is --accepteula. You must include this parameter to accept the Tableau Server End User License Agreement (EULA). The EULA is available in the following location:

    /opt/tableau/tableau_server/packages/docs.<version_code>/Commercial_EULA.txt

    However, review the following common parameters before running the script.

    Optional: common initalize-tsm parameters

    There are a number of parameters (also referred to as, flags) that you can set when you run initialize-tsm. Common flags are listed below. For a complete list, run the command, sudo ./initialize-tsm -h, or see Help Output for initialize-tsm Script.

    • The -a flag to specify a user to be added to the tsmadmin and tableau groups instead of the user running this script. If you are installing with the root account, the you must specify the -a flag,

    • The --unprivileged-user flag to set a different service account. By default a new user called tableau will be created. This account is an unprivileged service account under which most Tableau process run. We recommend creating a different user only in the case where a tableau user account already exists on the computer.

    • The -d flag to specify a non-default location of the "data directory" where Tableau Server stores extracts, information about extracts, and more.

      By default, Tableau Server uses the following location for the directory:

      /var/opt/tableau/tableau_server

      When you set this flag, the intialize-tsm script will create and apply permissions to the directory that you specify. There are important restrictions that apply to changing the default directory path. See Data directory.

    • The --debug flag for troubleshooting. This option displays each command in the script as it is run and can make it easier to troubleshoot issues. Use of this option results in extensive output to the screen.

    • We recommend configuring Tableau Server for a forward proxy solution during installation.

      To do so, include the --http_proxy and/or --https_proxy flags to specify the forward proxy server. Specify the URL with the port, for example:

      --http_proxy=http://proxy.exampe.lan:80/

      --https_proxy=http://1.2.3.4:443/

      Take care to use http when you specify the URL for the https_proxy environmental variable. Do not specify the https protocol for the value of the https_proxy environmental variable.

      To configure Tableau Server to bypass the forward proxy, include the --no_proxy flag. You should also add exceptions to this proxy configuration to guarantee that all communications within a local Tableau Server cluster (if you have one now or will have one later) do not route to the proxy server. For example:

      --no_proxy=localhost,127.0.0.1,localaddress,.localdomain.com.

    • If you want to manually manage port assignment for TSM and Tableau Server processes, you may need to use one or more port-related switches with initialize-tsm. For more information, see Controlling port remapping with initialize-tsm.

  3. Log off and log on again to the terminal before you configure Tableau Server.

    When you log on again, you create a new session in which group membership changes have taken effect. The new session also has access to the environment variables added by the initialize-tsm script.

    Alternatively, you can run the following command to update your path for the current session (but not to update your group membership):

    source /etc/profile.d/tableau_server.sh

Next step