## Set up on-premises ThoughtSpot access

URL: https://docs.atlan.com/apps/connectors/business-intelligence/thoughtspot/how-tos/set-up-on-premises-thoughtspot-access

> In some cases you will not be able to expose your ThoughtSpot instance for Atlan to crawl and ingest metadata. For example, this may happen when security requirements restrict access to sensitive, mission-critical data.

:::danger **Deprecated**
This job execution mode was deprecated on June 30, 2026 and is no longer supported or maintained, including bug fixes. Existing workflows may break/be disabled without warning. For all implementations, switch to [Self-deployed runtime](https://docs.atlan.com/llms/platform/self-deployed-runtime/llms.txt).
:::

:::warning Who can do this?
 You will need access to a machine that can run Docker on-premises. You will also need your ThoughtSpot instance details, including credentials.

:::

In some cases you will not be able to expose your ThoughtSpot instance for Atlan to crawl and ingest metadata. For example, this may happen when security requirements restrict access to sensitive, mission-critical data.

In such cases you may want to decouple the extraction of metadata from its ingestion in Atlan. This approach gives you full control over your resources and metadata transfer to Atlan.

## Prerequisites

To extract metadata from your on-premises ThoughtSpot instance, you will need to use Atlan's thoughtspot-extractor tool.

:::info **Did you know?** 
 Atlan uses exactly the same thoughtspot-extractor behind the scenes when it connects to ThoughtSpot in the cloud.

:::

### Install Docker Compose

[Docker Compose](https://docs.docker.com/compose/) is a tool for defining and running applications composed of many [Docker](https://docs.docker.com/get-started/overview/) containers. (Any guesses where the name came from? 😉)

To install Docker Compose:

1. [Install Docker](https://docs.docker.com/get-docker/)
2. [Install Docker Compose](https://docs.docker.com/compose/install/)

:::info **Did you know?** 
 Instructions provided in this documentation should be enough even if you are completely new to Docker and Docker Compose. However, you can also walk through the [Get started with Docker Compose](https://docs.docker.com/compose/gettingstarted/) tutorial if you want to learn Docker Compose basics first.

:::

### Get the thoughtspot-extractor tool

To get the thoughtspot-extractor tool:

1. [Raise a support ticket](https://docs.atlan.com/support/submit-request) to get the link to the latest version.
2. Download the image using the link provided by support.
3. Load the image to the server you'll use to crawl ThoughtSpot:

 ```
 sudo docker load -i /path/to/thoughtspot-extractor-master.tar
 ```

## Get the compose file

Atlan provides you with a [Docker compose file](https://docs.docker.com/compose/compose-file/) for the thoughtspot-extractor tool.

To get the compose file:

1. Download the [latest compose file](https://atlan-public.s3.eu-west-1.amazonaws.com/atlan/looker-extractor/docker-compose.yaml).
2. Save the file to an empty directory on the server you'll use to access your on-premises ThoughtSpot instance.
3. The file is `docker-compose.yaml`.

## Define ThoughtSpot connections

The structure of the compose file includes three main sections:

- `x-templates` contains configuration fragments. You should ignore this section - do not make any changes to it.
- `services` is where you will define your ThoughtSpot connections.
- `volumes` contains mount information. You should ignore this section as well - do not make any changes to it.

### Define services

For each on-premises ThoughtSpot instance, define an entry under `services` in the compose file.

Each entry will have the following structure:

```
services:
 connection-name:
 <<: *extract
 environment:
 <<: *thoughtspot-defaults
 EXCLUDE_TAGS_REGEX: "Test1.*|Test2.*"
 WITHOUT_TAGS: "true"
 volumes:
 - ./output/connection-name/filter:/output/filter
```

- Replace `connection-name` with the name of your connection.
- `<<: *extract` tells the thoughtspot-extractor tool to run.
- `environment` contains all parameters for the tool.
 - `EXCLUDE_TAGS_REGEX` - specify a regular expression to exclude ThoughtSpot assets based on ThoughtSpot tags.
 - `WITHOUT_TAGS` - specify a Boolean configuration to determine whether to crawl ThoughtSpot assets without any ThoughtSpot tags.
- `volumes` specifies where to store results. In this example, the extractor will store results in the `./output/connection-name/filter` folder on the local file system.

You can add as many ThoughtSpot connections as you want.

:::info **Did you know?** 
 [Docker's documentation](https://docs.docker.com/compose/compose-file/#services-top-level-element) describes the `services` format in more detail.

:::

## Provide credentials

To define the credentials for your ThoughtSpot connections, you will need to provide a ThoughtSpot configuration file.

The ThoughtSpot configuration is a `.ini` file with the following format:

```
[ThoughtSpotConfig]
host=atlan.thoughtspot.cloud
port=443
auth_type=basic_auth; This will use BasicAuth;
auth_type=trusted_auth; This will use TruestedAuth;
auth_type=oauth_access_token; This will use OAuth;

[BasicAuth]
username={{username}}
password={{password}}

[TrustedAuth]
username={{username}}
secret_key={{secret_key}}

[OAuth]
token={{oauth_access_token}}

[ExtractionConfig]
offset=1
limit=10
```

## Secure credentials

### Using local files

:::warning

If you decide to keep ThoughtSpot credentials in plaintext files, we recommend you restrict access to the directory and the compose file. For extra security, we recommend you use [Docker secrets](https://docs.docker.com/engine/swarm/secrets/) to store the sensitive passwords.

:::

To specify the local files in your compose file:

```
secrets:
 thoughtspot_config:
 file: ./thoughtspot.ini
```

:::warning

This `secrets` section is at the same top-level as the `services` section described earlier. It is not a sub-section of the `services` section.

:::

### Using Docker secrets

To create and use Docker secrets:

1. Store the ThoughtSpot configuration file:

 ```
 sudo docker secret create thoughtspot_config path/to/thoughtspot.ini
 ```

2. At the top of your compose file, add a [secrets](https://docs.docker.com/compose/compose-file/compose-file-v3/#secrets-configuration-reference) element to access your secret:

 ```
 secrets:
 thoughtspot_config:
 external: true
 name: thoughtspot_config
 ```

 - The `name` should be the same one you used in the `docker secret create` command above.
 - Once stored as a Docker secret, you can remove the local ThoughtSpot configuration file.
3. Within the `service` section of the compose file, add a new secrets element and specify the name of the secret within your service to use it.

## Example

Let's explain in detail with an example:

```
secrets:
 thoughtspot_config:
 external: true
 name: thoughtspot_config

x-templates:
 # ...

services:
 thoughtspot-example:
 <<: *extract
 environment:
 <<: *thoughtspot-defaults
 EXCLUDE_TAGS_REGEX: "Test1.*|Test2.*"
 WITHOUT_TAGS: "true"
 volumes:
 - ./output/connection-name/filter:/output/filter
```

1. In this example, we've defined the secrets at the top of the file (you could also define them at the bottom). The `thoughtspot_config` refers to an external Docker secret created using the `docker secret create` command.
2. The name of this service is `thoughtspot-example`. You can use any meaningful name you want.
3. The `<<: *thoughtspot-defaults` sets the connection type to ThoughtSpot.
4. The `./output/thoughtspot_example/filter:/output/filter` line tells the extractor where to store results. In this example, the extractor will store results in the `./output/thoughtspot_example/filter` directory on the local file system. We recommend you output the extracted metadata for different connections in separate directories.
5. The `secrets` section within `services` tells the extractor which secrets to use for this service. Each of these refers to the name of a secret listed at the beginning of the compose file.

---