temporalio/auto-setup
Verified Publisher
Workflow as Code (TM) to build and operate resilient applications
Image
6
10M+
temporalio/auto-setup repository overview
⚠️ DEPRECATED This image is no longer maintained and will not receive updates.
Docker Compose examples using the supported
temporalio/serverandtemporalio/admin-toolsimages are available at: https://github.com/temporalio/samples-server/tree/main/compose
This is the Temporal auto-setup image, which deploys Temporal with a preconfigured database -- one of Cassandra (default), MySQL, or PostgreSQL. To deploy Temporal with an external database, refer to the server image.
Temporal also optionally also supports Elasticsearch for visibility.
For more sample docker-compose files, refer to the docker-compose Github repository.
You can also Sign up for Temporal Cloud, ask questions in our community Slack, schedule time with an expert, or dive into our documentation.
To configure this deployment, refer to this list of environment variables:
General Environment Variables
| Name | Description | Default Value |
|---|---|---|
DB | Specifies the type of database you're connecting to. Allowed values are cassandra, mysql8, and postgres12. | cassandra |
SKIP_SCHEMA_SETUP | Specifies whether database schema creation should be skipped. Set this to true if you're using an existing schema. | false |
SKIP_DB_CREATE | Specifies whether database creation should be skipped. Set this to true if you're using an existing database. | false |
Cassandra Environment Variables
| Name | Description | Default Value |
|---|---|---|
KEYSPACE | Specifies the name of your Cassandra keyspace. | temporal |
CASSANDRA_SEEDS | Specifies your Cassndra hostname. | unset |
CASSANDRA_PORT | Specifies the port to connect to Cassandra on. | 9042 |
CASSANDRA_USER | Specifies your Cassandra username. | unset |
CASSANDRA_PASSWORD | Specifies your Cassandra password. | unset |
CASSANDRA_TLS_ENABLED | Specifies whether you are using TLS to connect to Cassandra. | false |
CASSANDRA_CERT | Specifies the path to your Cassandra security certificate, if you are using TLS. | unset |
CASSANDRA_CERT_KEY | Specifies the path to your Cassandra security certificate key, if you are using TLS. | unset |
CASSANDRA_CA | Specifies the host of your Cassandra security certificate authority, if needed. | unset |
CASSANDRA_REPLICATION_FACTOR | Specifies how many replicas your Cassandra database is using. | 1 |
MySQL/PostgreSQL Environment Variables
| Name | Description | Default Value |
|---|---|---|
DBNAME | Specifies the name of your MySQL / Postgres database. | temporal |
VISIBILITY_DBNAME | Specifies the name of your MySQL / Postgres visibility database, separate from the main Temporal database. | temporal_visibility |
DB_PORT | Specifies the port to connect to MySQL/PostgreSQL on. | 3306 |
MYSQL_SEEDS | Specifies your MySQL hostname. | unset |
MYSQL_USER | Specifies your MySQL username. | unset |
MYSQL_PWD | Specifies your MySQL password. | unset |
MYSQL_TX_ISOLATION_COMPAT | This variable enables compatibility with pre-5.7.20 MySQL installations, if needed. | false |
POSTGRES_SEEDS | Specifies your Postgres hostname. | unset |
POSTGRES_USER | Specifies your PostgreSQL username. | unset |
POSTGRES_PWD | Specifies your PostgreSQL password. | unset |
POSTGRES_TLS_ENABLED | Specifies whether you are using TLS to connect to Postgres. | false |
POSTGRES_TLS_DISABLE_HOST_VERIFICATION | Specifies whether Postgres should skip host key verification (e.g. if you can't easily verify server certs when using Amazon RDS). | false |
POSTGRES_TLS_CERT_FILE | Specifies the path to your Postgres security certificate, if you are using TLS. | unset |
POSTGRES_TLS_KEY_FILE | Specifies the path to your Postgres security certificate key, if you are using TLS. | unset |
POSTGRES_TLS_CA_FILE | Specifies the path to your Postgres security certificate authority, if needed. | unset |
POSTGRES_TLS_SERVER_NAME | Specifies the host of your Postgres TLS server, if needed. | unset |
Elasticsearch Environment Variables
| Name | Description | Default Value |
|---|---|---|
ENABLE_ES | Specifies whether you are using Elasticsearch. | false |
ES_SCHEME | Specifies how you are connecting to Elasticsearch. Allowed values are http and https. | http |
ES_SEEDS | Specifies a comma-separated list of Elasticsearch nodes. | unset |
ES_PORT | Specifies the port to connect to Elasticsearch on. | 9200 |
ES_USER | Specifies your Elasticsearch username. | unset |
ES_PWD | Specifies your Elasticsearch password. | unset |
ES_VERSION | Specifies your Elasticsearch version. | v7 |
ES_VIS_INDEX | Specifies the name of your Elasticsearch index. | temporal_visibility_v1_dev |
ES_SEC_VIS_INDEX | Specifies the name of your secondary visibility Elasticsearch index. | unset |
ES_SCHEMA_SETUP_TIMEOUT_IN_SECONDS | Specifies the Elasticsearch schema setup timeout. The default value of 0 means that schema setup will not time out. | 0 |
Server Setup Environment Variables
| Name | Description | Default Value |
|---|---|---|
TEMPORAL_ADDRESS | Specifies the address of the Temporal server. | unset |
SKIP_DEFAULT_NAMESPACE_CREATION | Specifies whether Temporal should skip creating a default namespace on install. | false |
DEFAULT_NAMESPACE | Specifies the name of the default namespace that your Temporal Service will use. | default |
DEFAULT_NAMESPACE_RETENTION | Specifies how long the default namespace will retain data associated with closed Workflow Executions. | 24h |
SKIP_ADD_CUSTOM_SEARCH_ATTRIBUTES | Specifies whether Temporal should skip adding custom search attributes on install. | false |
Tag summary
Content type
Image
Digest
sha256:f14912b69…
Size
280.4 MB
Last updated
about 1 month ago
docker pull temporalio/auto-setup:1.29.7This week's pulls
Pulls:
1,148,830
Last week