Deployment Guide

Get Pangolin running in minutes with Docker, binaries, or production-ready configurations.

⚠️ ALPHA VERSION
Pangolin mascot waving hello

⚠️ Alpha Software Notice

Pangolin is currently in alpha status. This means:

  • Bugs and issues may occur
  • Breaking API changes may happen in future releases
  • Features are actively being developed and refined
  • Not recommended for production use without thorough testing

We encourage you to test, provide feedback, and contribute!

🚀 Quick Start

Choose your deployment method:

Try Demo (5 min) Download Binaries Docker Images Production Setup

📦 Pre-compiled Binaries

Download ready-to-run binaries for your platform:

📍 Binary Locations

Binaries are automatically built for all platforms via GitHub Actions and attached to each release.

🐧 Linux (x86_64)

Ready to use! Includes API server and CLI tools.

Download from Releases

🍎 macOS (Intel & ARM)

Native binaries for both Intel and Apple Silicon Macs.

Download from Releases

🪟 Windows (x86_64)

Windows executables with .exe extensions.

Download from Releases

What's Included

Documentation: Binary Usage Guide

🎯 Demo Setups (Docker Compose)

Get started in minutes with pre-configured Docker Compose environments

Pangolin using laptop

Single Tenant (No Auth)

Perfect for quick evaluation and testing. Includes Jupyter notebook for PyIceberg testing.

  • No authentication required
  • Memory-based storage
  • MinIO for S3-compatible storage
  • Jupyter notebook on port 8888
View Setup

Multi-Tenant (Authenticated)

Full-featured setup with authentication and persistent storage.

  • JWT authentication enabled
  • SQLite for persistent metadata
  • MinIO for S3-compatible storage
  • Jupyter notebook on port 8888
View Setup

Quick Start Command

cd deployment_assets/demo/evaluate_single_tenant
docker compose up -d

# Access:
# - UI: http://localhost:3000
# - API: http://localhost:8080
# - Jupyter: http://localhost:8888
# - MinIO: http://localhost:9001

🐳 Docker Images

Official Docker images published to Docker Hub

API Server

alexmerced/pangolin-api:0.3.0

View on Docker Hub

CLI Tools

alexmerced/pangolin-cli:0.3.0

View on Docker Hub

Management UI

alexmerced/pangolin-ui:0.3.0

View on Docker Hub
Pangolin holding database

🏭 Production Deployments

Production-ready configurations for various cloud providers and databases

Docker Compose (Production)

AWS S3 + PostgreSQL

Production setup for AWS with RDS PostgreSQL.

View Config

AWS S3 + MongoDB

Production setup for AWS with MongoDB Atlas.

View Config

Azure Blob + PostgreSQL

Production setup for Azure with PostgreSQL.

View Config

Azure Blob + MongoDB

Production setup for Azure with MongoDB.

View Config

GCP GCS + PostgreSQL

Production setup for Google Cloud with Cloud SQL.

View Config

GCP GCS + MongoDB

Production setup for Google Cloud with MongoDB.

View Config

Kubernetes (Helm Charts)

Deploy to Kubernetes using our Helm charts:

Pangolin Helm Chart

Production-ready Helm chart with configurable values for different cloud providers.

  • Supports PostgreSQL and MongoDB backends
  • Configurable resource limits and autoscaling
  • Example values for AWS, Azure, and GCP
  • Ingress and TLS support
View Helm Charts

Infrastructure as Code (Terraform)

Provision cloud infrastructure with Terraform:

AWS Module

Provisions S3 bucket and RDS PostgreSQL.

View Module

Azure Module

Provisions Blob Storage and Azure Database for PostgreSQL.

View Module

GCP Module

Provisions GCS bucket and Cloud SQL PostgreSQL.

View Module

📚 Documentation

Getting Started

Installation, configuration, and first steps.

Read Docs

CLI Tools

Admin and user CLI tools, including Docker usage.

Read Docs

PyIceberg Integration

Connect PyIceberg to Pangolin with examples.

Read Docs

Management UI Guide

Visual guide to the administration portal.

Read Docs

🤝 Join the Community

Pangolin is open source and we welcome contributions!

How to Contribute:

Resources: