Documentation

    Concepts, value, and typical clone scenarios — less code.

    Welcome to Ring
    Quick Reference
    Getting Started
    Prerequisites
    Installation
    First Success Validation
    Next Steps
    Features
    Multi-Vendor Store
    Inventory & Stock
    Vendor Management
    Commissions & Settlements
    SubscriptionConductor
    PaymentConductor
    Ring Oracle
    Payments Overview
    Public Pools & DAO Jars
    WayForPay Payment Integration
    Wallet & Credit System
    WalletConductor
    Affiliate & Referral Enablement
    Referral Codes (Refcodes)
    NFT Exhibition Marketplace
    Solana NFT Gates
    Token Staking System
    Owner Project Lab
    Entities
    Opportunities
    Real-Time Messaging
    Ring Tasks
    WebRTC Calls & STUNner TURN
    Peer Games
    News Module
    Member Blogs
    Public Profile Pages
    Profile Account Widgets
    Ring File Cabinet
    Username Reservation System
    Scientific Editor
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Email AI-CRM
    Ring Mailer & RingdomX Mail
    Tunnel Protocol
    VideoConductor
    MediaConductor
    Generative Gallery
    Authentication
    Security & Compliance
    Admin console
    Admin Wiki
    Manage via Telegram
    Locale System
    Mobile Experience
    Performance Optimization Patterns
    Examples
    Quick Start
    Basic Setup
    White Label
    Custom Branding
    Web3 Integration
    Real World
    Advanced Features
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Vertical Presets (SSOT)
    Ringization playbook
    Branding
    Themes
    Features
    Localization
    Token Economics Setup
    Payment Gateway Integration
    Reference Ring deployments
    Project configuration
    Public environment variables
    Order Lab secrets
    WalletConnect Project ID (Reown Cloud)
    Supported services
    NODUS wiki (project knowledge)
    Configuration playbook
    Web3
    Token launch jurisdictions
    Wallet
    Wallet Security Tips
    Integrations
    Ethereum wallets (Wagmi v3)
    RingFileBase (object storage API)
    Ring CDN (RingFileBase edge)
    Deployment
    Self-hosted deployment
    Vercel Deployment
    Docker
    Environment Configuration
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Architecture
    Data Model
    Security
    Real Time
    Discovery Mutation Sync
    PaymentConductor architecture
    WalletConductor architecture
    Backend Services
    Firebase Integration
    Development
    Ring MCP Server

    Quick entry (CTOs · auditors · agents)

    Welcome — mission & audiences
    Quick Reference
    Getting started
    Architecture & Auth.js
    Backend modes & databases (DB_BACKEND_MODE)
    Self-hosted
    Ring MCP Tools
    Ring MCP Server
    Token economics
    Token launch jurisdictions
    Deploy (Docker · k8s)
    Security & compliance reads
    ringdom.org — LegioX homebase
    Source — MIT license (GitHub)

    Documentation

    Concepts, value, and typical clone scenarios — less code.

    Welcome to Ring
    Quick Reference
    Getting Started
    Prerequisites
    Installation
    First Success Validation
    Next Steps
    Features
    Multi-Vendor Store
    Inventory & Stock
    Vendor Management
    Commissions & Settlements
    SubscriptionConductor
    PaymentConductor
    Ring Oracle
    Payments Overview
    Public Pools & DAO Jars
    WayForPay Payment Integration
    Wallet & Credit System
    WalletConductor
    Affiliate & Referral Enablement
    Referral Codes (Refcodes)
    NFT Exhibition Marketplace
    Solana NFT Gates
    Token Staking System
    Owner Project Lab
    Entities
    Opportunities
    Real-Time Messaging
    Ring Tasks
    WebRTC Calls & STUNner TURN
    Peer Games
    News Module
    Member Blogs
    Public Profile Pages
    Profile Account Widgets
    Ring File Cabinet
    Username Reservation System
    Scientific Editor
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Email AI-CRM
    Ring Mailer & RingdomX Mail
    Tunnel Protocol
    VideoConductor
    MediaConductor
    Generative Gallery
    Authentication
    Security & Compliance
    Admin console
    Admin Wiki
    Manage via Telegram
    Locale System
    Mobile Experience
    Performance Optimization Patterns
    Examples
    Quick Start
    Basic Setup
    White Label
    Custom Branding
    Web3 Integration
    Real World
    Advanced Features
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Vertical Presets (SSOT)
    Ringization playbook
    Branding
    Themes
    Features
    Localization
    Token Economics Setup
    Payment Gateway Integration
    Reference Ring deployments
    Project configuration
    Public environment variables
    Order Lab secrets
    WalletConnect Project ID (Reown Cloud)
    Supported services
    NODUS wiki (project knowledge)
    Configuration playbook
    Web3
    Token launch jurisdictions
    Wallet
    Wallet Security Tips
    Integrations
    Ethereum wallets (Wagmi v3)
    RingFileBase (object storage API)
    Ring CDN (RingFileBase edge)
    Deployment
    Self-hosted deployment
    Vercel Deployment
    Docker
    Environment Configuration
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Architecture
    Data Model
    Security
    Real Time
    Discovery Mutation Sync
    PaymentConductor architecture
    WalletConductor architecture
    Backend Services
    Firebase Integration
    Development
    Ring MCP Server

    Quick entry (CTOs · auditors · agents)

    Welcome — mission & audiences
    Quick Reference
    Getting started
    Architecture & Auth.js
    Backend modes & databases (DB_BACKEND_MODE)
    Self-hosted
    Ring MCP Tools
    Ring MCP Server
    Token economics
    Token launch jurisdictions
    Deploy (Docker · k8s)
    Security & compliance reads
    ringdom.org — LegioX homebase
    Source — MIT license (GitHub)

    Documentation

    Concepts, value, and typical clone scenarios — less code.

    Welcome to Ring
    Quick Reference
    Getting Started
    Prerequisites
    Installation
    First Success Validation
    Next Steps
    Features
    Multi-Vendor Store
    Inventory & Stock
    Vendor Management
    Commissions & Settlements
    SubscriptionConductor
    PaymentConductor
    Ring Oracle
    Payments Overview
    Public Pools & DAO Jars
    WayForPay Payment Integration
    Wallet & Credit System
    WalletConductor
    Affiliate & Referral Enablement
    Referral Codes (Refcodes)
    NFT Exhibition Marketplace
    Solana NFT Gates
    Token Staking System
    Owner Project Lab
    Entities
    Opportunities
    Real-Time Messaging
    Ring Tasks
    WebRTC Calls & STUNner TURN
    Peer Games
    News Module
    Member Blogs
    Public Profile Pages
    Profile Account Widgets
    Ring File Cabinet
    Username Reservation System
    Scientific Editor
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Email AI-CRM
    Ring Mailer & RingdomX Mail
    Tunnel Protocol
    VideoConductor
    MediaConductor
    Generative Gallery
    Authentication
    Security & Compliance
    Admin console
    Admin Wiki
    Manage via Telegram
    Locale System
    Mobile Experience
    Performance Optimization Patterns
    Examples
    Quick Start
    Basic Setup
    White Label
    Custom Branding
    Web3 Integration
    Real World
    Advanced Features
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Vertical Presets (SSOT)
    Ringization playbook
    Branding
    Themes
    Features
    Localization
    Token Economics Setup
    Payment Gateway Integration
    Reference Ring deployments
    Project configuration
    Public environment variables
    Order Lab secrets
    WalletConnect Project ID (Reown Cloud)
    Supported services
    NODUS wiki (project knowledge)
    Configuration playbook
    Web3
    Token launch jurisdictions
    Wallet
    Wallet Security Tips
    Integrations
    Ethereum wallets (Wagmi v3)
    RingFileBase (object storage API)
    Ring CDN (RingFileBase edge)
    Deployment
    Self-hosted deployment
    Vercel Deployment
    Docker
    Environment Configuration
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Architecture
    Data Model
    Security
    Real Time
    Discovery Mutation Sync
    PaymentConductor architecture
    WalletConductor architecture
    Backend Services
    Firebase Integration
    Development
    Ring MCP Server

    Quick entry (CTOs · auditors · agents)

    Welcome — mission & audiences
    Quick Reference
    Getting started
    Architecture & Auth.js
    Backend modes & databases (DB_BACKEND_MODE)
    Self-hosted
    Ring MCP Tools
    Ring MCP Server
    Token economics
    Token launch jurisdictions
    Deploy (Docker · k8s)
    Security & compliance reads
    ringdom.org — LegioX homebase
    Source — MIT license (GitHub)
    Ring Platform Logo

    Loading documentation...

    Preparing Ring Platform content

    Ring Platform Logo

    Loading documentation...

    Preparing Ring Platform content

    Ring Platform Logo

    Loading documentation...

    Preparing Ring Platform content

    Architecture

    For executives: Ring is a white-label platform — one codebase, many branded deployments. Production rings run PostgreSQL-primary on Kubernetes with optional Firebase for push only, unified payments via PaymentConductor, and locale-aware routing without auth redirect loops.

    Ring Platform v1.6.0 is a white-label Next.js application with a single DatabaseService contract, config-driven payments, and optional Web3/token layers per clone. This page is the architecture hub; each topic below has a dedicated deep-dive page.

    Platform at a glance

    DimensionRing approach
    ApplicationNext.js 16 App Router, React 19 Server Components, Tailwind 4
    Data (production default)DB_BACKEND_MODE=k8s-postgres-fcm — Postgres + PostGIS, JSONB-first schema
    AuthAuth.js v5 — layout-level auth(), slim proxy.ts for locale only
    PaymentsPaymentConductor — WayForPay, Stripe, ledger + webhooks
    RealtimeTunnelHub — native WSS (/api/tunnel/ws) on k8s; SSE/poll on Vercel; driven by RING_DEPLOY_TARGET
    FilesVercel Blob or clone-specific object storage
    Deploy targetk3s (ringdom.org rings) — not Vercel-hosted Postgres
    ExtensionWhite-label env, portal config, per-clone token contracts

    System map

    Ring Platform — logical layers

    Architecture deep dives

    Backend modes & databases

    DB_BACKEND_MODE matrix — Postgres vs Firebase vs Supabase, FCM-only Firebase, Tunnel vs SQL backend

    Data model

    JSONB-first schema, PostGIS, collections contract, migrations

    Authentication

    Auth.js v5 providers, JWT sessions, Postgres adapter, role gates

    Proxy & internationalization

    Slim proxy, layout auth, localePrefix: as-needed, OAuth exclusions

    Cross-cutting flows

    Commerce + membership

    Store checkout flows through PaymentConductor (fiat) or RING credit / on-chain subscription (Web3-enabled clones). Settlement, vendor referral commission, and platform token rewards are documented under PaymentConductor, Affiliate enablement, and ERP commissions.

    Content + locale

    Public pages use next-intl with shared label modules. News and docs content are per-locale files under docs/{locale}/. EN is canonical unless LOCALE-GAPS marks a condensed UK/RU summary.

    White-label clones

    Operators fork the Ring repo, set portal branding, choose database mode, and optionally enable token economics — see White-label quick start and Token economics.

    v1.6.0 baseline: Postgres-primary + PaymentConductor + slim proxy + locale system. Start with Backend modes, then Environment configuration. Hub layout patterns: Documentation components.

    DB_HYBRID_MODE ≠ DB_BACKEND_MODE. Use DB_BACKEND_MODE for all new deployments; see backend-modes page for legacy hybrid references.

    Architecture

    For executives: Ring is a white-label platform — one codebase, many branded deployments. Production rings run PostgreSQL-primary on Kubernetes with optional Firebase for push only, unified payments via PaymentConductor, and locale-aware routing without auth redirect loops.

    Ring Platform v1.6.0 is a white-label Next.js application with a single DatabaseService contract, config-driven payments, and optional Web3/token layers per clone. This page is the architecture hub; each topic below has a dedicated deep-dive page.

    Platform at a glance

    DimensionRing approach
    ApplicationNext.js 16 App Router, React 19 Server Components, Tailwind 4
    Data (production default)DB_BACKEND_MODE=k8s-postgres-fcm — Postgres + PostGIS, JSONB-first schema
    AuthAuth.js v5 — layout-level auth(), slim proxy.ts for locale only
    PaymentsPaymentConductor — WayForPay, Stripe, ledger + webhooks
    RealtimeTunnelHub — native WSS (/api/tunnel/ws) on k8s; SSE/poll on Vercel; driven by RING_DEPLOY_TARGET
    FilesVercel Blob or clone-specific object storage
    Deploy targetk3s (ringdom.org rings) — not Vercel-hosted Postgres
    ExtensionWhite-label env, portal config, per-clone token contracts

    System map

    Ring Platform — logical layers

    Architecture deep dives

    Backend modes & databases

    DB_BACKEND_MODE matrix — Postgres vs Firebase vs Supabase, FCM-only Firebase, Tunnel vs SQL backend

    Data model

    JSONB-first schema, PostGIS, collections contract, migrations

    Authentication

    Auth.js v5 providers, JWT sessions, Postgres adapter, role gates

    Proxy & internationalization

    Slim proxy, layout auth, localePrefix: as-needed, OAuth exclusions

    Cross-cutting flows

    Commerce + membership

    Store checkout flows through PaymentConductor (fiat) or RING credit / on-chain subscription (Web3-enabled clones). Settlement, vendor referral commission, and platform token rewards are documented under PaymentConductor, Affiliate enablement, and ERP commissions.

    Content + locale

    Public pages use next-intl with shared label modules. News and docs content are per-locale files under docs/{locale}/. EN is canonical unless LOCALE-GAPS marks a condensed UK/RU summary.

    White-label clones

    Operators fork the Ring repo, set portal branding, choose database mode, and optionally enable token economics — see White-label quick start and Token economics.

    v1.6.0 baseline: Postgres-primary + PaymentConductor + slim proxy + locale system. Start with Backend modes, then Environment configuration. Hub layout patterns: Documentation components.

    DB_HYBRID_MODE ≠ DB_BACKEND_MODE. Use DB_BACKEND_MODE for all new deployments; see backend-modes page for legacy hybrid references.

    Architecture

    For executives: Ring is a white-label platform — one codebase, many branded deployments. Production rings run PostgreSQL-primary on Kubernetes with optional Firebase for push only, unified payments via PaymentConductor, and locale-aware routing without auth redirect loops.

    Ring Platform v1.6.0 is a white-label Next.js application with a single DatabaseService contract, config-driven payments, and optional Web3/token layers per clone. This page is the architecture hub; each topic below has a dedicated deep-dive page.

    Platform at a glance

    DimensionRing approach
    ApplicationNext.js 16 App Router, React 19 Server Components, Tailwind 4
    Data (production default)DB_BACKEND_MODE=k8s-postgres-fcm — Postgres + PostGIS, JSONB-first schema
    AuthAuth.js v5 — layout-level auth(), slim proxy.ts for locale only
    PaymentsPaymentConductor — WayForPay, Stripe, ledger + webhooks
    RealtimeTunnelHub — native WSS (/api/tunnel/ws) on k8s; SSE/poll on Vercel; driven by RING_DEPLOY_TARGET
    FilesVercel Blob or clone-specific object storage
    Deploy targetk3s (ringdom.org rings) — not Vercel-hosted Postgres
    ExtensionWhite-label env, portal config, per-clone token contracts

    System map

    Ring Platform — logical layers

    Architecture deep dives

    Backend modes & databases

    DB_BACKEND_MODE matrix — Postgres vs Firebase vs Supabase, FCM-only Firebase, Tunnel vs SQL backend

    Data model

    JSONB-first schema, PostGIS, collections contract, migrations

    Authentication

    Auth.js v5 providers, JWT sessions, Postgres adapter, role gates

    Proxy & internationalization

    Slim proxy, layout auth, localePrefix: as-needed, OAuth exclusions

    Cross-cutting flows

    Commerce + membership

    Store checkout flows through PaymentConductor (fiat) or RING credit / on-chain subscription (Web3-enabled clones). Settlement, vendor referral commission, and platform token rewards are documented under PaymentConductor, Affiliate enablement, and ERP commissions.

    Content + locale

    Public pages use next-intl with shared label modules. News and docs content are per-locale files under docs/{locale}/. EN is canonical unless LOCALE-GAPS marks a condensed UK/RU summary.

    White-label clones

    Operators fork the Ring repo, set portal branding, choose database mode, and optionally enable token economics — see White-label quick start and Token economics.

    v1.6.0 baseline: Postgres-primary + PaymentConductor + slim proxy + locale system. Start with Backend modes, then Environment configuration. Hub layout patterns: Documentation components.

    DB_HYBRID_MODE ≠ DB_BACKEND_MODE. Use DB_BACKEND_MODE for all new deployments; see backend-modes page for legacy hybrid references.

    Request path

    Code landmarks

    ConcernWhere to read
    Locale proxyproxy.ts, lib/proxy-intl.ts
    Auth enforcement(authenticated)/[locale]/layout.tsx, auth.config.ts
    DB mode switchlib/database/backend-mode-config.ts
    Paymentsfeatures/store/services/payment-conductor*
    Schema SSOTdata/schema.sql

    Component layering

    • Hooks — data fetching, wallet credit, realtime subscriptions
    • Feature components — store, messages, wallet sections (reusable across routes)
    • Pages — compose features; no direct adapter calls from presentation components

    PaymentConductor

    Config-driven processors, payment_transactions ledger, unified webhooks

    Email AI-CRM

    IMAP ingest, JSONB tables, cron poll, admin review pipeline

    Discovery mutation sync

    Post-CRUD cache tags, revalidatePath, and Tunnel events for opportunities and entities

    News Kingdom

    Editorial pipeline, generative newsroom hooks, publication flow

    Refcodes

    Attribution cookies, visit analytics, dual-rail ledger + on-chain minter

    Real-time

    TunnelHub, SSE/poll transports, discovery and notification fan-out

    Security

    Defense in depth, secrets, webhook verification, admin boundaries

    Request path

    Code landmarks

    ConcernWhere to read
    Locale proxyproxy.ts, lib/proxy-intl.ts
    Auth enforcement(authenticated)/[locale]/layout.tsx, auth.config.ts
    DB mode switchlib/database/backend-mode-config.ts
    Paymentsfeatures/store/services/payment-conductor*
    Schema SSOTdata/schema.sql

    Component layering

    • Hooks — data fetching, wallet credit, realtime subscriptions
    • Feature components — store, messages, wallet sections (reusable across routes)
    • Pages — compose features; no direct adapter calls from presentation components

    PaymentConductor

    Config-driven processors, payment_transactions ledger, unified webhooks

    Email AI-CRM

    IMAP ingest, JSONB tables, cron poll, admin review pipeline

    Discovery mutation sync

    Post-CRUD cache tags, revalidatePath, and Tunnel events for opportunities and entities

    News Kingdom

    Editorial pipeline, generative newsroom hooks, publication flow

    Refcodes

    Attribution cookies, visit analytics, dual-rail ledger + on-chain minter

    Real-time

    TunnelHub, SSE/poll transports, discovery and notification fan-out

    Security

    Defense in depth, secrets, webhook verification, admin boundaries

    Request path

    Code landmarks

    ConcernWhere to read
    Locale proxyproxy.ts, lib/proxy-intl.ts
    Auth enforcement(authenticated)/[locale]/layout.tsx, auth.config.ts
    DB mode switchlib/database/backend-mode-config.ts
    Paymentsfeatures/store/services/payment-conductor*
    Schema SSOTdata/schema.sql

    Component layering

    • Hooks — data fetching, wallet credit, realtime subscriptions
    • Feature components — store, messages, wallet sections (reusable across routes)
    • Pages — compose features; no direct adapter calls from presentation components

    PaymentConductor

    Config-driven processors, payment_transactions ledger, unified webhooks

    Email AI-CRM

    IMAP ingest, JSONB tables, cron poll, admin review pipeline

    Discovery mutation sync

    Post-CRUD cache tags, revalidatePath, and Tunnel events for opportunities and entities

    News Kingdom

    Editorial pipeline, generative newsroom hooks, publication flow

    Refcodes

    Attribution cookies, visit analytics, dual-rail ledger + on-chain minter

    Real-time

    TunnelHub, SSE/poll transports, discovery and notification fan-out

    Security

    Defense in depth, secrets, webhook verification, admin boundaries

    1. Docs
    2. /Architecture

    Updated Jun 10, 20264 min listen

    1. Docs
    2. /Architecture

    Updated Jun 10, 20264 min listen

    1. Docs
    2. /Architecture

    Updated Jun 10, 20264 min listen