How to manually configure SMTP on Tableau Server Linux environment

Published: 25 Apr 2023
Last Modified Date: 28 Apr 2023

Question

How to configure SMTP on Tableau Server manually on Linux

Environment

Tableau Server 2023.1.0
Amazon Linux 2
EXASolution

Answer

To configure SMTP in Tableau Server manually please follow the below steps:

1. Log in to the Tableau Server as root user via SSH.
Go to the Tableau Server bin directory by running the following command:
# cd /opt/tableau/tableau_server/packages/bin.

2. Locate the tsm configuration files by running the following command:
# tsm configuration list

3. To set up SMTP, run the following command:
# tsm configuration set -k "smtp.server" -v "smtp.example.com"

4. Set the SMTP server port by running the following command:
# tsm configuration set -k "smtp.port" -v "587"

5. Set the authentication method by running the following command:
# tsm configuration set -k "smtp.auth.type" -v "USERNAME_PASSWORD"

6. Set the SMTP username and password by running the following command:
# tsm configuration set -k "smtp.auth.username" -v "your_username" && tsm configuration set -k "smtp.auth.password" -v "your_password"

7. Set the from address by running the following command:
# tsm configuration set -k "smtp.from" -v "your_email@example.com"

8. Set the SSL/TLS protocol by running the following command:
# tsm configuration set -k "smtp.ssl.enabled" -v "true"
# tsm configuration set -k svcmonitor.notification.smtp.ssl_enabled -v true

9. Save the configuration changes by running the following command:
# tsm pending-changes apply

10. Restart the Tableau Server by running the following command:
# tsm restart

Note: Make sure to replace the values in step 4, 5, 6, 7, and 8 with your SMTP server details and authentication credentials.
--------------
After the above changes, you can test the setup by following command to view and verify the connection configuration
# tsm email test-smtp-connection