Install Promscale using a pre-built Docker container

Docker images for the Promscale Connector and TimescaleDB (with the Promscale extension) are available on Docker Hub.

The TimescaleDB images have a suffix that indicate the version of TimescaleDB and PostgreSQL. For example, the tag 0.3.0-ts2-pg13 includes the Promscale extension 0.3.0, TimescaleDB 2 and PostgreSQL 13. Reference the appropriate images when deploying Promscale and follow the instructions provided by your container platform. If you are using Kubernetes follow these instructions instead.

important

Running Promscale directly using docker run is not recommended for production environments. This can be useful for testing purposes and is just provided as an example.

Install Promscale with Docker

Before you begin, you must have Docker installed on your local system. For packages and instructions, see the [Docker installation documentation][docker-install].

Installing Promscale using Docker run

  1. Use Docker to create a network for Promscale and TimescaleDB:
    docker network create --driver bridge promscale
  2. Install TimescaleDB in a Docker container on a network named promscale. It also port forwards to port 5432 on your local system:
    docker run --name timescaledb -e POSTGRES_PASSWORD=<password> \
    -d -p 5432:5432 \
    --network promscale \
    timescaledev/promscale-extension:latest-ts2-pg13 \
    postgres -csynchronous_commit=off
  3. Run the Promscale Connector Docker container on a network named promscale. It also port forwards to port 9201 on your local system:
    docker run --name promscale -d -p 9201:9201 \
    --network promscale timescale/promscale:latest \
    -db-password=<password> \
    -db-port=5432 \
    -db-name=postgres \
    -db-host=timescaledb \
    -db-ssl-mode=allow

note

Support for OpenTelemetry traces is currently in beta and is disabled by default. If you want to send your OpenTelemetry traces to Promscale, see the instructions in the tracing documentation.

Found an issue on this page?

Report an issue!

Keywords

Related Content