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

    Advanced Features

    Filter with Founder / Developer in the docs sidebar. Legacy content here invented approval workflows, operational transforms, and CDN managers that do not exist in the OSS tree. This page maps shipped modules you can enable per clone.

    Ring Platform “advanced” behavior is not a separate enterprise SKU — it is feature modules behind env flags, admin settings, and Server Actions. Founders choose which modules matter for their clone; developers wire the same code paths documented below.

    Capability map (verified in repo)

    CapabilityFounder outcomeCode anchor
    AI opportunity matcherRelevant users notified when listings postfeatures/opportunities/services/matching-service.ts
    Matcher auto-approvalHigh-confidence listings go live without manual reviewmaybeAutoApproveOpportunity()
    Entity verificationTrust badge after document reviewrequestEntityVerification() + verification_procedures
    Entity moderationReport/block bad actors; admin queueentity-moderation.ts, admin matcher queue
    PaymentConductorWayForPay / Stripe / internal credit checkoutlib/payments/conductor/payment-conductor.ts
    ProcessConductorCron pipelines with run ledgerlib/processes/conductor/process-conductor.ts
    Email AI-CRMInbox poll, draft replies, analytics cron/api/cron/email-processor, /api/cron/email-analytics
    Generative conductorsNewsroom images/text/video via xAIImageConductor, TextConductor, VideoConductor
    Tunnel realtimeLive notifications and discovery eventslib/tunnel/*, discovery sync
    Confidential tierGated listings for vetted members/confidential/* routes, role checks

    When to turn these on

    Advanced modules solve trust, speed, and automation — not “more buttons.”

    Opportunity marketplace

    Enable AI matcher so subscribers get notified; optional auto-approval reduces moderator load when match scores are strong.

    Verified vendor directory

    Verification procedures give buyers confidence; moderation handles abuse reports without shutting down the whole directory.

    Paid membership + store

    PaymentConductor unifies checkout; ERP/settlement modules track vendor payouts on multi-vendor clones.

    Publisher / news clone

    Module integration patterns

    Advanced publish path (opportunity)

    AI matcher + auto-approval

    Controlled by platform_settings / env (MATCHER_AUTO_APPROVE, MATCHER_AUTO_APPROVE_MIN_SCORE, LLM_PROVIDER, OPENAI_API_KEY or ANTHROPIC_API_KEY).

    Deep dive: Opportunities feature (matcher + auto-approve section), admin config in features/admin/platform-settings/.

    Entity verification (SSOT)

    Uses unified verification_procedures — not a standalone AI document analyzer class.

    Entity moderation

    • User reports: reportEntity({ entityId, category, reason })
    • Admin queue: getEntityModerationQueue() (features/admin/matcher/get-entity-moderation-queue.ts)
    • User blocks stored on users.data.blockedEntityIds

    Conductors (payments & background work)

    See PaymentConductor architecture, Email AI-CRM example.

    Realtime (not collaborative OT)

    Ring uses Tunnel topic channels for discovery and notifications — there is no operational-transform document engine in this repo. After mutations, call syncOpportunityDiscovery / ().

    Related documentation

    API integration examples

    Server Actions, REST, and Tunnel patterns.

    Entities feature

    CRUD, showcase, verification UX.

    Store & ERP

    Multi-vendor settlement and inventory.

    Performance

    Caching and RSC patterns for scale.

    White-label clones

    Navigation note

    This page is reachable at /docs/examples/advanced-features but is not listed in docs/en/examples/meta.json hub order — treat it as a capability index; prefer linked feature docs for step-by-step setup.

    Advanced Features

    Filter with Founder / Developer in the docs sidebar. Legacy content here invented approval workflows, operational transforms, and CDN managers that do not exist in the OSS tree. This page maps shipped modules you can enable per clone.

    Ring Platform “advanced” behavior is not a separate enterprise SKU — it is feature modules behind env flags, admin settings, and Server Actions. Founders choose which modules matter for their clone; developers wire the same code paths documented below.

    Capability map (verified in repo)

    CapabilityFounder outcomeCode anchor
    AI opportunity matcherRelevant users notified when listings postfeatures/opportunities/services/matching-service.ts
    Matcher auto-approvalHigh-confidence listings go live without manual reviewmaybeAutoApproveOpportunity()
    Entity verificationTrust badge after document reviewrequestEntityVerification() + verification_procedures
    Entity moderationReport/block bad actors; admin queueentity-moderation.ts, admin matcher queue
    PaymentConductorWayForPay / Stripe / internal credit checkoutlib/payments/conductor/payment-conductor.ts
    ProcessConductorCron pipelines with run ledgerlib/processes/conductor/process-conductor.ts
    Email AI-CRMInbox poll, draft replies, analytics cron/api/cron/email-processor, /api/cron/email-analytics
    Generative conductorsNewsroom images/text/video via xAIImageConductor, TextConductor, VideoConductor
    Tunnel realtimeLive notifications and discovery eventslib/tunnel/*, discovery sync
    Confidential tierGated listings for vetted members/confidential/* routes, role checks

    When to turn these on

    Advanced modules solve trust, speed, and automation — not “more buttons.”

    Opportunity marketplace

    Enable AI matcher so subscribers get notified; optional auto-approval reduces moderator load when match scores are strong.

    Verified vendor directory

    Verification procedures give buyers confidence; moderation handles abuse reports without shutting down the whole directory.

    Paid membership + store

    PaymentConductor unifies checkout; ERP/settlement modules track vendor payouts on multi-vendor clones.

    Publisher / news clone

    Module integration patterns

    Advanced publish path (opportunity)

    AI matcher + auto-approval

    Controlled by platform_settings / env (MATCHER_AUTO_APPROVE, MATCHER_AUTO_APPROVE_MIN_SCORE, LLM_PROVIDER, OPENAI_API_KEY or ANTHROPIC_API_KEY).

    Deep dive: Opportunities feature (matcher + auto-approve section), admin config in features/admin/platform-settings/.

    Entity verification (SSOT)

    Uses unified verification_procedures — not a standalone AI document analyzer class.

    Entity moderation

    • User reports: reportEntity({ entityId, category, reason })
    • Admin queue: getEntityModerationQueue() (features/admin/matcher/get-entity-moderation-queue.ts)
    • User blocks stored on users.data.blockedEntityIds

    Conductors (payments & background work)

    See PaymentConductor architecture, Email AI-CRM example.

    Realtime (not collaborative OT)

    Ring uses Tunnel topic channels for discovery and notifications — there is no operational-transform document engine in this repo. After mutations, call syncOpportunityDiscovery / ().

    Related documentation

    API integration examples

    Server Actions, REST, and Tunnel patterns.

    Entities feature

    CRUD, showcase, verification UX.

    Store & ERP

    Multi-vendor settlement and inventory.

    Performance

    Caching and RSC patterns for scale.

    White-label clones

    Navigation note

    This page is reachable at /docs/examples/advanced-features but is not listed in docs/en/examples/meta.json hub order — treat it as a capability index; prefer linked feature docs for step-by-step setup.

    Advanced Features

    Filter with Founder / Developer in the docs sidebar. Legacy content here invented approval workflows, operational transforms, and CDN managers that do not exist in the OSS tree. This page maps shipped modules you can enable per clone.

    Ring Platform “advanced” behavior is not a separate enterprise SKU — it is feature modules behind env flags, admin settings, and Server Actions. Founders choose which modules matter for their clone; developers wire the same code paths documented below.

    Capability map (verified in repo)

    CapabilityFounder outcomeCode anchor
    AI opportunity matcherRelevant users notified when listings postfeatures/opportunities/services/matching-service.ts
    Matcher auto-approvalHigh-confidence listings go live without manual reviewmaybeAutoApproveOpportunity()
    Entity verificationTrust badge after document reviewrequestEntityVerification() + verification_procedures
    Entity moderationReport/block bad actors; admin queueentity-moderation.ts, admin matcher queue
    PaymentConductorWayForPay / Stripe / internal credit checkoutlib/payments/conductor/payment-conductor.ts
    ProcessConductorCron pipelines with run ledgerlib/processes/conductor/process-conductor.ts
    Email AI-CRMInbox poll, draft replies, analytics cron/api/cron/email-processor, /api/cron/email-analytics
    Generative conductorsNewsroom images/text/video via xAIImageConductor, TextConductor, VideoConductor
    Tunnel realtimeLive notifications and discovery eventslib/tunnel/*, discovery sync
    Confidential tierGated listings for vetted members/confidential/* routes, role checks

    When to turn these on

    Advanced modules solve trust, speed, and automation — not “more buttons.”

    Opportunity marketplace

    Enable AI matcher so subscribers get notified; optional auto-approval reduces moderator load when match scores are strong.

    Verified vendor directory

    Verification procedures give buyers confidence; moderation handles abuse reports without shutting down the whole directory.

    Paid membership + store

    PaymentConductor unifies checkout; ERP/settlement modules track vendor payouts on multi-vendor clones.

    Publisher / news clone

    Module integration patterns

    Advanced publish path (opportunity)

    AI matcher + auto-approval

    Controlled by platform_settings / env (MATCHER_AUTO_APPROVE, MATCHER_AUTO_APPROVE_MIN_SCORE, LLM_PROVIDER, OPENAI_API_KEY or ANTHROPIC_API_KEY).

    Deep dive: Opportunities feature (matcher + auto-approve section), admin config in features/admin/platform-settings/.

    Entity verification (SSOT)

    Uses unified verification_procedures — not a standalone AI document analyzer class.

    Entity moderation

    • User reports: reportEntity({ entityId, category, reason })
    • Admin queue: getEntityModerationQueue() (features/admin/matcher/get-entity-moderation-queue.ts)
    • User blocks stored on users.data.blockedEntityIds

    Conductors (payments & background work)

    See PaymentConductor architecture, Email AI-CRM example.

    Realtime (not collaborative OT)

    Ring uses Tunnel topic channels for discovery and notifications — there is no operational-transform document engine in this repo. After mutations, call syncOpportunityDiscovery / ().

    Related documentation

    API integration examples

    Server Actions, REST, and Tunnel patterns.

    Entities feature

    CRUD, showcase, verification UX.

    Store & ERP

    Multi-vendor settlement and inventory.

    Performance

    Caching and RSC patterns for scale.

    White-label clones

    Navigation note

    This page is reachable at /docs/examples/advanced-features but is not listed in docs/en/examples/meta.json hub order — treat it as a capability index; prefer linked feature docs for step-by-step setup.

    Text + Image conductors draft articles; ProcessConductor records cron runs for operator audit.

    Confidential deal flow

    Confidential role unlocks restricted entity/opportunity hubs — same Postgres schema, stricter layout gates.

    Typical scenarios (generalized)

    • Regional IT network — opportunities with ring_customization category; matcher surfaces relevant developers; admin approves or auto-approves.
    • B2B marketplace — entities request verification; store vendors complete PaymentConductor onboarding.
    • Community + inbox — Email AI-CRM polls info@yourclone.com; urgent threads escalate via admin notifications.
    • White-label Ring services — opportunity categories include platform_deployment, database_migration, payment_integration (see filter presets SSOT).

    Start with manual moderation, enable auto-approve only after reviewing matcher quality on staging. MATCHER_AUTO_APPROVE defaults off in platform settings schema.

    syncEntityDiscovery
    Discovery mutation sync

    Opportunity filter SSOT

    Browse/form categories: features/opportunities/lib/opportunity-filter-presets.ts — keep docs and i18n aligned with OPPORTUNITY_FILTER_CATEGORY_IDS.

    Enable checklist

    1. 1

      Apply Postgres schema + migrations including platform_settings, verification_procedures, payment_transactions, process_runs as needed (Migrations).

    2. 2

      Configure LLM keys and matcher flags; test matcher on staging before autoApprove: true.

    3. 3

      Wire webhooks for PaymentConductor (server-side HMAC verify only).

    4. 4

      Schedule cron routes with CRON_SECRET (Monitoring).

    One deployment and database per organization.

    Text + Image conductors draft articles; ProcessConductor records cron runs for operator audit.

    Confidential deal flow

    Confidential role unlocks restricted entity/opportunity hubs — same Postgres schema, stricter layout gates.

    Typical scenarios (generalized)

    • Regional IT network — opportunities with ring_customization category; matcher surfaces relevant developers; admin approves or auto-approves.
    • B2B marketplace — entities request verification; store vendors complete PaymentConductor onboarding.
    • Community + inbox — Email AI-CRM polls info@yourclone.com; urgent threads escalate via admin notifications.
    • White-label Ring services — opportunity categories include platform_deployment, database_migration, payment_integration (see filter presets SSOT).

    Start with manual moderation, enable auto-approve only after reviewing matcher quality on staging. MATCHER_AUTO_APPROVE defaults off in platform settings schema.

    syncEntityDiscovery
    Discovery mutation sync

    Opportunity filter SSOT

    Browse/form categories: features/opportunities/lib/opportunity-filter-presets.ts — keep docs and i18n aligned with OPPORTUNITY_FILTER_CATEGORY_IDS.

    Enable checklist

    1. 1

      Apply Postgres schema + migrations including platform_settings, verification_procedures, payment_transactions, process_runs as needed (Migrations).

    2. 2

      Configure LLM keys and matcher flags; test matcher on staging before autoApprove: true.

    3. 3

      Wire webhooks for PaymentConductor (server-side HMAC verify only).

    4. 4

      Schedule cron routes with CRON_SECRET (Monitoring).

    One deployment and database per organization.

    Text + Image conductors draft articles; ProcessConductor records cron runs for operator audit.

    Confidential deal flow

    Confidential role unlocks restricted entity/opportunity hubs — same Postgres schema, stricter layout gates.

    Typical scenarios (generalized)

    • Regional IT network — opportunities with ring_customization category; matcher surfaces relevant developers; admin approves or auto-approves.
    • B2B marketplace — entities request verification; store vendors complete PaymentConductor onboarding.
    • Community + inbox — Email AI-CRM polls info@yourclone.com; urgent threads escalate via admin notifications.
    • White-label Ring services — opportunity categories include platform_deployment, database_migration, payment_integration (see filter presets SSOT).

    Start with manual moderation, enable auto-approve only after reviewing matcher quality on staging. MATCHER_AUTO_APPROVE defaults off in platform settings schema.

    syncEntityDiscovery
    Discovery mutation sync

    Opportunity filter SSOT

    Browse/form categories: features/opportunities/lib/opportunity-filter-presets.ts — keep docs and i18n aligned with OPPORTUNITY_FILTER_CATEGORY_IDS.

    Enable checklist

    1. 1

      Apply Postgres schema + migrations including platform_settings, verification_procedures, payment_transactions, process_runs as needed (Migrations).

    2. 2

      Configure LLM keys and matcher flags; test matcher on staging before autoApprove: true.

    3. 3

      Wire webhooks for PaymentConductor (server-side HMAC verify only).

    4. 4

      Schedule cron routes with CRON_SECRET (Monitoring).

    One deployment and database per organization.

    1. Docs
    2. /Examples
    3. /Advanced Features

    Updated Jun 22, 20264 min listen

    1. Docs
    2. /Examples
    3. /Advanced Features

    Updated Jun 22, 20264 min listen

    1. Docs
    2. /Examples
    3. /Advanced Features

    Updated Jun 22, 20264 min listen