Portainer Templates logo

Portainer Templates

pgAdmin pgAdmin

Container

OtherTools

PGAdmin is a web-based GUI tool used to interact with the Postgres database sessions, both locally and remote servers as well. You can use PGAdmin to perform any sort of database administration required for a Postgres database.

Image details

Pulls: 441.3M
Architecture: amd64, arm64
Image size: 172 MB
Latest: 9.17
User: dpage
Created: Oct 12, 2017
Updated: 2 hours ago
Status: active

Source details

Repo: dpage/pgadmin4
Stars: 6
Forks: 1
Language: Python
Updated: 1 day ago
Website: www.pgadmin.org/

Configuration

Type
Container
Platform
linux
Image
dpage/pgadmin4:latest
Ports
5050:80/tcp
Volumes
/var/lib/pgadmin : /portainer/Files/AppData/Config/pgadmin
Env vars
PUID=1000PGID=1000PGADMIN_DEFAULT_EMAIL=PGADMIN_DEFAULT_PASSWORD=TZ=America/New_York
Restart
unless-stopped

Template by novaspirit

Notes

Template created by Pi-Hosted Series
Check our Github page: https://github.com/pi-hosted/pi-hosted

Official Webpage: https://www.pgadmin.org/
Official Docker Documentation: https://www.pgadmin.org/docs/pgadmin4/latest/container_deployment.html

Pre-installation script must be RAN before you install: wget -qO- https://raw.githubusercontent.com/pi-hosted/pi-hosted/master/tools/install_pgadmin.sh | bash



Standalone Install

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

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 pgAdmin, fill in any config options, and hit Deploy

Template Import URL

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

More install options in our documentation, or see dpage/pgadmin4 for app-specific guidance.

This is the official Docker distribution of pgAdmin 4.

Running

See the website for documentation on deploying different versions of the container:
  • Latest release: https://www.pgadmin.org/docs/pgadmin4/latest/containerdeployment.html
  • Nightly snapshot build: https://www.pgadmin.org/docs/pgadmin4/development/containerdeployment.html

Support

Please report any issues through the pgAdmin support channels. See https://www.pgadmin.org/support/list/

Serve pgAdmin 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 pgadmin.example.com to http://pgadmin:80

Add this to your Caddyfile

pgadmin.example.com {
	reverse_proxy http://pgadmin:80
}

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 pgadmin
  • 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:5050 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :5050
  • Stop the other service, or pick a different host port. In 5050:80 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:5050. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, pgadmin can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 5050

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/pgadmin
  • Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull dpage/pgadmin4:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "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 unless-stopped 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 pgadmin --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Required settings are blank

PGADMIN_DEFAULT_EMAIL, PGADMIN_DEFAULT_PASSWORD have no default value, and pgadmin may crash or misbehave if left empty.

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

Raise an issue

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

A single container

pgAdmin runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything pgAdmin needs bundled into one download. This template pulls dpage/pgadmin4:latest, which Docker fetches once (about 172 MB) and then starts your own copy from.

Where the image comes from

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

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 9.17. Pin a specific tag if you would rather stay on one version.

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 5050:80 means it's reachable on port 5050 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:5050 in a browser. It opens:

  • 5050:80, likely the web interface

Volumes

A volume is where pgAdmin 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:

  • /var/lib/pgadmin from /portainer/Files/AppData/Config/pgadmin on the host

Environment variables

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

  • PUID, defaults to 1000
  • PGID, defaults to 1000
  • PGADMIN_DEFAULT_EMAIL, needs a value
  • PGADMIN_DEFAULT_PASSWORD, needs a value
  • TZ, defaults to America/New_York

Restart policy

The restart policy here is unless-stopped, so Docker restarts pgAdmin after a crash or reboot, but leaves it off when you stop it on purpose. 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).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so pgAdmin 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 pgadmin. That's what you'll spot in the containers list and use in commands like docker logs pgadmin.

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 pgAdmin up. Add the template list to Portainer once, then deploying pgAdmin is a click rather than a wall of config.