/timescaledb-docker

Release Docker builds of TimescaleDB

Primary LanguageDockerfileApache License 2.0Apache-2.0

Timescale

What is TimescaleDB?

TimescaleDB is an open-source database designed to make SQL scalable for time-series data. For more information, see the Timescale website.

How to use this image

This image is based on the official Postgres docker image so the documentation for that image also applies here, including the environment variables one can set, extensibility, etc.

Starting a TimescaleDB instance

$ docker run -d --name some-timescaledb -p 5432:5432 timescale/timescaledb

Then connect with an app or the psql client:

$ docker run -it --net=host --rm timescale/timescaledb psql -h localhost -U postgres

You can also connect your app via port 5432 on the host machine.

If you are running your docker image for the first time, you can also set an environmental variable, TIMESCALEDB_TELEMETRY, to set the level of telemetry in the Timescale docker instance. For example, to turn off telemetry, run:

$ docker run -d --name some-timescaledb -p 5432:5432 --env TIMESCALEDB_TELEMETRY=off timescale/timescaledb

Note that if the cluster has previously been initialized, you should not use this environment variable to set the level of telemetry. Instead, follow the instructions in our docs to disable telemetry once a cluster is running.