# Realtime Platform

> Production-grade realtime infrastructure — Sync, Socket, and Database CDC streaming unified under one platform.

## Documentation

- [Architecture](https://docs.realtime.dev/docs/architecture): Understand the monorepo structure, event flow, and core design principles.
- [Configuration](https://docs.realtime.dev/docs/configuration): All environment variables, configuration options, and setup for each service.
- [Core Concepts](https://docs.realtime.dev/docs/core-concepts): Understand the relationship between Topics, Schemas, Mappings, and how events flow through the platform to subscribers and webhooks.
- [Data Flow & Architecture](https://docs.realtime.dev/docs/data-flow): Complete data flow diagram showing how events move through every path in the platform, including queues, workers, and independently scalable components.
- [Realtime Platform](https://docs.realtime.dev/docs): Production-grade realtime infrastructure — Sync, Socket, and Database CDC streaming unified under one platform.
- [Installation](https://docs.realtime.dev/docs/installation): Complete installation guide with prerequisites, environment setup, and verification.
- [Packages](https://docs.realtime.dev/docs/packages): Reference guide for all 12 shared packages in the Realtime Platform monorepo.
- [Quick Start](https://docs.realtime.dev/docs/quickstart): Get the Realtime Platform running locally in 5 minutes.
- [Security](https://docs.realtime.dev/docs/security): JWT authentication, signing key rotation, RBAC, MFA, webhook signing, and multi-tenant isolation.
- [Admin UI Authentication](https://docs.realtime.dev/docs/admin-ui/authentication): Login flow, MFA, session management, RBAC, and user invite system.
- [Admin UI Overview](https://docs.realtime.dev/docs/admin-ui/overview): React management dashboard for the Realtime Platform with 17+ pages for configuration and monitoring.
- [Admin UI Pages](https://docs.realtime.dev/docs/admin-ui/pages): Detailed guide to every page in the Realtime Platform Admin UI.
- [Admin API](https://docs.realtime.dev/docs/api/admin): Signing key management, user administration, roles, and invites.
- [Auth API](https://docs.realtime.dev/docs/api/auth-endpoints): Token issuance, verification, user authentication, session management, and MFA.
- [Database API](https://docs.realtime.dev/docs/api/database): Manage CDC mappings, versions, promotions, and database subscriptions.
- [Debugger API](https://docs.realtime.dev/docs/api/debugger): Query event traces, debug routing and filters, and replay historical events.
- [API Overview](https://docs.realtime.dev/docs/api/overview): Complete REST API and WebSocket event reference for the Realtime Platform.
- [Schemas API](https://docs.realtime.dev/docs/api/schemas): Register versioned JSON Schemas, validate payloads, and check compatibility.
- [Services API](https://docs.realtime.dev/docs/api/services): CRUD operations for managing sync document service namespaces.
- [Socket API](https://docs.realtime.dev/docs/api/socket): Channel management, broadcasting, and connection status endpoints.
- [Sync API](https://docs.realtime.dev/docs/api/sync): Document CRUD operations with revision tracking and optimistic concurrency.
- [Topics API](https://docs.realtime.dev/docs/api/topics): Create, read, update, and delete domain topics in the Topic Registry.
- [Webhooks API](https://docs.realtime.dev/docs/api/webhooks): Manage webhook endpoints, delivery logs, and HMAC-signed event dispatch.
- [Deployment](https://docs.realtime.dev/docs/operations/deployment): Deploy the Realtime Platform to production with Docker, process managers, or cloud services.
- [Database Migrations](https://docs.realtime.dev/docs/operations/migrations): Knex migration system, auto-migration on startup, manual commands, and writing new migrations.
- [Monitoring](https://docs.realtime.dev/docs/operations/monitoring): Prometheus metrics, health checks, operational dashboards, and alerting.
- [Testing](https://docs.realtime.dev/docs/operations/testing): Test suite overview, running tests, writing new tests, and coverage across all packages.
- [Workers](https://docs.realtime.dev/docs/operations/workers): Background processors for CDC reading, outbox processing, webhook delivery, analytics, and alerts.
- [SDK Authentication](https://docs.realtime.dev/docs/sdk/authentication): Authenticate SDK connections with JWT tokens, handle token refresh, and manage session lifecycle.
- [SDK Overview](https://docs.realtime.dev/docs/sdk/overview): Client SDK for browser and Node.js — subscribe to topics, manage documents, and send messages.
- [Socket Client](https://docs.realtime.dev/docs/sdk/socket-client): Channel-based messaging, broadcasting, and direct messages via WebSocket.
- [Subscribing to Topics](https://docs.realtime.dev/docs/sdk/subscribing): Subscribe to domain topics with optional filters to receive real-time events.
- [Sync Client](https://docs.realtime.dev/docs/sdk/sync-client): Create, read, update, and delete real-time documents with revision tracking.
- [Webhook Receiver](https://docs.realtime.dev/docs/sdk/webhook-receiver): Verify and parse incoming webhook deliveries from the Realtime Platform using the SDK's built-in receiver.
- [Database CDC Service](https://docs.realtime.dev/docs/services/database): Stream PostgreSQL row-level changes to real-time subscribers using Change Data Capture.
- [Socket Service](https://docs.realtime.dev/docs/services/socket): Raw WebSocket messaging with channels, broadcasting, direct messaging, and presence.
- [Sync Service](https://docs.realtime.dev/docs/services/sync): Realtime document synchronization with revision tracking, partial updates, and presence.

## Links

- [GitHub](https://bitbucket.org/smarterservices/realtime)
- [Support](mailto:engineering@smarterservices.com)