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

    Ring CLI

    Status: the Ring CLI ships in the public repository at cli/. Earlier docs said it was enterprise-only, and that is no longer true. upgrade, config and test work for any clone. prod and status expect a Kubernetes cluster you reach over SSH and manifests you supply. Use the Founder / Developer tabs in the sidebar to filter this page.

    The ring command is a small Node.js tool (commander, Node 18 or newer) that lives next to the app in the Layer 1 repo: ring/cli/ beside ring/web/. It handles three jobs: pulling upstream Ring updates into your clone, keeping a local deploy config, and rolling a Docker image onto Kubernetes.

    Earlier docs saidCurrent repo
    CLI is not in the public GitHub repocli/ is tracked at the repo root and published
    Use npm link then ring --versionRun npm run cli:install from web/, then ring --help
    ring deploy prodThe command is ring prod. There is no deploy subcommand
    Community uses scripts onlyCommunity can use ring upgrade for safe upstream merges

    What the CLI does for your clone

    Stay current

    ring upgrade previews which Ring system files changed upstream and merges them only when you say so.

    Self-host

    No cluster? Use install.sh and a plain Node or Docker host. The CLI is optional.

    Managed hosting

    Ringdom settlers get the build and deploy pipeline run for them.

    Typical scenarios

    1. You forked Ring months ago. Your developer runs ring upgrade to see what changed upstream, reviews the diff, then applies it. Nothing is committed automatically.
    2. You run your own Kubernetes. Your developer points the CLI at your control node, registry and namespace, then ships new versions with .

    Install

    1. 1

      Link the binary

    2. 2

      Point it at your infrastructure

      Config is stored in ~/.ring-platform.org/config.json and starts from defaults in cli/config.js.

    Commands (from cli/index.js)

    CommandWhat it doesMain options
    ring upgradeThree-way merge of upstream system files into your clone. Preview by default--apply, --repo <url>, --branch <name>, --force
    ring configRead and write ~/.ring-platform.org/config.json--set k=v, --get k, --list, --reset
    ring testDatabase and service checks--type db-connection|db-service|user-data|username

    Known gaps

    Related documentation

    Related documentation

    Community tooling

    Next-step: the full list of public setup scripts that sit beside the CLI.

    OSS vs enterprise

    See-also: which parts of the CLI pipeline only run inside Ringdom.

    Self-hosted deployment

    Same-workflow: deploying without Kubernetes, where the CLI is optional.

    1. Docs
    2. /Ring CLI
    Updated Oct 1, 20264 min listen

    Ring CLI

    Status: the Ring CLI ships in the public repository at cli/. Earlier docs said it was enterprise-only, and that is no longer true. upgrade, config and test work for any clone. prod and status expect a Kubernetes cluster you reach over SSH and manifests you supply. Use the Founder / Developer tabs in the sidebar to filter this page.

    The ring command is a small Node.js tool (commander, Node 18 or newer) that lives next to the app in the Layer 1 repo: ring/cli/ beside ring/web/. It handles three jobs: pulling upstream Ring updates into your clone, keeping a local deploy config, and rolling a Docker image onto Kubernetes.

    Earlier docs saidCurrent repo
    CLI is not in the public GitHub repocli/ is tracked at the repo root and published
    Use npm link then ring --versionRun npm run cli:install from web/, then ring --help
    ring deploy prodThe command is ring prod. There is no deploy subcommand
    Community uses scripts onlyCommunity can use ring upgrade for safe upstream merges

    What the CLI does for your clone

    Stay current

    ring upgrade previews which Ring system files changed upstream and merges them only when you say so.

    Self-host

    No cluster? Use install.sh and a plain Node or Docker host. The CLI is optional.

    Managed hosting

    Ringdom settlers get the build and deploy pipeline run for them.

    Typical scenarios

    1. You forked Ring months ago. Your developer runs ring upgrade to see what changed upstream, reviews the diff, then applies it. Nothing is committed automatically.
    2. You run your own Kubernetes. Your developer points the CLI at your control node, registry and namespace, then ships new versions with .

    Install

    1. 1

      Link the binary

    2. 2

      Point it at your infrastructure

      Config is stored in ~/.ring-platform.org/config.json and starts from defaults in cli/config.js.

    Commands (from cli/index.js)

    CommandWhat it doesMain options
    ring upgradeThree-way merge of upstream system files into your clone. Preview by default--apply, --repo <url>, --branch <name>, --force
    ring configRead and write ~/.ring-platform.org/config.json--set k=v, --get k, --list, --reset
    ring testDatabase and service checks--type db-connection|db-service|user-data|username

    Known gaps

    Related documentation

    Related documentation

    Community tooling

    Next-step: the full list of public setup scripts that sit beside the CLI.

    OSS vs enterprise

    See-also: which parts of the CLI pipeline only run inside Ringdom.

    Self-hosted deployment

    Same-workflow: deploying without Kubernetes, where the CLI is optional.

    1. Docs
    2. /Ring CLI
    Updated Oct 1, 20264 min listen

    Ring CLI

    Status: the Ring CLI ships in the public repository at cli/. Earlier docs said it was enterprise-only, and that is no longer true. upgrade, config and test work for any clone. prod and status expect a Kubernetes cluster you reach over SSH and manifests you supply. Use the Founder / Developer tabs in the sidebar to filter this page.

    The ring command is a small Node.js tool (commander, Node 18 or newer) that lives next to the app in the Layer 1 repo: ring/cli/ beside ring/web/. It handles three jobs: pulling upstream Ring updates into your clone, keeping a local deploy config, and rolling a Docker image onto Kubernetes.

    Earlier docs saidCurrent repo
    CLI is not in the public GitHub repocli/ is tracked at the repo root and published
    Use npm link then ring --versionRun npm run cli:install from web/, then ring --help
    ring deploy prodThe command is ring prod. There is no deploy subcommand
    Community uses scripts onlyCommunity can use ring upgrade for safe upstream merges

    What the CLI does for your clone

    Stay current

    ring upgrade previews which Ring system files changed upstream and merges them only when you say so.

    Self-host

    No cluster? Use install.sh and a plain Node or Docker host. The CLI is optional.

    Managed hosting

    Ringdom settlers get the build and deploy pipeline run for them.

    Typical scenarios

    1. You forked Ring months ago. Your developer runs ring upgrade to see what changed upstream, reviews the diff, then applies it. Nothing is committed automatically.
    2. You run your own Kubernetes. Your developer points the CLI at your control node, registry and namespace, then ships new versions with .

    Install

    1. 1

      Link the binary

    2. 2

      Point it at your infrastructure

      Config is stored in ~/.ring-platform.org/config.json and starts from defaults in cli/config.js.

    Commands (from cli/index.js)

    CommandWhat it doesMain options
    ring upgradeThree-way merge of upstream system files into your clone. Preview by default--apply, --repo <url>, --branch <name>, --force
    ring configRead and write ~/.ring-platform.org/config.json--set k=v, --get k, --list, --reset
    ring testDatabase and service checks--type db-connection|db-service|user-data|username

    Known gaps

    Related documentation

    Related documentation

    Community tooling

    Next-step: the full list of public setup scripts that sit beside the CLI.

    OSS vs enterprise

    See-also: which parts of the CLI pipeline only run inside Ringdom.

    Self-hosted deployment

    Same-workflow: deploying without Kubernetes, where the CLI is optional.

    1. Docs
    2. /Ring CLI
    Updated Oct 1, 20264 min listen
    ring prod
  1. You only need a single server. Skip the CLI. Follow the self-hosted guide.

    2. Out of the box, the CLI defaults point at Ringdom's own production cluster and registry. Ask your developer to set your own values with ring config before running prod or status.

    ring prod
    Docker build, push, kubectl apply, set image, rollout wait
    --deploy-version, --skip-build, --skip-push, --skip-deploy, --skip-manifest-apply, --apply-k8s-secrets, --dry-run
    ring statusPods, services and ingress over SSH, then GET {app.url}/api/healthnone

    ring prod also has --forge-buildkit and --from-forge. Both drive Ringdom's private builder and are not useful outside it.

    How ring upgrade works

    • Upstream: upgrade.repoUrl defaults to https://github.com/connectplatform/ring, branch main, remote name ring-upstream.
    • Base: the last synced upstream commit (upgrade.lastSyncedRef). Only files changed between base and upstream are touched.
    • Excludes: paths in .reggie-propagate-exclude.json are always skipped.
    • Safety: conflicts are left as standard git markers. Nothing is committed. History goes to .ring-upgrade-history.json at the git root.

    What ring prod needs

    InputWhere it comes from
    Image repositoryRING_DOCKER_REGISTRY / RING_DOCKER_NAMESPACE / RING_DOCKER_IMAGE (defaults: Ringdom registry)
    Manifestsweb/k8s/deployment.yaml, else k8s/ in the org overlay (cli/paths.js resolveK8sDir). Not in the public repo
    Cluster secrets--apply-k8s-secrets reads RING_K8S_SECRETS_YAML or k8s/secrets.yaml
    Build argsRING_CLI_SECRETS_PATH JSON (build_args)
    kubectl hostk8s.controlNode, or RING_K8S_SSH_HOST for one run

    Always run ring prod --dry-run first. It prints every build, push and kubectl command without running them.

    ring prod
  2. You only need a single server. Skip the CLI. Follow the self-hosted guide.

    3. Out of the box, the CLI defaults point at Ringdom's own production cluster and registry. Ask your developer to set your own values with ring config before running prod or status.

    ring prod
    Docker build, push, kubectl apply, set image, rollout wait
    --deploy-version, --skip-build, --skip-push, --skip-deploy, --skip-manifest-apply, --apply-k8s-secrets, --dry-run
    ring statusPods, services and ingress over SSH, then GET {app.url}/api/healthnone

    ring prod also has --forge-buildkit and --from-forge. Both drive Ringdom's private builder and are not useful outside it.

    How ring upgrade works

    • Upstream: upgrade.repoUrl defaults to https://github.com/connectplatform/ring, branch main, remote name ring-upstream.
    • Base: the last synced upstream commit (upgrade.lastSyncedRef). Only files changed between base and upstream are touched.
    • Excludes: paths in .reggie-propagate-exclude.json are always skipped.
    • Safety: conflicts are left as standard git markers. Nothing is committed. History goes to .ring-upgrade-history.json at the git root.

    What ring prod needs

    InputWhere it comes from
    Image repositoryRING_DOCKER_REGISTRY / RING_DOCKER_NAMESPACE / RING_DOCKER_IMAGE (defaults: Ringdom registry)
    Manifestsweb/k8s/deployment.yaml, else k8s/ in the org overlay (cli/paths.js resolveK8sDir). Not in the public repo
    Cluster secrets--apply-k8s-secrets reads RING_K8S_SECRETS_YAML or k8s/secrets.yaml
    Build argsRING_CLI_SECRETS_PATH JSON (build_args)
    kubectl hostk8s.controlNode, or RING_K8S_SSH_HOST for one run

    Always run ring prod --dry-run first. It prints every build, push and kubectl command without running them.

    ring prod
  3. You only need a single server. Skip the CLI. Follow the self-hosted guide.

    4. Out of the box, the CLI defaults point at Ringdom's own production cluster and registry. Ask your developer to set your own values with ring config before running prod or status.

    ring prod
    Docker build, push, kubectl apply, set image, rollout wait
    --deploy-version, --skip-build, --skip-push, --skip-deploy, --skip-manifest-apply, --apply-k8s-secrets, --dry-run
    ring statusPods, services and ingress over SSH, then GET {app.url}/api/healthnone

    ring prod also has --forge-buildkit and --from-forge. Both drive Ringdom's private builder and are not useful outside it.

    How ring upgrade works

    • Upstream: upgrade.repoUrl defaults to https://github.com/connectplatform/ring, branch main, remote name ring-upstream.
    • Base: the last synced upstream commit (upgrade.lastSyncedRef). Only files changed between base and upstream are touched.
    • Excludes: paths in .reggie-propagate-exclude.json are always skipped.
    • Safety: conflicts are left as standard git markers. Nothing is committed. History goes to .ring-upgrade-history.json at the git root.

    What ring prod needs

    InputWhere it comes from
    Image repositoryRING_DOCKER_REGISTRY / RING_DOCKER_NAMESPACE / RING_DOCKER_IMAGE (defaults: Ringdom registry)
    Manifestsweb/k8s/deployment.yaml, else k8s/ in the org overlay (cli/paths.js resolveK8sDir). Not in the public repo
    Cluster secrets--apply-k8s-secrets reads RING_K8S_SECRETS_YAML or k8s/secrets.yaml
    Build argsRING_CLI_SECRETS_PATH JSON (build_args)
    kubectl hostk8s.controlNode, or RING_K8S_SSH_HOST for one run

    Always run ring prod --dry-run first. It prints every build, push and kubectl command without running them.