Reference

Tandem configurations

Tandem is configured using the TOML configuration format.

Deploying Tandem

Please see the running Tandem locally guide to get an understanding of how Tandem is deployed.

Configuration file

Tandem is configured using a configuration file or environment variables. The configuration file is mounted into the Docker container at /etc/tandem/tandem.toml.

Configuration options

This file contains the following settings:

OptionRequiredDescriptionDefault/Example Setting
usernametrueThe username that Tandem will use to connect to the databasepostgres
passwordtrueThe password that Tandem will use to connect to the databasepassword
workspace_idtrueThe workspace ID used to authenticate with the CipherStash API12345678-1234-1234-1234-123456789012
client_idtrueThe client ID used to authenticate with the CipherStash API12345678-1234-1234-1234-123456789012
client_keytrueThe client key used to authenticate with the CipherStash API12345678-1234-1234-1234-123456789012
client_access_keyfalseThe access key used to authenticate with the CipherStash API12345678-1234-1234-1234-123456789012
portfalseThe port that Tandem will listen on6432
hostfalseThe host that Tandem will listen on`
passthroughfalseWhether or not Tandem should be in passthrough modetrue
pool_modefalseThe pool mode that Tandem will use. Either Session or TransactionTransaction
pool_sizefalseThe pool size that Tandem will use5
prometheus_metricsfalseWhether or not Tandem should expose Prometheus metricsfalse
prometheus_portfalseThe port that Tandem will expose Prometheus metrics on9930
database.nametrueThe name of the database that Tandem will proxystash
database.portfalseThe port that Tandem will use to connect to the database5432
database.hostfalseThe host that Tandem will use to connect to the database`
database.usernamefalseThe username that Tandem will use to connect to the databasepostgres
database.passwordfalseThe password that Tandem will use to connect to the databasepassword

Example configuration file

1username = "postgres"
2password = "password"
3
4workspace_id = "12345678-1234-1234-1234-123456789012"
5client_id = "12345678-1234-1234-1234-123456789012"
6client_key = "12345678-1234-1234-1234-123456789012"
7
8[database]
9name = "stash"
10

Environment variables

Tandem can also be configured using environment variables. The environment variables are prefixed with CS_TANDEM and are converted to snake case. For example, the username setting in the configuration file is set using the CS_TANDEM_USERNAME environment variable.

Previous
Dataset configuration