Portainer Templates logo

Portainer Templates

Timescale DB Timescale DB

Stack

edge

Open-source time series database developed by Timescale Inc

Image details

Pulls: 33.3M
Architecture: amd64, arm64
Image size: 1.2 GB
User: timescale
Created: Jan 05, 2021
Updated: 4 days ago
Status: active

Configuration

Type
Compose
Platform
linux
Image
timescale/timescaledb-ha:pg14-latest
Ports
5432:5432
Volumes
/home/postgres/pgdata : timescaledb-data
Env vars
POSTGRES_PASSWORD=${pgpassword}pgpassword=''
Restart
always
Source
Repo

Template by portainer·Source

Standalone Install

Select an install method, to see config/commands for deploying Timescale DB

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Timescale DB, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  timescaledb:
    image: timescale/timescaledb-ha:pg14-latest
    container_name: timescaledb-poc
    restart: always
    ports:
      - 5432:5432
    volumes:
      - timescaledb-data:/home/postgres/pgdata
    environment:
      - POSTGRES_PASSWORD=${pgpassword}

volumes:
  timescaledb-data:

Or deploy it directly from the source:

git clone https://github.com/portainer/templates
cd templates
docker compose -f edge/timescaledb/docker-compose.yml up -d

More install options in our documentation.

https://github.com/timescale/timescaledb-docker-ha/

Serve Timescale DB on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying timescale-db.example.com to http://timescaledb:5432

Add this to your Caddyfile

timescale-db.example.com {
	reverse_proxy http://timescaledb:5432
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:5432 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :5432
  • Stop the other service, or pick a different host port. In 5432:5432 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:5432. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, timescaledb can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 5432

Image won't pull

Test the pull directly on the host: docker pull timescale/timescaledb-ha:pg14-latest

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The always restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Required settings are blank

pgpassword has no default value, and timescaledb may crash or misbehave if left empty.

  • Fill it in on the deploy screen before hitting deploy.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Timescale DB is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.

The app image

An image is the app packed up ready to go, everything Timescale DB needs bundled into one download. This template pulls timescale/timescaledb-ha:pg14-latest, which Docker fetches once (about 1.2 GB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Timescale DB's comes from Docker Hub, published by timescale.

Version tags

The bit after the colon in the image name is the version tag. This one pins pg14-latest, so every redeploy gives you that exact build until you bump it yourself.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 5432:5432 means it's reachable on port 5432 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 5432:5432

Volumes

A volume is where Timescale DB keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /home/postgres/pgdata kept in the timescaledb-data volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Timescale DB takes 2 of them, and one needs a value before it'll start properly:

  • POSTGRES_PASSWORD, pulled from your own environment
  • pgpassword, needs a value. Database root password

Restart policy

The restart policy here is always, so Docker brings Timescale DB back up after a crash and again when the server reboots. Good for anything you want running around the clock. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so Timescale DB sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container timescaledb. That's what you'll spot in the containers list and use in commands like docker logs timescaledb.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Timescale DB up. Add the template list to Portainer once, then deploying Timescale DB is a click rather than a wall of config.