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

    Public environment variables

    Every NEXT_PUBLIC_* value is public — it ships in the browser JavaScript bundle. Never put private keys, SMTP passwords, or Auth.js secrets in a NEXT_PUBLIC_ name.

    Public vars are classified by prefix (NEXT_PUBLIC_* → class public) and filtered for buyers by ownership (public_shared or owner_private with a public class). Buyers edit them on Secrets (?tab=secrets); integrators also see them on Env.

    What you typically set

    VariablePurposeGuide
    NEXT_PUBLIC_BASE_URL / NEXT_PUBLIC_APP_URLCanonical site URL for Auth.js callbacks and linksSecrets
    NEXT_PUBLIC_STORAGE_PROVIDERStorage backend label for the clientRing Filebase
    NEXT_PUBLIC_WALLETCONNECT_PROJECT_IDEnables WalletConnect QR / mobile walletsWalletConnect
    NEXT_PUBLIC_FIREBASE_*Client FCM / Firebase web configFirebase · FCM

    Brand name, tagline, and logo are not set here — use Project (?tab=project) so deploy mirrors stay consistent.

    Checklist

    • Base URL matches the domain you will go live on (https://…, no trailing slash surprises).
    • WalletConnect Project ID set if members should connect phone wallets.
    • Firebase public keys set only if you want push / client Firebase features.
    • Save on Secrets — ask integrator to deploy so ConfigMap picks up changes.

    Classification (verified)

    AxisRuleModule
    classkey.startsWith('NEXT_PUBLIC_') → public, else secretenv-template-parser.ts classifyKey
    ownerallowlists in env-key-ownership.tsbuyer sees owner_private + public_shared

    PUBLIC_SHARED_EXACT currently includes:

    • NEXT_PUBLIC_BASE_URL
    • NEXT_PUBLIC_APP_URL
    • NEXT_PUBLIC_STORAGE_PROVIDER
    • RINGBASE_API_URL
    • RINGBASE_PUBLIC_URL
    • NEXT_PUBLIC_WALLETCONNECT_PROJECT_ID

    Firebase client keys use NEXT_PUBLIC_FIREBASE_* prefix → owner_private (buyer-writable). Unknown template keys default to integrator_ops.

    Persist via PATCH /api/my-orders/[id]/env → ProjectDeploymentService.saveEnvConfig (template allowlist enforced).

    Related documentation

    Related documentation

    Order Lab secrets

    Next-step: private secrets and encryption on the same Secrets tab.

    WalletConnect Project ID (Reown Cloud)

    Deep-dive: create Reown Cloud Project ID for NEXT_PUBLIC_WALLETCONNECT_PROJECT_ID.

    Environment Configuration

    See-also: complete env.local.template catalog.

    Project configuration

    Prerequisite: project configuration hub.

    Public environment variables

    Every NEXT_PUBLIC_* value is public — it ships in the browser JavaScript bundle. Never put private keys, SMTP passwords, or Auth.js secrets in a NEXT_PUBLIC_ name.

    Public vars are classified by prefix (NEXT_PUBLIC_* → class public) and filtered for buyers by ownership (public_shared or owner_private with a public class). Buyers edit them on Secrets (?tab=secrets); integrators also see them on Env.

    What you typically set

    VariablePurposeGuide
    NEXT_PUBLIC_BASE_URL / NEXT_PUBLIC_APP_URLCanonical site URL for Auth.js callbacks and linksSecrets
    NEXT_PUBLIC_STORAGE_PROVIDERStorage backend label for the clientRing Filebase
    NEXT_PUBLIC_WALLETCONNECT_PROJECT_IDEnables WalletConnect QR / mobile walletsWalletConnect
    NEXT_PUBLIC_FIREBASE_*Client FCM / Firebase web configFirebase · FCM

    Brand name, tagline, and logo are not set here — use Project (?tab=project) so deploy mirrors stay consistent.

    Checklist

    • Base URL matches the domain you will go live on (https://…, no trailing slash surprises).
    • WalletConnect Project ID set if members should connect phone wallets.
    • Firebase public keys set only if you want push / client Firebase features.
    • Save on Secrets — ask integrator to deploy so ConfigMap picks up changes.

    Classification (verified)

    AxisRuleModule
    classkey.startsWith('NEXT_PUBLIC_') → public, else secretenv-template-parser.ts classifyKey
    ownerallowlists in env-key-ownership.tsbuyer sees owner_private + public_shared

    PUBLIC_SHARED_EXACT currently includes:

    • NEXT_PUBLIC_BASE_URL
    • NEXT_PUBLIC_APP_URL
    • NEXT_PUBLIC_STORAGE_PROVIDER
    • RINGBASE_API_URL
    • RINGBASE_PUBLIC_URL
    • NEXT_PUBLIC_WALLETCONNECT_PROJECT_ID

    Firebase client keys use NEXT_PUBLIC_FIREBASE_* prefix → owner_private (buyer-writable). Unknown template keys default to integrator_ops.

    Persist via PATCH /api/my-orders/[id]/env → ProjectDeploymentService.saveEnvConfig (template allowlist enforced).

    Related documentation

    Related documentation

    Order Lab secrets

    Next-step: private secrets and encryption on the same Secrets tab.

    WalletConnect Project ID (Reown Cloud)

    Deep-dive: create Reown Cloud Project ID for NEXT_PUBLIC_WALLETCONNECT_PROJECT_ID.

    Environment Configuration

    See-also: complete env.local.template catalog.

    Project configuration

    Prerequisite: project configuration hub.

    Public environment variables

    Every NEXT_PUBLIC_* value is public — it ships in the browser JavaScript bundle. Never put private keys, SMTP passwords, or Auth.js secrets in a NEXT_PUBLIC_ name.

    Public vars are classified by prefix (NEXT_PUBLIC_* → class public) and filtered for buyers by ownership (public_shared or owner_private with a public class). Buyers edit them on Secrets (?tab=secrets); integrators also see them on Env.

    What you typically set

    VariablePurposeGuide
    NEXT_PUBLIC_BASE_URL / NEXT_PUBLIC_APP_URLCanonical site URL for Auth.js callbacks and linksSecrets
    NEXT_PUBLIC_STORAGE_PROVIDERStorage backend label for the clientRing Filebase
    NEXT_PUBLIC_WALLETCONNECT_PROJECT_IDEnables WalletConnect QR / mobile walletsWalletConnect
    NEXT_PUBLIC_FIREBASE_*Client FCM / Firebase web configFirebase · FCM

    Brand name, tagline, and logo are not set here — use Project (?tab=project) so deploy mirrors stay consistent.

    Checklist

    • Base URL matches the domain you will go live on (https://…, no trailing slash surprises).
    • WalletConnect Project ID set if members should connect phone wallets.
    • Firebase public keys set only if you want push / client Firebase features.
    • Save on Secrets — ask integrator to deploy so ConfigMap picks up changes.

    Classification (verified)

    AxisRuleModule
    classkey.startsWith('NEXT_PUBLIC_') → public, else secretenv-template-parser.ts classifyKey
    ownerallowlists in env-key-ownership.tsbuyer sees owner_private + public_shared

    PUBLIC_SHARED_EXACT currently includes:

    • NEXT_PUBLIC_BASE_URL
    • NEXT_PUBLIC_APP_URL
    • NEXT_PUBLIC_STORAGE_PROVIDER
    • RINGBASE_API_URL
    • RINGBASE_PUBLIC_URL
    • NEXT_PUBLIC_WALLETCONNECT_PROJECT_ID

    Firebase client keys use NEXT_PUBLIC_FIREBASE_* prefix → owner_private (buyer-writable). Unknown template keys default to integrator_ops.

    Persist via PATCH /api/my-orders/[id]/env → ProjectDeploymentService.saveEnvConfig (template allowlist enforced).

    Related documentation

    Related documentation

    Order Lab secrets

    Next-step: private secrets and encryption on the same Secrets tab.

    WalletConnect Project ID (Reown Cloud)

    Deep-dive: create Reown Cloud Project ID for NEXT_PUBLIC_WALLETCONNECT_PROJECT_ID.

    Environment Configuration

    See-also: complete env.local.template catalog.

    Project configuration

    Prerequisite: project configuration hub.

    1. Docs
    2. /Project configuration
    3. /Public environment variables
    Updated Aug 7, 20262 min listen
    1. Docs
    2. /Project configuration
    3. /Public environment variables
    Updated Aug 7, 20262 min listen
    1. Docs
    2. /Project configuration
    3. /Public environment variables
    Updated Aug 7, 20262 min listen