QueryProxy
Documentation menu

Quick start

Run QueryProxy with Docker in about two minutes — one compose file starts the portal, the queue worker and the scheduler.

Updated:

The fastest way to run QueryProxy is Docker Compose. One file starts everything the product needs.

git clone https://github.com/QueryProxy/QueryProxy.git
cd QueryProxy
docker compose up

Then open http://localhost:8000.

Three containers start:

Container Role
app The web portal
worker The queue worker — approved queries execute here
scheduler Housekeeping (result retention pruning, queue maintenance)

The first boot generates an application key, runs the migrations and creates a SQLite database on a named volume. No external services are required.

Demo accounts

The default compose file sets QUERYPROXY_SEED_DEMO=true, which seeds a demo team with one account per role on first boot. All passwords are password:

Role Email
Admin admin@example.com
DBA dba@example.com
Developer developer@example.com
Auditor auditor@example.com

Log in as each role to explore the product: the DBA creates connections and approves requests, the developer submits queries, the auditor reads the trail.

Before real use: set QUERYPROXY_SEED_DEMO=false, remove the demo accounts, and create your own admin user.

First real request, end to end

  1. As Admin, create a team and add your users with roles (Admin → Teams).
  2. As DBA, add a database connection (Connections → New Connection) and use Test Connection to verify it. Grant it to your developers.
  3. As Developer, open Query Studio, pick the connection, write a query and submit it.
  4. As DBA, approve it from Approvals — the worker executes it and the requester gets the masked result.

Next steps

Arrow keys to move, Enter to open.