Prostgles UI

SQL Editor, data explorer and internal tool builder for Postgres

Website • Live demo • Documentation

Quick start

Install the desktop version using these instructions

For more information check docs

Features

• SQL Editor with context-aware schema auto-completion and documentation extracts and hints
• AI assistant with MCP support, agentic workflow generation and granular data access permissions
• Data exploration dashboard with customisable grid layout
• Table view with controls to view related data, sort, filter and cross-filter
• Map and Time charts with aggregations and multi-layer support
• Isomorphic TypeScript API with schema types and React hooks support
• File storage (locally or to cloud)
• Global search and command palette
• Media file display (audio/video/image/html/svg)
• Data import (CSV, JSON and GeoJSON)
• Backup/Restore (locally or to cloud)
• TypeScript server-side functions (experimental)

Installation - Docker compose (recommended)

Download the source code:

git clone https://github.com/prostgles/ui.git
cd ui

Docker setup. By default the app will be accessible at localhost:3004. Omit "--build" to use our published images.

docker compose up -d --build

To use a custom port (3099 for example) and/or a custom binding address (0.0.0.0 for example):

PRGL_DOCKER_IP=0.0.0.0 PRGL_DOCKER_PORT=3099 docker compose up --build

To use with docker mcp experimental feature:

docker compose --profile=docker-mcp up --build

Installation - Desktop version

• To install the pre-built installation files follow these instructions

• To build the installation files yourself you can follow these instructions

Installation - use existing PostgreSQL instance

Use this method if you want to use your existing database to store Prostgles metadata

Download the source code:

git clone https://github.com/prostgles/ui.git prostgles
cd prostgles

Build and run our docker image:

docker build -t prostgles .
docker run --network=host -d -p 127.0.0.1:3004:3004 \
  -e POSTGRES_HOST=127.0.0.1 \
  -e POSTGRES_PORT=5432 \
  -e POSTGRES_DB=postgres \
  -e POSTGRES_USER=postgres \
  -e POSTGRES_PASSWORD=postgres \
  -e PROSTGLES_UI_HOST=0.0.0.0 \
  -e IS_DOCKER=yes \
  -e NODE_ENV=production \
  prostgles

Your server will be running on localhost:3004.

Development

1. Install dependencies:

• NodeJS
• Postgres: For full features postgresql-17-postgis-3.4 is recommended

2. Create a database and user update .env. All prostgles state and metadata will be stored in this database

sudo su - postgres
createuser --superuser usr
psql -c "alter user usr with encrypted password 'psw'"
createdb db -O usr

3. Start app in dev mode (will install npm packages)

npm run dev

Testing

Ensure the app is running in development mode and:

cd e2e && npm test-local