Docker Hub

Quick start

Start a TimescaleDB instance, pulling our Docker image from Docker Hub if it has not been already installed:

tip
The link below is for the latest version of TimescaleDB on PostgreSQL 12. To find other Docker tags you can use, please see the Docker repository
docker run -d --name timescaledb -p 5432:5432 -e POSTGRES_PASSWORD=password timescale/timescaledb:latest-pg12
warning

The -p flag binds the container port to the host port, meaning anything that can access the host port will be able to access your TimescaleDB container. This can be particularly dangerous if you do not set a PostgreSQL password at runtime using the POSTGRES_PASSWORD environment variable as we do in the above command. Without that variable, the Docker container will disable password checks for all database users. If you want to access the container from the host but avoid exposing it to the outside world, you can explicitly have it bind to 127.0.0.1 instead of the public interface by using -p 127.0.0.1:5432:5432.

Otherwise, you'll want to ensure that your host box is adequately locked down through security groups, IP Tables, or whatever you're using for access control. Note also that Docker binds the container by modifying your Linux IP Tables. For systems that use Linux UFW (Uncomplicated Firewall) for security rules, this means that Docker will potentially override any UFW settings that restrict the port you are binding to. If you are relying on UFW rules for network security, consider adding DOCKER_OPTS="--iptables=false" to /etc/default/docker to prevent Docker from overwriting IP Tables. See this writeup on the vulnerability for more details.

_

If you have PostgreSQL client tools (e.g., psql) installed locally, you can use those to access the TimescaleDB docker instance. Otherwise, and probably simpler given default PostgreSQL access-control settings, you can connect using the instance's version of psql within the container (NOTE: for Windows this is necessary):

docker exec -it timescaledb psql -U postgres

More detailed instructions

Our Docker image is derived from the official PostgreSQL image and includes alpine Linux as its OS.

While the above run command will pull the Docker image on demand, you can also -- and for upgrades, need to -- explicitly pull our image from Docker Hub:

tip
The link below is for the latest version of TimescaleDB on PostgreSQL 12. To find other Docker tags you can use, please see the Docker repository
docker pull timescale/timescaledb:latest-pg12

When running a Docker image, if one prefers to store the data in a host directory or wants to run the docker image on top of an existing data directory, then you can also specify a directory where a data volume should be stored/mounted via the -v flag. In particular, the above docker run command should now include some additional argument such as -v /your/data/dir:/var/lib/postgresql/data.

Note that creating a new container (docker run) will also create a new volume unless an existing data volume is reused by reference via the -v parameter (e.g., -v VOLUME_ID:/var/lib/postgresql/data). Existing containers can be stopped (docker stop) and started again (docker start) while retaining their volumes and data. Even if a docker container is deleted (docker rm) its data volume persists on disk until explicitly removed. Use docker volume ls to list the existing docker volumes. (More information on data volumes)

tip
Our standard binary releases are licensed under the Timescale License, which allows to use all our capabilities. If you want to use a version that contains _only_ Apache 2.0 licensed code, you should pull the tag latest-pg12-oss as an example.

Prebuilt with PostGIS

We have also published a Docker image that comes prebuilt with PostGIS. This image is published under the name timescale/timescaledb-postgis rather than timescale/timescaledb. To download and run this image, follow the same instructions as above, but use this image name instead.

Then just add the extension from the psql command line:

CREATE EXTENSION postgis;

For more instructions on using PostGIS, see our tutorial.

Found an issue on this page?

Report an issue!