OpportunitiesEntities
Docs
    Ring Platform

    Decentralized Self-building Future

    Sign In
    Entities
    Opportunities
    Store
    Docs
    Platform Concepts
    RING EconomySonoratek LLCGlobal ImpactAI Meets Web3
    Get Started
    Quick StartCalculatorRoadmap
    Privacy|Contact
    v1.104.26|Sonoratek LLC

    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
    Credit Rewards
    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
    News Kingdom architecture
    Backend Services
    Firebase Integration
    Development
    Ring MCP Server
    OSS vs enterprise

    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
    Credit Rewards
    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
    News Kingdom architecture
    Backend Services
    Firebase Integration
    Development
    Ring MCP Server
    OSS vs enterprise

    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
    Credit Rewards
    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
    News Kingdom architecture
    Backend Services
    Firebase Integration
    Development
    Ring MCP Server
    OSS vs enterprise

    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 Logo

    Loading documentation...

    Preparing Ring content

    Ring Logo

    Loading documentation...

    Preparing Ring content

    Ring Logo

    Loading documentation...

    Preparing Ring content

    Community tooling

    Status: install.sh, the ring CLI and the helpers in ring/scripts/ all ship publicly. Older docs pointed to scripts/setup-dev.sh, npm run setup:env and scripts/run-migration.sh. Those are not in the public tree. Use ./install.sh for setup and web/data/schema.sql for the database. Use the Founder / Developer tabs in the sidebar to filter this page.

    After the move of the app into web/, the public repository has three layers of tooling: a root launcher, the Next.js app's own npm scripts, and shared shell and Node helpers in ring/scripts/. The table maps what older guides told you to run to what exists now.

    Earlier docs saidUse now
    ./scripts/setup-dev.sh./install.sh (dev mode is the default)
    npm run setup:env (scripts/setup-env.js)./install.sh writes .env.local, or npm run setup:portal copies the template
    ./scripts/run-migration.shpsql -f web/data/schema.sql on a fresh database
    Ring CLI is enterprise-onlynpm run cli:install, then ring --help. See Ring CLI
    ring deploy prodring prod (Kubernetes only)

    What your developer gets for free

    One-command setup

    ./install.sh checks the machine, installs packages and writes your config and secrets file.

    Safe upgrades

    ring upgrade previews upstream Ring changes before anything touches your clone.

    Brand-safe config

    ring-config.json holds your brand. The tools never overwrite it without asking.

    Why it matters

    • Faster first run. A new developer can go from git clone to a running clone with one wizard, then one schema file.
    • Fewer surprises. This page lists which old commands are gone, so nobody loses a day chasing a script that does not exist.

    Recommended path

    Run the wizard, then apply the schema yourself.

    Manual path

    1. 1

      Config and env

      Set DB_BACKEND_MODE, the DB_* keys and AUTH_SECRET in .env.local.

    2. 2

      Database

      Create an empty database and apply data/schema.sql (flattened v4.1.0). Do not replay data/migrations/*.sql on an empty database.

    3. 3

      Check and run

    install.sh modes

    CommandWhat it does
    ./install.sh or ./install.sh devTen-step interactive setup: system check, global tools, clone config, ring-config.json, npm install, Firebase, OAuth, .env.local, optional DB, IDE
    ./install.sh --quickSame with defaults

    Known gaps

    Related documentation

    Related documentation

    Self-hosted deployment

    Next-step: take the clone you set up here to a production server.

    Local Setup

    Same-workflow: day-to-day local development once the tools are installed.

    OSS vs enterprise

    See-also: why some scripts in the repo only work inside Ringdom.

    1. Docs
    2. /Development
    3. /Community tooling
    Updated Oct 1, 20264 min listen

    Community tooling

    Status: install.sh, the ring CLI and the helpers in ring/scripts/ all ship publicly. Older docs pointed to scripts/setup-dev.sh, npm run setup:env and scripts/run-migration.sh. Those are not in the public tree. Use ./install.sh for setup and web/data/schema.sql for the database. Use the Founder / Developer tabs in the sidebar to filter this page.

    After the move of the app into web/, the public repository has three layers of tooling: a root launcher, the Next.js app's own npm scripts, and shared shell and Node helpers in ring/scripts/. The table maps what older guides told you to run to what exists now.

    Earlier docs saidUse now
    ./scripts/setup-dev.sh./install.sh (dev mode is the default)
    npm run setup:env (scripts/setup-env.js)./install.sh writes .env.local, or npm run setup:portal copies the template
    ./scripts/run-migration.shpsql -f web/data/schema.sql on a fresh database
    Ring CLI is enterprise-onlynpm run cli:install, then ring --help. See Ring CLI
    ring deploy prodring prod (Kubernetes only)

    What your developer gets for free

    One-command setup

    ./install.sh checks the machine, installs packages and writes your config and secrets file.

    Safe upgrades

    ring upgrade previews upstream Ring changes before anything touches your clone.

    Brand-safe config

    ring-config.json holds your brand. The tools never overwrite it without asking.

    Why it matters

    • Faster first run. A new developer can go from git clone to a running clone with one wizard, then one schema file.
    • Fewer surprises. This page lists which old commands are gone, so nobody loses a day chasing a script that does not exist.

    Recommended path

    Run the wizard, then apply the schema yourself.

    Manual path

    1. 1

      Config and env

      Set DB_BACKEND_MODE, the DB_* keys and AUTH_SECRET in .env.local.

    2. 2

      Database

      Create an empty database and apply data/schema.sql (flattened v4.1.0). Do not replay data/migrations/*.sql on an empty database.

    3. 3

      Check and run

    install.sh modes

    CommandWhat it does
    ./install.sh or ./install.sh devTen-step interactive setup: system check, global tools, clone config, ring-config.json, npm install, Firebase, OAuth, .env.local, optional DB, IDE
    ./install.sh --quickSame with defaults

    Known gaps

    Related documentation

    Related documentation

    Self-hosted deployment

    Next-step: take the clone you set up here to a production server.

    Local Setup

    Same-workflow: day-to-day local development once the tools are installed.

    OSS vs enterprise

    See-also: why some scripts in the repo only work inside Ringdom.

    1. Docs
    2. /Development
    3. /Community tooling
    Updated Oct 1, 20264 min listen

    Community tooling

    Status: install.sh, the ring CLI and the helpers in ring/scripts/ all ship publicly. Older docs pointed to scripts/setup-dev.sh, npm run setup:env and scripts/run-migration.sh. Those are not in the public tree. Use ./install.sh for setup and web/data/schema.sql for the database. Use the Founder / Developer tabs in the sidebar to filter this page.

    After the move of the app into web/, the public repository has three layers of tooling: a root launcher, the Next.js app's own npm scripts, and shared shell and Node helpers in ring/scripts/. The table maps what older guides told you to run to what exists now.

    Earlier docs saidUse now
    ./scripts/setup-dev.sh./install.sh (dev mode is the default)
    npm run setup:env (scripts/setup-env.js)./install.sh writes .env.local, or npm run setup:portal copies the template
    ./scripts/run-migration.shpsql -f web/data/schema.sql on a fresh database
    Ring CLI is enterprise-onlynpm run cli:install, then ring --help. See Ring CLI
    ring deploy prodring prod (Kubernetes only)

    What your developer gets for free

    One-command setup

    ./install.sh checks the machine, installs packages and writes your config and secrets file.

    Safe upgrades

    ring upgrade previews upstream Ring changes before anything touches your clone.

    Brand-safe config

    ring-config.json holds your brand. The tools never overwrite it without asking.

    Why it matters

    • Faster first run. A new developer can go from git clone to a running clone with one wizard, then one schema file.
    • Fewer surprises. This page lists which old commands are gone, so nobody loses a day chasing a script that does not exist.

    Recommended path

    Run the wizard, then apply the schema yourself.

    Manual path

    1. 1

      Config and env

      Set DB_BACKEND_MODE, the DB_* keys and AUTH_SECRET in .env.local.

    2. 2

      Database

      Create an empty database and apply data/schema.sql (flattened v4.1.0). Do not replay data/migrations/*.sql on an empty database.

    3. 3

      Check and run

    install.sh modes

    CommandWhat it does
    ./install.sh or ./install.sh devTen-step interactive setup: system check, global tools, clone config, ring-config.json, npm install, Firebase, OAuth, .env.local, optional DB, IDE
    ./install.sh --quickSame with defaults

    Known gaps

    Related documentation

    Related documentation

    Self-hosted deployment

    Next-step: take the clone you set up here to a production server.

    Local Setup

    Same-workflow: day-to-day local development once the tools are installed.

    OSS vs enterprise

    See-also: why some scripts in the repo only work inside Ringdom.

    1. Docs
    2. /Development
    3. /Community tooling
    Updated Oct 1, 20264 min listen
  1. Your changes survive upgrades. Upstream merges are previewed and never committed for you.
    2. ./install.sh prod
    Pick Vercel, Ubuntu over SSH, or Kubernetes (uses your own k8s/*.yaml)
    ./install.sh sync-urls --domain HOSTFix NEXT_PUBLIC_API_URL and AUTH_URL drift. --port for local
    ./install.sh setup-dbIntended to create the DB and apply schema.sql. Currently fails on public checkouts (see backlog)

    The root ring/install.sh only changes into web/ and runs web/install.sh.

    npm scripts that work (ring/web/package.json)

    ScriptTarget
    dev, build, startCustom server server.ts. build runs ensure:config and type-check first
    type-check, lint, test, test:coveragetsc, next lint, jest
    ensure:config, setup:portalscripts/ensure-ring-config.sh, template copy
    validate:fcm-env, validate:fcm-schemaFCM env and fcm_tokens JSONB checks
    db:flatten-schemaRebuild data/schema.sql from migrations (needs local Postgres)
    smoke:pipelinesscripts/run-all-smokes.sh
    cli:install, cli:devRing CLI
    check:org-leak, compose:shadowLayer 1 hygiene checks for contributors

    From the repo root, npm run dev, build and start delegate to web/ through scripts/run-web.sh.

    npm scripts to avoid

    These are still listed in web/package.json, but their target files are not in the repo, so they fail: setup, setup:env, setup:new, config:firebase, seed:opportunities, seed:portal, optimize:firebase, migrate:services, fix:service-migration, fix:compilation-errors, test:firebase-optimization, portal:health, portal:analytics. db:apply-schema and db:setup resolve, but they fail on a path mismatch.

    ci:layer1, push:layer1, push:forgejo, push:github-oss, setup:org-dx and merge:org-dev need Ringdom's private overlay and forge. They are not for community clones.

  2. Your changes survive upgrades. Upstream merges are previewed and never committed for you.
    3. ./install.sh prod
    Pick Vercel, Ubuntu over SSH, or Kubernetes (uses your own k8s/*.yaml)
    ./install.sh sync-urls --domain HOSTFix NEXT_PUBLIC_API_URL and AUTH_URL drift. --port for local
    ./install.sh setup-dbIntended to create the DB and apply schema.sql. Currently fails on public checkouts (see backlog)

    The root ring/install.sh only changes into web/ and runs web/install.sh.

    npm scripts that work (ring/web/package.json)

    ScriptTarget
    dev, build, startCustom server server.ts. build runs ensure:config and type-check first
    type-check, lint, test, test:coveragetsc, next lint, jest
    ensure:config, setup:portalscripts/ensure-ring-config.sh, template copy
    validate:fcm-env, validate:fcm-schemaFCM env and fcm_tokens JSONB checks
    db:flatten-schemaRebuild data/schema.sql from migrations (needs local Postgres)
    smoke:pipelinesscripts/run-all-smokes.sh
    cli:install, cli:devRing CLI
    check:org-leak, compose:shadowLayer 1 hygiene checks for contributors

    From the repo root, npm run dev, build and start delegate to web/ through scripts/run-web.sh.

    npm scripts to avoid

    These are still listed in web/package.json, but their target files are not in the repo, so they fail: setup, setup:env, setup:new, config:firebase, seed:opportunities, seed:portal, optimize:firebase, migrate:services, fix:service-migration, fix:compilation-errors, test:firebase-optimization, portal:health, portal:analytics. db:apply-schema and db:setup resolve, but they fail on a path mismatch.

    ci:layer1, push:layer1, push:forgejo, push:github-oss, setup:org-dx and merge:org-dev need Ringdom's private overlay and forge. They are not for community clones.

  3. Your changes survive upgrades. Upstream merges are previewed and never committed for you.
    4. ./install.sh prod
    Pick Vercel, Ubuntu over SSH, or Kubernetes (uses your own k8s/*.yaml)
    ./install.sh sync-urls --domain HOSTFix NEXT_PUBLIC_API_URL and AUTH_URL drift. --port for local
    ./install.sh setup-dbIntended to create the DB and apply schema.sql. Currently fails on public checkouts (see backlog)

    The root ring/install.sh only changes into web/ and runs web/install.sh.

    npm scripts that work (ring/web/package.json)

    ScriptTarget
    dev, build, startCustom server server.ts. build runs ensure:config and type-check first
    type-check, lint, test, test:coveragetsc, next lint, jest
    ensure:config, setup:portalscripts/ensure-ring-config.sh, template copy
    validate:fcm-env, validate:fcm-schemaFCM env and fcm_tokens JSONB checks
    db:flatten-schemaRebuild data/schema.sql from migrations (needs local Postgres)
    smoke:pipelinesscripts/run-all-smokes.sh
    cli:install, cli:devRing CLI
    check:org-leak, compose:shadowLayer 1 hygiene checks for contributors

    From the repo root, npm run dev, build and start delegate to web/ through scripts/run-web.sh.

    npm scripts to avoid

    These are still listed in web/package.json, but their target files are not in the repo, so they fail: setup, setup:env, setup:new, config:firebase, seed:opportunities, seed:portal, optimize:firebase, migrate:services, fix:service-migration, fix:compilation-errors, test:firebase-optimization, portal:health, portal:analytics. db:apply-schema and db:setup resolve, but they fail on a path mismatch.

    ci:layer1, push:layer1, push:forgejo, push:github-oss, setup:org-dx and merge:org-dev need Ringdom's private overlay and forge. They are not for community clones.