Portainer Templates logo

Portainer Templates

Timescale DB Timescale DB

edge

Open-source time series database developed by Timescale Inc

Image details

Pulls: 32.6M
Architectures: amd64, arm64
Image size: 1.1 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}
Restart
always
Source

Template by portainer·Source

Installation

  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 the app you wish to deploy, fill in any config options, and hit Deploy

Template Import URL

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

docker run -d --name timescaledb \
  -p 5432:5432 \
  -e 'POSTGRES_PASSWORD=${pgpassword}' \
  -v timescaledb-data:/home/postgres/pgdata \
  --restart=always \
  timescale/timescaledb-ha:pg14-latest

If the stack expects env vars, set them or add them to a .env file first.

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, use the original compose file, straight from the template repo. Deploy with:

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

Save this file as timescale-db-stack.yml, then from a manager node, run docker stack deploy -c timescale-db-stack.yml timescale-db

version: '3.8'
services:
  timescale-db:
    image: timescale/timescaledb-ha:pg14-latest
    ports:
      - '5432:5432'
    volumes:
      - timescaledb-data:/home/postgres/pgdata
    environment:
      POSTGRES_PASSWORD: ${pgpassword}
    deploy:
      restart_policy:
        condition: any

Save each file below into a folder, then run kubectl apply -f .
Written for k3s, but works on any cluster: bind mounts use hostPath, named volumes get a persistent volume claim, and ports are exposed via a LoadBalancer service.

timescale-db-deployment.yaml

apiVersion: apps/v1
kind: Deployment
metadata:
  name: timescale-db
  labels:
    app: timescale-db
spec:
  replicas: 1
  selector:
    matchLabels:
      app: timescale-db
  template:
    metadata:
      labels:
        app: timescale-db
    spec:
      containers:
        - name: timescale-db
          image: timescale/timescaledb-ha:pg14-latest
          env:
            - name: POSTGRES_PASSWORD
              value: ${pgpassword}
          ports:
            - containerPort: 5432
              protocol: TCP
          volumeMounts:
            - name: timescale-db-data-0
              mountPath: /home/postgres/pgdata
      volumes:
        - name: timescale-db-data-0
          hostPath:
            path: timescaledb-data

timescale-db-service.yaml

apiVersion: v1
kind: Service
metadata:
  name: timescale-db
spec:
  type: LoadBalancer
  selector:
    app: timescale-db
  ports:
    - name: 5432-tcp
      port: 5432
      targetPort: 5432
      protocol: TCP

Save this file as ~/.config/containers/systemd/timescale-db.container

[Unit]
Description=Timescale DB

[Container]
Image=timescale/timescaledb-ha:pg14-latest
ContainerName=timescale-db
PublishPort=5432:5432
Environment=POSTGRES_PASSWORD=${pgpassword}
Volume=timescaledb-data:/home/postgres/pgdata

[Service]
Restart=always

[Install]
WantedBy=default.target

Then reload systemd and start the service:

systemctl --user daemon-reload
systemctl --user start timescale-db

For a system-wide service, use /etc/containers/systemd/ and drop --user.

For more installation options, see the Documentation in our GitHub repo

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.

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.

Similar apps