{"id":13580727,"url":"https://github.com/timescale/timescaledb-docker","last_synced_at":"2025-05-16T06:07:53.827Z","repository":{"id":21528578,"uuid":"93180886","full_name":"timescale/timescaledb-docker","owner":"timescale","description":"Release Docker builds of TimescaleDB","archived":false,"fork":false,"pushed_at":"2025-05-06T09:40:47.000Z","size":174,"stargazers_count":322,"open_issues_count":20,"forks_count":135,"subscribers_count":22,"default_branch":"main","last_synced_at":"2025-05-07T04:58:46.081Z","etag":null,"topics":["docker","docker-image","time-series","timescaledb"],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/timescale.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-06-02T15:47:06.000Z","updated_at":"2025-05-06T09:40:49.000Z","dependencies_parsed_at":"2023-02-13T22:15:54.382Z","dependency_job_id":"5df7ce37-7a32-4c12-b33d-6a5eb7f7bed5","html_url":"https://github.com/timescale/timescaledb-docker","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Ftimescaledb-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Ftimescaledb-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Ftimescaledb-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Ftimescaledb-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timescale","download_url":"https://codeload.github.com/timescale/timescaledb-docker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254478193,"owners_count":22077676,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-image","time-series","timescaledb"],"created_at":"2024-08-01T15:01:54.573Z","updated_at":"2025-05-16T06:07:48.813Z","avatar_url":"https://github.com/timescale.png","language":"Shell","funding_links":[],"categories":["Dockerfile"],"sub_categories":[],"readme":"\u003cimg src=\"http://www.timescale.com/img/timescale-wordmark-blue.svg\" alt=\"Timescale\" width=\"300\"/\u003e\n\n## What is TimescaleDB?\n\nTimescaleDB is an open-source database designed to make SQL scalable\nfor time-series data. For more information, see\nthe [Timescale website](https://www.timescale.com).\n\n## How to use this image\n\nThis image is based on the\nofficial\n[Postgres docker image](https://store.docker.com/images/postgres) so\nthe documentation for that image also applies here, including the\nenvironment variables one can set, extensibility, etc.\n\n### Starting a TimescaleDB instance\n\n```\ndocker run -d --name some-timescaledb -p 5432:5432 -e POSTGRES_PASSWORD=password timescale/timescaledb:latest-pg17\n```\n\nThen connect with an app or the `psql` client:\n\n```\ndocker run -it --net=host -e PGPASSWORD=password --rm timescale/timescaledb:latest-pg17 psql -h localhost -U postgres\n```\n\nYou can also connect your app via port `5432` on the host machine.\n\nIf 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](https://docs.timescale.com/using-timescaledb/telemetry) in the Timescale docker instance. For example, to turn off telemetry, run:\n\n```\ndocker run -d --name some-timescaledb -p 5432:5432 -e TIMESCALEDB_TELEMETRY=off -e POSTGRES_PASSWORD=password timescale/timescaledb:latest-pg17\n```\n\nNote 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](https://docs.timescale.com/using-timescaledb/telemetry) in our docs to disable telemetry once a cluster is running.\n\nIf you are interested in the latest development snapshot of timescaledb there is also a nightly build available under timescaledev/timescaledb:nightly-pg16 (for PG 14, 15 and 16).\n\n### Notes on timescaledb-tune\n\nWe run `timescaledb-tune` automatically on container initialization. By default,\n`timescaledb-tune` uses system calls to retrieve an instance's available CPU\nand memory. In docker images, these system calls reflect the available resources\non the **host**. For cases where a container is allocated all available\nresources on a host, this is fine. But many use cases involve limiting the\namount of resources a container (or the docker daemon) can have on the host.\nTherefore, this image looks in the cgroups metadata to determine the\ndocker-defined limit sizes then passes those values to `timescaledb-tune`.\n\nTo specify your own limits, use the `TS_TUNE_MEMORY` and `TS_TUNE_NUM_CPUS`\nenvironment variables at runtime:\n\n```\ndocker run -d --name timescaledb -p 5432:5432 -e POSTGRES_PASSWORD=password -e TS_TUNE_MEMORY=4GB -e TS_TUNE_NUM_CPUS=4 timescale/timescaledb:latest-pg17\n```\n\nTo specify a maximum number of [background workers](https://docs.timescale.com/timescaledb/latest/how-to-guides/configuration/about-configuration/#workers), use the `TS_TUNE_MAX_BG_WORKERS` environment variable:\n\n```\ndocker run -d --name timescaledb -p 5432:5432 -e POSTGRES_PASSWORD=password -e TS_TUNE_MAX_BG_WORKERS=16 timescale/timescaledb:latest-pg17\n```\n\nTo specify a [maximum number of connections](https://www.postgresql.org/docs/current/runtime-config-connection.html), use the `TS_TUNE_MAX_CONNS` environment variable:\n\n```\ndocker run -d --name timescaledb -p 5432:5432 -e POSTGRES_PASSWORD=password -e TS_TUNE_MAX_CONNS=200 timescale/timescaledb:latest-pg17\n```\n\nTo not run `timescaledb-tune` at all, use the `NO_TS_TUNE` environment variable:\n\n```\ndocker run -d --name timescaledb -p 5432:5432 -e POSTGRES_PASSWORD=password -e NO_TS_TUNE=true timescale/timescaledb:latest-pg17\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimescale%2Ftimescaledb-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimescale%2Ftimescaledb-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimescale%2Ftimescaledb-docker/lists"}