Documentation

    Documentation

    Documentation

    Ring Platform Logo

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

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

    Ring Platform Logo

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

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

    Ring Platform Logo

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

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

    2. /
    3. /Prerequisites
    Updated Jun 22, 20263 min listen
    2. /
    3. /Prerequisites
    Updated Jun 22, 20263 min listen
    2. /
    3. /Prerequisites
    Updated Jun 22, 20263 min listen

    Concepts, value, and typical clone scenarios — less code.

    Welcome to Ring
    Quick Reference
    Getting Started
    Prerequisites
    Installation
    First Success Validation
    Next Steps
    Architecture
    Data Model
    Real Time
    Discovery Mutation Sync
    Security
    Backend Services
    k8s-postgres-fcm Mode
    Firebase Integration
    Features
    Authentication
    Email AI-CRM
    Entities
    Opportunities
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Tunnel Protocol
    Wallet & Credit System
    Multi-Vendor Store
    Referral Codes (Refcodes)
    Affiliate & Referral Enablement
    Payments Overview
    PaymentConductor
    SubscriptionConductor
    VideoConductor
    News Module - Digital Newspaper Experience
    Member Blogs
    Public Profile Pages
    Username Reservation System
    Scientific Editor
    Locale System
    Security & Compliance
    NFT Marketplace
    Token Staking System
    Performance Optimization Patterns
    Mobile Experience
    Wallet
    Wallet Security Tips
    API
    Authentication
    Email AI-CRM API
    Entities
    Opportunities
    Messaging API
    Notifications API
    Wallet API
    Store API
    Admin API
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Token Economics Setup
    Payment Gateway Integration
    Reference Ring deployments
    Branding
    Themes
    Web3
    Token launch jurisdictions
    Deployment
    Self-hosted deployment
    Vercel
    Docker
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Development
    Local Setup
    Code Structure
    Documentation components
    Community tooling
    Ring MCP Server
    Generative Images (ImageConductor)
    Autonomous Newsroom (Grok)
    OSS vs enterprise
    Whitelabel Navigation
    Best Practices
    Workflow
    Code Style
    Performance
    Testing
    Deployment
    Debugging
    Contributing
    MCP
    ring-image-create
    ring-video-create
    Examples
    Quick Start
    White Label
    Real World
    Integrations
    Ethereum wallets (Wagmi v3)

    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)

    Concepts, value, and typical clone scenarios — less code.

    Welcome to Ring
    Quick Reference
    Getting Started
    Prerequisites
    Installation
    First Success Validation
    Next Steps
    Architecture
    Data Model
    Real Time
    Discovery Mutation Sync
    Security
    Backend Services
    k8s-postgres-fcm Mode
    Firebase Integration
    Features
    Authentication
    Email AI-CRM
    Entities
    Opportunities
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Tunnel Protocol
    Wallet & Credit System
    Multi-Vendor Store
    Referral Codes (Refcodes)
    Affiliate & Referral Enablement
    Payments Overview
    PaymentConductor
    SubscriptionConductor
    VideoConductor
    News Module - Digital Newspaper Experience
    Member Blogs
    Public Profile Pages
    Username Reservation System
    Scientific Editor
    Locale System
    Security & Compliance
    NFT Marketplace
    Token Staking System
    Performance Optimization Patterns
    Mobile Experience
    Wallet
    Wallet Security Tips
    API
    Authentication
    Email AI-CRM API
    Entities
    Opportunities
    Messaging API
    Notifications API
    Wallet API
    Store API
    Admin API
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Token Economics Setup
    Payment Gateway Integration
    Reference Ring deployments
    Branding
    Themes
    Web3
    Token launch jurisdictions
    Deployment
    Self-hosted deployment
    Vercel
    Docker
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Development
    Local Setup
    Code Structure
    Documentation components
    Community tooling
    Ring MCP Server
    Generative Images (ImageConductor)
    Autonomous Newsroom (Grok)
    OSS vs enterprise
    Whitelabel Navigation
    Best Practices
    Workflow
    Code Style
    Performance
    Testing
    Deployment
    Debugging
    Contributing
    MCP
    ring-image-create
    ring-video-create
    Examples
    Quick Start
    White Label
    Real World
    Integrations
    Ethereum wallets (Wagmi v3)

    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)

    Concepts, value, and typical clone scenarios — less code.

    Welcome to Ring
    Quick Reference
    Getting Started
    Prerequisites
    Installation
    First Success Validation
    Next Steps
    Architecture
    Data Model
    Real Time
    Discovery Mutation Sync
    Security
    Backend Services
    k8s-postgres-fcm Mode
    Firebase Integration
    Features
    Authentication
    Email AI-CRM
    Entities
    Opportunities
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Tunnel Protocol
    Wallet & Credit System
    Multi-Vendor Store
    Referral Codes (Refcodes)
    Affiliate & Referral Enablement
    Payments Overview
    PaymentConductor
    SubscriptionConductor
    VideoConductor
    News Module - Digital Newspaper Experience
    Member Blogs
    Public Profile Pages
    Username Reservation System
    Scientific Editor
    Locale System
    Security & Compliance
    NFT Marketplace
    Token Staking System
    Performance Optimization Patterns
    Mobile Experience
    Wallet
    Wallet Security Tips
    API
    Authentication
    Email AI-CRM API
    Entities
    Opportunities
    Messaging API
    Notifications API
    Wallet API
    Store API
    Admin API
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Token Economics Setup
    Payment Gateway Integration
    Reference Ring deployments
    Branding
    Themes
    Web3
    Token launch jurisdictions
    Deployment
    Self-hosted deployment
    Vercel
    Docker
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Development
    Local Setup
    Code Structure
    Documentation components
    Community tooling
    Ring MCP Server
    Generative Images (ImageConductor)
    Autonomous Newsroom (Grok)
    OSS vs enterprise
    Whitelabel Navigation
    Best Practices
    Workflow
    Code Style
    Performance
    Testing
    Deployment
    Debugging
    Contributing
    MCP
    ring-image-create
    ring-video-create
    Examples
    Quick Start
    White Label
    Real World
    Integrations
    Ethereum wallets (Wagmi v3)

    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)
    Docs
    Getting Started
    Docs
    Getting Started
    Docs
    Getting Started

    Prerequisites

    Filter with Founder / Developer in the docs sidebar. This page lists what you need before Installation. Versions match INSTALL.md, install.sh, and env.local.template — not legacy Node 18 guidance.

    Ring Platform v1.6+ is a Next.js 16 + React 19 app with a mandatory DB_BACKEND_MODE. Production-parity local dev uses PostgreSQL-primary (k8s-postgres-fcm); Firestore-only (firebase-full) is a narrower prototype path.

    At a glance

    RequirementVerified baselineNotes
    Node.jsv20+ (install.sh check; v22+ recommended in INSTALL.md)Custom dev server: node --import tsx server.ts
    npm10+pnpm / yarn also work per installation guide
    GitAny recent versionClone connectplatform/ring
    PostgreSQL14+ (16 Docker image; 18 recommended for Homebrew dev)DB ring_platform, user ring_user
    PostGISOptionalLocation-heavy clones; safe to skip initially
    Disk / RAM~4 GB RAM, ~10 GB free disk for devFull monorepo + node_modules
    Ports3000 (app), 5432 (Postgres)Native WSS on same host via server.ts when self-hosted

    What founders need before ringizing

    You are preparing a white-label clone — branding in ring-config.json, secrets in .env.local, and (for production features) a Postgres database with schema applied.

    MVP vs production-ready

    Explore UI locally

    Node 20+, install.sh --quick, Postgres or short-lived firebase-full prototype — see Database selection.

    Production-parity clone

    Postgres-primary + data/schema.sql v4+ + kingdom migrations — required for store, PaymentConductor, News Kingdom depth.

    Sign-in for testers

    At least one Auth.js provider: Google OAuth, Apple, or Resend magic link ().

    Toolchain

    Node.js and package manager

    install.sh fails early if Node is below v20. Use nvm, fnm, or official installers — see INSTALL.md.

    PostgreSQL

    Default connection (from env.local.template):

    Quick Docker dev database (matches Installation):

    Apply data/schema.sql then kingdom migrations — Database migrations.

    Backend mode (required)

    Set DB_BACKEND_MODE before first boot:

    ValueWhen
    k8s-postgres-fcmDefault — Postgres app data + optional FCM push
    supabase-fcmPostgres on Supabase
    firebase-fullFirestore prototype only

    See Backend modes. is removed — do not document or set it.

    Next steps

    Installation

    install.sh, schema apply, npm run dev

    First success

    Smoke-test checklist after boot

    Troubleshooting

    Common install failures

    Prerequisites met? Continue to Installation.

    Prerequisites

    Filter with Founder / Developer in the docs sidebar. This page lists what you need before Installation. Versions match INSTALL.md, install.sh, and env.local.template — not legacy Node 18 guidance.

    Ring Platform v1.6+ is a Next.js 16 + React 19 app with a mandatory DB_BACKEND_MODE. Production-parity local dev uses PostgreSQL-primary (k8s-postgres-fcm); Firestore-only (firebase-full) is a narrower prototype path.

    At a glance

    RequirementVerified baselineNotes
    Node.jsv20+ (install.sh check; v22+ recommended in INSTALL.md)Custom dev server: node --import tsx server.ts
    npm10+pnpm / yarn also work per installation guide
    GitAny recent versionClone connectplatform/ring
    PostgreSQL14+ (16 Docker image; 18 recommended for Homebrew dev)DB ring_platform, user ring_user
    PostGISOptionalLocation-heavy clones; safe to skip initially
    Disk / RAM~4 GB RAM, ~10 GB free disk for devFull monorepo + node_modules
    Ports3000 (app), 5432 (Postgres)Native WSS on same host via server.ts when self-hosted

    What founders need before ringizing

    You are preparing a white-label clone — branding in ring-config.json, secrets in .env.local, and (for production features) a Postgres database with schema applied.

    MVP vs production-ready

    Explore UI locally

    Node 20+, install.sh --quick, Postgres or short-lived firebase-full prototype — see Database selection.

    Production-parity clone

    Postgres-primary + data/schema.sql v4+ + kingdom migrations — required for store, PaymentConductor, News Kingdom depth.

    Sign-in for testers

    At least one Auth.js provider: Google OAuth, Apple, or Resend magic link ().

    Toolchain

    Node.js and package manager

    install.sh fails early if Node is below v20. Use nvm, fnm, or official installers — see INSTALL.md.

    PostgreSQL

    Default connection (from env.local.template):

    Quick Docker dev database (matches Installation):

    Apply data/schema.sql then kingdom migrations — Database migrations.

    Backend mode (required)

    Set DB_BACKEND_MODE before first boot:

    ValueWhen
    k8s-postgres-fcmDefault — Postgres app data + optional FCM push
    supabase-fcmPostgres on Supabase
    firebase-fullFirestore prototype only

    See Backend modes. is removed — do not document or set it.

    Next steps

    Installation

    install.sh, schema apply, npm run dev

    First success

    Smoke-test checklist after boot

    Troubleshooting

    Common install failures

    Prerequisites met? Continue to Installation.

    Prerequisites

    Filter with Founder / Developer in the docs sidebar. This page lists what you need before Installation. Versions match INSTALL.md, install.sh, and env.local.template — not legacy Node 18 guidance.

    Ring Platform v1.6+ is a Next.js 16 + React 19 app with a mandatory DB_BACKEND_MODE. Production-parity local dev uses PostgreSQL-primary (k8s-postgres-fcm); Firestore-only (firebase-full) is a narrower prototype path.

    At a glance

    RequirementVerified baselineNotes
    Node.jsv20+ (install.sh check; v22+ recommended in INSTALL.md)Custom dev server: node --import tsx server.ts
    npm10+pnpm / yarn also work per installation guide
    GitAny recent versionClone connectplatform/ring
    PostgreSQL14+ (16 Docker image; 18 recommended for Homebrew dev)DB ring_platform, user ring_user
    PostGISOptionalLocation-heavy clones; safe to skip initially
    Disk / RAM~4 GB RAM, ~10 GB free disk for devFull monorepo + node_modules
    Ports3000 (app), 5432 (Postgres)Native WSS on same host via server.ts when self-hosted

    What founders need before ringizing

    You are preparing a white-label clone — branding in ring-config.json, secrets in .env.local, and (for production features) a Postgres database with schema applied.

    MVP vs production-ready

    Explore UI locally

    Node 20+, install.sh --quick, Postgres or short-lived firebase-full prototype — see Database selection.

    Production-parity clone

    Postgres-primary + data/schema.sql v4+ + kingdom migrations — required for store, PaymentConductor, News Kingdom depth.

    Sign-in for testers

    At least one Auth.js provider: Google OAuth, Apple, or Resend magic link ().

    Toolchain

    Node.js and package manager

    install.sh fails early if Node is below v20. Use nvm, fnm, or official installers — see INSTALL.md.

    PostgreSQL

    Default connection (from env.local.template):

    Quick Docker dev database (matches Installation):

    Apply data/schema.sql then kingdom migrations — Database migrations.

    Backend mode (required)

    Set DB_BACKEND_MODE before first boot:

    ValueWhen
    k8s-postgres-fcmDefault — Postgres app data + optional FCM push
    supabase-fcmPostgres on Supabase
    firebase-fullFirestore prototype only

    See Backend modes. is removed — do not document or set it.

    Next steps

    Installation

    install.sh, schema apply, npm run dev

    First success

    Smoke-test checklist after boot

    Troubleshooting

    Common install failures

    Prerequisites met? Continue to Installation.

    AUTH_RESEND_KEY

    Payments later

    WayForPay / Stripe credentials — not required for first npm run dev; add before checkout.

    Honest time budget

    PathTimeOutcome
    ./install.sh --quick + existing Postgres~20–40 minEnv scaffold; you still apply schema + OAuth
    Full Postgres-primary bootstrap45–90 minMatches ring-platform.org dev stack
    firebase-full prototype~15–30 minSkips ERP / conductor depth

    Ringdom-managed hosting skips most of this checklist — settlers receive a configured cluster. Self-hosters on GitHub follow this section (OSS vs enterprise).

    DATABASE_MODE

    Minimum environment variables

    Providers registered in auth.ts: Resend (when adapter + key), Google OAuth, Google One Tap (Credentials), Apple, wallet/crypto credentials. GitHub/Discord OAuth are not in the default auth.ts provider list.

    Optional for later features:

    • BLOB_READ_WRITE_TOKEN — Vercel Blob uploads
    • WAYFORPAY_* / STRIPE_* — PaymentConductor
    • NEXT_PUBLIC_FIREBASE_* + service account — FCM push (not Firestore DB on postgres-primary)
    • OPENAI_API_KEY / ANTHROPIC_API_KEY — AI matcher / Email CRM

    Never commit .env.local. See Environment configuration.

    Validation checklist

    1. 1

      System

    2. 2

      Database

    3. 3

      Health (after install)

      Expect "healthy" when AUTH_SECRET is set. See Monitoring.

    Optional: Docker-only stack

    Docker Compose can run the app + Redis; Postgres is often a separate container or host service. Monitoring profile adds Prometheus/Grafana — see caveats in Monitoring.

    AUTH_RESEND_KEY

    Payments later

    WayForPay / Stripe credentials — not required for first npm run dev; add before checkout.

    Honest time budget

    PathTimeOutcome
    ./install.sh --quick + existing Postgres~20–40 minEnv scaffold; you still apply schema + OAuth
    Full Postgres-primary bootstrap45–90 minMatches ring-platform.org dev stack
    firebase-full prototype~15–30 minSkips ERP / conductor depth

    Ringdom-managed hosting skips most of this checklist — settlers receive a configured cluster. Self-hosters on GitHub follow this section (OSS vs enterprise).

    DATABASE_MODE

    Minimum environment variables

    Providers registered in auth.ts: Resend (when adapter + key), Google OAuth, Google One Tap (Credentials), Apple, wallet/crypto credentials. GitHub/Discord OAuth are not in the default auth.ts provider list.

    Optional for later features:

    • BLOB_READ_WRITE_TOKEN — Vercel Blob uploads
    • WAYFORPAY_* / STRIPE_* — PaymentConductor
    • NEXT_PUBLIC_FIREBASE_* + service account — FCM push (not Firestore DB on postgres-primary)
    • OPENAI_API_KEY / ANTHROPIC_API_KEY — AI matcher / Email CRM

    Never commit .env.local. See Environment configuration.

    Validation checklist

    1. 1

      System

    2. 2

      Database

    3. 3

      Health (after install)

      Expect "healthy" when AUTH_SECRET is set. See Monitoring.

    Optional: Docker-only stack

    Docker Compose can run the app + Redis; Postgres is often a separate container or host service. Monitoring profile adds Prometheus/Grafana — see caveats in Monitoring.

    AUTH_RESEND_KEY

    Payments later

    WayForPay / Stripe credentials — not required for first npm run dev; add before checkout.

    Honest time budget

    PathTimeOutcome
    ./install.sh --quick + existing Postgres~20–40 minEnv scaffold; you still apply schema + OAuth
    Full Postgres-primary bootstrap45–90 minMatches ring-platform.org dev stack
    firebase-full prototype~15–30 minSkips ERP / conductor depth

    Ringdom-managed hosting skips most of this checklist — settlers receive a configured cluster. Self-hosters on GitHub follow this section (OSS vs enterprise).

    DATABASE_MODE

    Minimum environment variables

    Providers registered in auth.ts: Resend (when adapter + key), Google OAuth, Google One Tap (Credentials), Apple, wallet/crypto credentials. GitHub/Discord OAuth are not in the default auth.ts provider list.

    Optional for later features:

    • BLOB_READ_WRITE_TOKEN — Vercel Blob uploads
    • WAYFORPAY_* / STRIPE_* — PaymentConductor
    • NEXT_PUBLIC_FIREBASE_* + service account — FCM push (not Firestore DB on postgres-primary)
    • OPENAI_API_KEY / ANTHROPIC_API_KEY — AI matcher / Email CRM

    Never commit .env.local. See Environment configuration.

    Validation checklist

    1. 1

      System

    2. 2

      Database

    3. 3

      Health (after install)

      Expect "healthy" when AUTH_SECRET is set. See Monitoring.

    Optional: Docker-only stack

    Docker Compose can run the app + Redis; Postgres is often a separate container or host service. Monitoring profile adds Prometheus/Grafana — see caveats in Monitoring.