Quick Start

Get Bingsan running in under 5 minutes using Docker Compose.

Prerequisites

Docker Engine 20.10+
Docker Compose v2.0+

Step 1: Clone the Repository

git clone https://github.com/teamPaprika/bingsan.git
cd bingsan

Step 2: Configure

Copy the example configuration file:

cp config.example.yaml config.yaml

The default configuration works out of the box for local development. For production, see the Configuration Guide.

Step 3: Start with Docker Compose

docker compose -f deployments/docker/docker-compose.yml up -d

This starts:

Bingsan - REST catalog server on port 8181
PostgreSQL - Metadata database on port 5432
MinIO - S3-compatible object storage on ports 9000 (API) and 9001 (Console)

Step 4: Verify Installation

Check the health endpoint:

curl http://localhost:8181/health

Expected response:

{"status": "healthy"}

Check readiness (includes database connectivity):

curl http://localhost:8181/ready

Expected response:

{"status": "ready", "checks": {"database": "healthy"}}

Step 5: Create Your First Namespace

curl -X POST http://localhost:8181/v1/namespaces \
  -H "Content-Type: application/json" \
  -d '{
    "namespace": ["analytics"],
    "properties": {
      "owner": "data-team"
    }
  }'

Step 6: List Namespaces

curl http://localhost:8181/v1/namespaces

Response:

{
  "namespaces": [
    ["analytics"]
  ]
}

Next Steps

Stopping the Services

docker compose -f deployments/docker/docker-compose.yml down

To also remove the data volumes:

docker compose -f deployments/docker/docker-compose.yml down -v

Quick Start

On this page