Documentation

    Documentation

    Documentation

    Ring Platform Logo

    Завантаження документації...

    Підготовка контенту платформи Ring

    Ring Platform Logo

    Завантаження документації...

    Підготовка контенту платформи Ring

    Ring Platform Logo

    Завантаження документації...

    Підготовка контенту платформи Ring

    1. /Architecture

    Updated Jun 10, 20264 min listen

    1. /Architecture

    Updated Jun 10, 20264 min listen

    1. /Architecture

    Updated Jun 10, 20264 min listen

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

    Welcome to Ring
    Quick Reference
    Getting Started
    Prerequisites
    Installation
    Database migrations
    First Success Validation
    Troubleshooting
    Next Steps
    Architecture
    Backend modes and databases
    Data Model
    Authentication Architecture
    Email AI-CRM architecture
    PaymentConductor architecture
    Refcodes architecture
    News Kingdom architecture
    Proxy and internationalization
    Real Time
    Discovery Mutation Sync
    Security
    Features
    Doc System
    Authentication
    Email AI-CRM
    Entities
    Opportunities
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Tunnel Protocol
    Web3 Wallet
    Multi-Vendor Store
    Inventory & Stock
    Vendor Management
    Commissions & Settlements
    Referral Codes (Refcodes)
    Affiliate & Referral Enablement
    Payment Integration
    PaymentConductor
    VideoConductor
    WayForPay Payment Integration
    News Module - Digital Newspaper Experience
    Member Blogs
    Scientific Editor
    Locale System
    Security & Compliance
    NFT Marketplace
    Token Staking System
    Performance Optimization Patterns
    Mobile Experience
    Wallet
    Wallet Security Tips
    API
    Authentication
    Email AI-CRM API
    Entities
    Opportunities
    Messaging API
    Notifications API
    Wallet API
    Store API
    Admin API
    CLI
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Database Backend Selection
    Token Economics Setup
    Payment Gateway Integration
    AI Agent Customization
    Reference Ring deployments
    Branding
    Features
    Localization
    Themes
    Components
    Web3
    Token launch jurisdictions
    Deployment
    Self-hosted deployment
    Vercel
    Docker
    Environment Configuration
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Development
    Local Setup
    Code Structure
    Documentation components
    Community tooling
    Ring MCP Server
    Generative Images (ImageConductor)
    Autonomous Newsroom (Grok)
    OSS vs enterprise
    Whitelabel Navigation
    Best Practices
    Workflow
    Code Style
    Performance
    Testing
    Deployment
    Debugging
    Contributing
    MCP
    ring-image-create
    ring-video-create
    Roadmap
    Examples
    Quick Start
    Authentication
    Email AI-CRM developer guide
    API Integration Examples
    Web3 Integration
    White Label
    Real World
    API Examples (cURL)
    Integrations
    Ethereum wallets (Wagmi v3)

    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)

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

    Welcome to Ring
    Quick Reference
    Getting Started
    Prerequisites
    Installation
    Database migrations
    First Success Validation
    Troubleshooting
    Next Steps
    Architecture
    Backend modes and databases
    Data Model
    Authentication Architecture
    Email AI-CRM architecture
    PaymentConductor architecture
    Refcodes architecture
    News Kingdom architecture
    Proxy and internationalization
    Real Time
    Discovery Mutation Sync
    Security
    Features
    Doc System
    Authentication
    Email AI-CRM
    Entities
    Opportunities
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Tunnel Protocol
    Web3 Wallet
    Multi-Vendor Store
    Inventory & Stock
    Vendor Management
    Commissions & Settlements
    Referral Codes (Refcodes)
    Affiliate & Referral Enablement
    Payment Integration
    PaymentConductor
    VideoConductor
    WayForPay Payment Integration
    News Module - Digital Newspaper Experience
    Member Blogs
    Scientific Editor
    Locale System
    Security & Compliance
    NFT Marketplace
    Token Staking System
    Performance Optimization Patterns
    Mobile Experience
    Wallet
    Wallet Security Tips
    API
    Authentication
    Email AI-CRM API
    Entities
    Opportunities
    Messaging API
    Notifications API
    Wallet API
    Store API
    Admin API
    CLI
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Database Backend Selection
    Token Economics Setup
    Payment Gateway Integration
    AI Agent Customization
    Reference Ring deployments
    Branding
    Features
    Localization
    Themes
    Components
    Web3
    Token launch jurisdictions
    Deployment
    Self-hosted deployment
    Vercel
    Docker
    Environment Configuration
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Development
    Local Setup
    Code Structure
    Documentation components
    Community tooling
    Ring MCP Server
    Generative Images (ImageConductor)
    Autonomous Newsroom (Grok)
    OSS vs enterprise
    Whitelabel Navigation
    Best Practices
    Workflow
    Code Style
    Performance
    Testing
    Deployment
    Debugging
    Contributing
    MCP
    ring-image-create
    ring-video-create
    Roadmap
    Examples
    Quick Start
    Authentication
    Email AI-CRM developer guide
    API Integration Examples
    Web3 Integration
    White Label
    Real World
    API Examples (cURL)
    Integrations
    Ethereum wallets (Wagmi v3)

    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)

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

    Welcome to Ring
    Quick Reference
    Getting Started
    Prerequisites
    Installation
    Database migrations
    First Success Validation
    Troubleshooting
    Next Steps
    Architecture
    Backend modes and databases
    Data Model
    Authentication Architecture
    Email AI-CRM architecture
    PaymentConductor architecture
    Refcodes architecture
    News Kingdom architecture
    Proxy and internationalization
    Real Time
    Discovery Mutation Sync
    Security
    Features
    Doc System
    Authentication
    Email AI-CRM
    Entities
    Opportunities
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Tunnel Protocol
    Web3 Wallet
    Multi-Vendor Store
    Inventory & Stock
    Vendor Management
    Commissions & Settlements
    Referral Codes (Refcodes)
    Affiliate & Referral Enablement
    Payment Integration
    PaymentConductor
    VideoConductor
    WayForPay Payment Integration
    News Module - Digital Newspaper Experience
    Member Blogs
    Scientific Editor
    Locale System
    Security & Compliance
    NFT Marketplace
    Token Staking System
    Performance Optimization Patterns
    Mobile Experience
    Wallet
    Wallet Security Tips
    API
    Authentication
    Email AI-CRM API
    Entities
    Opportunities
    Messaging API
    Notifications API
    Wallet API
    Store API
    Admin API
    CLI
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Database Backend Selection
    Token Economics Setup
    Payment Gateway Integration
    AI Agent Customization
    Reference Ring deployments
    Branding
    Features
    Localization
    Themes
    Components
    Web3
    Token launch jurisdictions
    Deployment
    Self-hosted deployment
    Vercel
    Docker
    Environment Configuration
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Development
    Local Setup
    Code Structure
    Documentation components
    Community tooling
    Ring MCP Server
    Generative Images (ImageConductor)
    Autonomous Newsroom (Grok)
    OSS vs enterprise
    Whitelabel Navigation
    Best Practices
    Workflow
    Code Style
    Performance
    Testing
    Deployment
    Debugging
    Contributing
    MCP
    ring-image-create
    ring-video-create
    Roadmap
    Examples
    Quick Start
    Authentication
    Email AI-CRM developer guide
    API Integration Examples
    Web3 Integration
    White Label
    Real World
    API Examples (cURL)
    Integrations
    Ethereum wallets (Wagmi v3)

    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)
    Docs
    Docs
    Docs

    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

    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

    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

    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

    Proxy & internationalization

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

    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

    Proxy & internationalization

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

    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

    Proxy & internationalization

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

    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