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
    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
    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
    Branding
    Themes
    Features
    Localization
    Token Economics Setup
    Payment Gateway Integration
    Reference Ring deployments
    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
    Docker
    Environment Configuration
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Architecture
    Data Model
    Security
    Real Time
    Discovery Mutation Sync
    PaymentConductor architecture
    WalletConductor architecture
    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
    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
    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
    Branding
    Themes
    Features
    Localization
    Token Economics Setup
    Payment Gateway Integration
    Reference Ring deployments
    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
    Docker
    Environment Configuration
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Architecture
    Data Model
    Security
    Real Time
    Discovery Mutation Sync
    PaymentConductor architecture
    WalletConductor architecture
    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
    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
    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
    Branding
    Themes
    Features
    Localization
    Token Economics Setup
    Payment Gateway Integration
    Reference Ring deployments
    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
    Docker
    Environment Configuration
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Architecture
    Data Model
    Security
    Real Time
    Discovery Mutation Sync
    PaymentConductor architecture
    WalletConductor architecture
    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)
    1. Docs
    2. /Examples
    3. /Quick Start
    Updated Jul 12, 20263 min listen
    Ring Platform Logo

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

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

    1. Docs
    2. /Examples
    3. /Quick Start
    Updated Jul 12, 20263 min listen
    Ring Platform Logo

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

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

    1. Docs
    2. /Examples
    3. /Quick Start
    Updated Jul 12, 20263 min listen
    Ring Platform Logo

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

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

    Quick Start

    Get a Ring Platform clone running in minutes — either as a managed Ringdom settlement or as a self-hosted open-source install via ./install.sh.

    Use Founder / Developer tabs. Founders compare ways to launch. Developers configure env vars and boot Postgres.

    Pick the path that matches how much ops you want on your plate.

    What each path means

    PathBest whenYou get
    Ringdom.orgYou type your needs in chat with AI agentAI builds your superapp, deploys and maintains
    Self-host OSSYou want full control on your machine / VPSinstall.sh → Next.js + PostgreSQL clone you operate
    Ringdom, Promptor or Self-Host?

    Ringdom.org is AI-managed Enterprise Cloud Service https://ringdom.org/new for founders who know what they need.

    Founder checklist — self-host

    1. 1

      Clone and run install

      install.sh copies env.local.template → .env.local, generates secrets, and walks interactive setup.

    2. 2

      Fill required env vars

      At minimum set the variables in the Developer section below (DB_BACKEND_MODE, Postgres DB_*, AUTH_SECRET, one OAuth provider). Without these the app will not boot healthy.

    3. 3

      Start Postgres + schema, then npm run dev

      Follow Installation for Docker Postgres and data/schema.sql. Open http://localhost:3000.

    Full installation guide

    Path 1 install.sh vs manual, migrations, and OAuth redirect URIs.

    WalletConductor

    After boot — credit top-up, desk, and custodial wallets.

    PaymentConductor

    Store / membership / wallet_topup rails when you are ready for payments.

    Self-host with install.sh

    The public OSS repo does not ship the commercial Ring CLI. See Community tooling.

    install.sh will:

    1. Verify Node.js 20+
    2. Copy env.local.template → .env.local (generates AUTH_SECRET / WALLET_ENCRYPTION_KEY when prompted)
    3. Copy ring-config.template.json → ring-config.json when missing
    4. Run npm install

    Then finish the required env values below and start PostgreSQL.

    Required environment variables

    SSOT template: env.local.template. These are the minimum for a self-hosted local instance with DB_BACKEND_MODE=k8s-postgres-fcm (recommended).

    Critical — will not start without

    Auth providers (at least one for login)

    Google Cloud redirect URI for local:

    http://localhost:3000/api/auth/callback/google

    Real-time tunnel (local / self-hosted)

    Locales (defaults match community portal)

    Wallet / Solana (required once you open custodial wallet features)

    Generated by install.sh when present in template:

    Optional for first homepage boot

    Related

    Installation

    install.sh vs manual, Docker Postgres, OAuth.

    Prerequisites

    Node 20+, Postgres, what is optional on day one.

    First success

    Health check and smoke paths after boot.

    Deployment

    Self-hosted, Docker, Vercel, environment.

    Quick Start

    Get a Ring Platform clone running in minutes — either as a managed Ringdom settlement or as a self-hosted open-source install via ./install.sh.

    Use Founder / Developer tabs. Founders compare ways to launch. Developers configure env vars and boot Postgres.

    Pick the path that matches how much ops you want on your plate.

    What each path means

    PathBest whenYou get
    Ringdom.orgYou type your needs in chat with AI agentAI builds your superapp, deploys and maintains
    Self-host OSSYou want full control on your machine / VPSinstall.sh → Next.js + PostgreSQL clone you operate
    Ringdom, Promptor or Self-Host?

    Ringdom.org is AI-managed Enterprise Cloud Service https://ringdom.org/new for founders who know what they need.

    Founder checklist — self-host

    1. 1

      Clone and run install

      install.sh copies env.local.template → .env.local, generates secrets, and walks interactive setup.

    2. 2

      Fill required env vars

      At minimum set the variables in the Developer section below (DB_BACKEND_MODE, Postgres DB_*, AUTH_SECRET, one OAuth provider). Without these the app will not boot healthy.

    3. 3

      Start Postgres + schema, then npm run dev

      Follow Installation for Docker Postgres and data/schema.sql. Open http://localhost:3000.

    Full installation guide

    Path 1 install.sh vs manual, migrations, and OAuth redirect URIs.

    WalletConductor

    After boot — credit top-up, desk, and custodial wallets.

    PaymentConductor

    Store / membership / wallet_topup rails when you are ready for payments.

    Self-host with install.sh

    The public OSS repo does not ship the commercial Ring CLI. See Community tooling.

    install.sh will:

    1. Verify Node.js 20+
    2. Copy env.local.template → .env.local (generates AUTH_SECRET / WALLET_ENCRYPTION_KEY when prompted)
    3. Copy ring-config.template.json → ring-config.json when missing
    4. Run npm install

    Then finish the required env values below and start PostgreSQL.

    Required environment variables

    SSOT template: env.local.template. These are the minimum for a self-hosted local instance with DB_BACKEND_MODE=k8s-postgres-fcm (recommended).

    Critical — will not start without

    Auth providers (at least one for login)

    Google Cloud redirect URI for local:

    http://localhost:3000/api/auth/callback/google

    Real-time tunnel (local / self-hosted)

    Locales (defaults match community portal)

    Wallet / Solana (required once you open custodial wallet features)

    Generated by install.sh when present in template:

    Optional for first homepage boot

    Related

    Installation

    install.sh vs manual, Docker Postgres, OAuth.

    Prerequisites

    Node 20+, Postgres, what is optional on day one.

    First success

    Health check and smoke paths after boot.

    Deployment

    Self-hosted, Docker, Vercel, environment.

    Quick Start

    Get a Ring Platform clone running in minutes — either as a managed Ringdom settlement or as a self-hosted open-source install via ./install.sh.

    Use Founder / Developer tabs. Founders compare ways to launch. Developers configure env vars and boot Postgres.

    Pick the path that matches how much ops you want on your plate.

    What each path means

    PathBest whenYou get
    Ringdom.orgYou type your needs in chat with AI agentAI builds your superapp, deploys and maintains
    Self-host OSSYou want full control on your machine / VPSinstall.sh → Next.js + PostgreSQL clone you operate
    Ringdom, Promptor or Self-Host?

    Ringdom.org is AI-managed Enterprise Cloud Service https://ringdom.org/new for founders who know what they need.

    Founder checklist — self-host

    1. 1

      Clone and run install

      install.sh copies env.local.template → .env.local, generates secrets, and walks interactive setup.

    2. 2

      Fill required env vars

      At minimum set the variables in the Developer section below (DB_BACKEND_MODE, Postgres DB_*, AUTH_SECRET, one OAuth provider). Without these the app will not boot healthy.

    3. 3

      Start Postgres + schema, then npm run dev

      Follow Installation for Docker Postgres and data/schema.sql. Open http://localhost:3000.

    Full installation guide

    Path 1 install.sh vs manual, migrations, and OAuth redirect URIs.

    WalletConductor

    After boot — credit top-up, desk, and custodial wallets.

    PaymentConductor

    Store / membership / wallet_topup rails when you are ready for payments.

    Self-host with install.sh

    The public OSS repo does not ship the commercial Ring CLI. See Community tooling.

    install.sh will:

    1. Verify Node.js 20+
    2. Copy env.local.template → .env.local (generates AUTH_SECRET / WALLET_ENCRYPTION_KEY when prompted)
    3. Copy ring-config.template.json → ring-config.json when missing
    4. Run npm install

    Then finish the required env values below and start PostgreSQL.

    Required environment variables

    SSOT template: env.local.template. These are the minimum for a self-hosted local instance with DB_BACKEND_MODE=k8s-postgres-fcm (recommended).

    Critical — will not start without

    Auth providers (at least one for login)

    Google Cloud redirect URI for local:

    http://localhost:3000/api/auth/callback/google

    Real-time tunnel (local / self-hosted)

    Locales (defaults match community portal)

    Wallet / Solana (required once you open custodial wallet features)

    Generated by install.sh when present in template:

    Optional for first homepage boot

    Related

    Installation

    install.sh vs manual, Docker Postgres, OAuth.

    Prerequisites

    Node 20+, Postgres, what is optional on day one.

    First success

    Health check and smoke paths after boot.

    Deployment

    Self-hosted, Docker, Vercel, environment.

    AreaVarsNeeded for
    Firebase FCMAUTH_FIREBASE_*, NEXT_PUBLIC_FIREBASE_*Push only — not required for Postgres homepage
    WayForPay / StripeWAYFORPAY_*, STRIPE_*Checkout — add before store payments
    Supabase modeSUPABASE_URL, SUPABASE_ANON_KEY, SUPABASE_SERVICE_KEYOnly if DB_BACKEND_MODE=supabase-fcm

    Full annotated list: env.local.template. Deep walkthrough: Installation → Configure environment.

    Postgres + first boot

    1. 1

      Start PostgreSQL 16

    2. 2

      Apply schema

      Then apply kingdom migrations as listed in Migrations.

    3. 3

      Run the app

      Expect status: "healthy" when AUTH_SECRET and DB are correct (degraded / 503 usually means missing AUTH_SECRET).

    AreaVarsNeeded for
    Firebase FCMAUTH_FIREBASE_*, NEXT_PUBLIC_FIREBASE_*Push only — not required for Postgres homepage
    WayForPay / StripeWAYFORPAY_*, STRIPE_*Checkout — add before store payments
    Supabase modeSUPABASE_URL, SUPABASE_ANON_KEY, SUPABASE_SERVICE_KEYOnly if DB_BACKEND_MODE=supabase-fcm

    Full annotated list: env.local.template. Deep walkthrough: Installation → Configure environment.

    Postgres + first boot

    1. 1

      Start PostgreSQL 16

    2. 2

      Apply schema

      Then apply kingdom migrations as listed in Migrations.

    3. 3

      Run the app

      Expect status: "healthy" when AUTH_SECRET and DB are correct (degraded / 503 usually means missing AUTH_SECRET).

    AreaVarsNeeded for
    Firebase FCMAUTH_FIREBASE_*, NEXT_PUBLIC_FIREBASE_*Push only — not required for Postgres homepage
    WayForPay / StripeWAYFORPAY_*, STRIPE_*Checkout — add before store payments
    Supabase modeSUPABASE_URL, SUPABASE_ANON_KEY, SUPABASE_SERVICE_KEYOnly if DB_BACKEND_MODE=supabase-fcm

    Full annotated list: env.local.template. Deep walkthrough: Installation → Configure environment.

    Postgres + first boot

    1. 1

      Start PostgreSQL 16

    2. 2

      Apply schema

      Then apply kingdom migrations as listed in Migrations.

    3. 3

      Run the app

      Expect status: "healthy" when AUTH_SECRET and DB are correct (degraded / 503 usually means missing AUTH_SECRET).