Docker

Requirements

In order to test and run pgweb in docker containers, make sure you have docker installed. On linux systems, you can use docker natively, on OSX there are few ways of installing it:

• Docker for OSX/Linux/Windows
• Docker Toolbox
• Vagrant

Pull Image

Pgweb has an official docker image: https://hub.docker.com/r/sosedoff/pgweb/

To pull latest version, run:

docker pull sosedoff/pgweb

Or pull from Github Container Registry:

docker pull ghcr.io/sosedoff/pgweb:latest

Build Image

To build a new image, change directory to pgweb source. Then run:

docker build -t pgweb .

Example

First, start PostgreSQL in the container (using official image):

docker run -d -p 5432:5432 --name db -e POSTGRES_PASSWORD=postgres postgres

Then start pgweb container:

docker run -p 8081:8081 --link db:db -e DATABASE_URL=postgres://postgres:postgres@db:5432/postgres sosedoff/pgweb

It should start web server on http://localhost:8081

docker-compose

If you already have a postgres container in your setup, you can add pgweb to docker-compose.yml with the following:

pgweb:
  container_name: pgweb  # optional
  restart: always  # optional
  image: sosedoff/pgweb
  ports: 
    - "8081:8081" 
  links: 
    - postgres:postgres  # my database container is called postgres, not db
  environment:
    - DATABASE_URL=postgres://postgres:postgres@postgres:5432/postgres
  depends_on:
    - postgres  # my database container is called postgres, not db

Note that the depends_on keyword requires docker-compose version 2 and up.

Finally, note that as a default, the postgres container does not have SSL enabled, so just disable that.

DATABASE_URL=postgres://postgres:postgres@postgres:5432/postgres?sslmode=disable