README
¶
Fluxbase
Beta Software: Fluxbase is currently in beta. While we're working hard to stabilize the API and features, you may encounter breaking changes between versions. We welcome feedback and contributions!
A lightweight, single-binary Backend-as-a-Service (BaaS) alternative to Supabase. Fluxbase provides essential backend services including auto-generated REST APIs, authentication, realtime subscriptions, file storage, and edge functions - all in a single Go binary with PostgreSQL as the only dependency.
Features
Core Services
- PostgREST-compatible REST API: Auto-generates CRUD endpoints from your PostgreSQL schema
- Authentication: Email/password, magic links, JWT tokens with session management
- Realtime Subscriptions: WebSocket-based live data updates using PostgreSQL LISTEN/NOTIFY
- Storage: File upload/download with access policies (local filesystem or S3)
- Edge Functions: JavaScript/TypeScript function execution with Deno runtime
- Background Jobs: Long-running tasks with progress tracking, retry logic, and real-time updates
- Schema Introspection: Automatic API generation from database tables
Key Highlights
- Single binary deployment (~80MB)
- PostgreSQL as the only external dependency
- Automatic REST endpoint generation
- Row Level Security (RLS) support
- TypeScript SDK
Quick Start
📖 See GETTING_STARTED.md for complete setup instructions
Try it Now: Docker Compose (2 minutes)
Get Fluxbase running instantly with Docker:
# Clone the repository
git clone https://github.com/fluxbase-eu/fluxbase.git
cd fluxbase/deploy
# Start all services (PostgreSQL + Fluxbase + MinIO)
docker compose up -d
# Check health
curl http://localhost:8080/health
# Access admin dashboard
open http://localhost:8080
That's it! Fluxbase is now running at http://localhost:8080
Default credentials:
- Database:
postgres:postgres
Comparison with Supabase
| Feature | Fluxbase | Supabase |
|---|---|---|
| Deployment | Single binary | Multiple services |
| Dependencies | PostgreSQL only | PostgreSQL + multiple services |
| Size | ~80MB | 2+ GB |
| REST API | ✅ PostgREST-compatible | ✅ PostgREST |
| Authentication | ✅ Built-in | ✅ GoTrue |
| Chatbots | ✅ Built-in | ❌ |
| Realtime | ✅ Built-in | ✅ Realtime |
| Storage | ✅ Built-in | ✅ Storage API |
| Edge Functions | ✅ Deno | ✅ Deno |
| Vector/AI | ✅ | ✅ |
| Admin UI | ✅ Built-in | ✅ |
Documentation
Getting Started
- GETTING_STARTED.md - Complete setup guide with DevContainer and local options
Production
- PRODUCTION_RUNBOOK.md - Production deployment, configuration, monitoring, and operations
- VERSIONING.md - Version management, build automation, and release process
GitHub Setup
- .github/SETUP_GUIDE.md - Complete GitHub repository configuration
- .github/SECRETS.md - GitHub secrets and variables reference
- .github/QUICK_REFERENCE.md - Quick reference card for GitHub setup
Monitoring
- deploy/MONITORING.md - Prometheus, Grafana, and observability setup
Additional Resources
- docs/ - Full Docusaurus documentation (run
make docsto serve locally) - .docs/archive/ - Historical project tracking documents
Support
For issues, questions, and discussions:
- GitHub Issues: github.com/fluxbase-eu/fluxbase/issues
- Documentation: docs.fluxbase.eu
Directories
¶
| Path | Synopsis |
|---|---|
|
annotations
Package annotations provides parsing of @fluxbase: annotations from code comments.
|
Package annotations provides parsing of @fluxbase: annotations from code comments. |
|
bundler
Package bundler provides client-side bundling for edge functions and jobs.
|
Package bundler provides client-side bundling for edge functions and jobs. |
|
client
Package client provides the HTTP client for the Fluxbase API.
|
Package client provides the HTTP client for the Fluxbase API. |
|
cmd
Package cmd provides the Cobra commands for the Fluxbase CLI.
|
Package cmd provides the Cobra commands for the Fluxbase CLI. |
|
config
Package config provides configuration management for the Fluxbase CLI.
|
Package config provides configuration management for the Fluxbase CLI. |
|
output
Package output provides output formatting for the Fluxbase CLI.
|
Package output provides output formatting for the Fluxbase CLI. |
|
util
Package util provides utility functions for the Fluxbase CLI.
|
Package util provides utility functions for the Fluxbase CLI. |
|
cmd
|
|
|
fluxbase
command
|
|
|
internal
|
|
|
branching
Package branching provides database branching for isolated development/testing environments.
|
Package branching provides database branching for isolated development/testing environments. |
|
pubsub
Package pubsub provides pub/sub interfaces for cross-instance communication.
|
Package pubsub provides pub/sub interfaces for cross-instance communication. |
|
query
Package query provides shared query-related types used by both the API and MCP packages.
|
Package query provides shared query-related types used by both the API and MCP packages. |
|
ratelimit
Package ratelimit provides pluggable rate limiting backends for distributed deployments.
|
Package ratelimit provides pluggable rate limiting backends for distributed deployments. |
|
scaling
Package scaling provides utilities for horizontal scaling of Fluxbase instances.
|
Package scaling provides utilities for horizontal scaling of Fluxbase instances. |
|
testutil
Package testutil provides shared test utilities and mocks for unit testing.
|
Package testutil provides shared test utilities and mocks for unit testing. |
|
Package test provides testing utilities and helpers for Fluxbase e2e tests.
|
Package test provides testing utilities and helpers for Fluxbase e2e tests. |
Click to show internal directories.
Click to hide internal directories.