Getting started /

Running with docker run

Run Gresbase with plain docker run instead of Compose, then update it or stop it.

Start the container#

This command does the same as the quick start Compose file:

docker run -d --name gresbase \
  -e DATABASE_URL=postgres://USER:PASSWORD@HOST:5432/DBNAME \
  -e GRESBASE_READ_ONLY=false \
  -p 127.0.0.1:8082:8080 \
  -v gresbase-data:/data \
  --restart unless-stopped \
  ghcr.io/amtzespinosa/gresbase:latest

Then open http://localhost:8082.

Reach a database in another container#

If PostgreSQL runs in a container, put both on the same Docker network and use the container name as the host:

docker network create gresbase-net
docker network connect gresbase-net my-postgres
docker run -d --name gresbase --network gresbase-net \
  -e DATABASE_URL=postgres://USER:PASSWORD@my-postgres:5432/DBNAME?sslmode=disable \
  -p 127.0.0.1:8082:8080 \
  -v gresbase-data:/data \
  --restart unless-stopped \
  ghcr.io/amtzespinosa/gresbase:latest

Replace my-postgres with the name of your database container.

Check it#

docker logs -f gresbase
docker ps --filter name=gresbase

The log shows starting gresbase once it's connected. docker ps shows healthy when the built-in health check passes.

To see the version:

docker exec gresbase /gresbase version

Update#

Your settings live in the gresbase-data volume, so you can replace the container freely.

1. Pull the new image#

   Copy

   docker pull ghcr.io/amtzespinosa/gresbase:latest

2. Remove the old container#

   Copy

   docker stop gresbase
   docker rm gresbase

3. Start it again#

   Run the same docker run command as before, with the same volume.

Read Upgrading before jumping between versions.

Stop and remove#

docker stop gresbase     # stop it; docker start gresbase brings it back
docker rm gresbase       # remove the container, keep the volume
docker volume rm gresbase-data   # also delete settings and saved queries