Documentation

    Documentation

    Documentation

    Ring Platform Logo

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

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

    Ring Platform Logo

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

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

    Ring Platform Logo

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

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

    2. /
    3. /Quick Start — Your First Ring Clone
    Updated Jun 12, 20262 min listen
    2. /
    3. /Quick Start — Your First Ring Clone
    Updated Jun 12, 20262 min listen
    2. /
    3. /Quick Start — Your First Ring Clone
    Updated Jun 12, 20262 min listen

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

    Welcome to Ring
    Quick Reference
    Getting Started
    Prerequisites
    Installation
    Database migrations
    First Success Validation
    Troubleshooting
    Next Steps
    Architecture
    Backend modes and databases
    Data Model
    Authentication Architecture
    Email AI-CRM architecture
    PaymentConductor architecture
    Refcodes architecture
    News Kingdom architecture
    Proxy and internationalization
    Real Time
    Discovery Mutation Sync
    Security
    Features
    Doc System
    Authentication
    Email AI-CRM
    Entities
    Opportunities
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Tunnel Protocol
    Web3 Wallet
    Multi-Vendor Store
    Inventory & Stock
    Vendor Management
    Commissions & Settlements
    Referral Codes (Refcodes)
    Affiliate & Referral Enablement
    Payment Integration
    PaymentConductor
    VideoConductor
    WayForPay Payment Integration
    News Module - Digital Newspaper Experience
    Member Blogs
    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
    CLI
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Database Backend Selection
    Token Economics Setup
    Payment Gateway Integration
    AI Agent Customization
    Reference Ring deployments
    Branding
    Features
    Localization
    Themes
    Components
    Web3
    Token launch jurisdictions
    Deployment
    Self-hosted deployment
    Vercel
    Docker
    Environment Configuration
    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
    Roadmap
    Examples
    Quick Start
    Authentication
    Email AI-CRM developer guide
    API Integration Examples
    Web3 Integration
    White Label
    Real World
    API Examples (cURL)
    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
    Database migrations
    First Success Validation
    Troubleshooting
    Next Steps
    Architecture
    Backend modes and databases
    Data Model
    Authentication Architecture
    Email AI-CRM architecture
    PaymentConductor architecture
    Refcodes architecture
    News Kingdom architecture
    Proxy and internationalization
    Real Time
    Discovery Mutation Sync
    Security
    Features
    Doc System
    Authentication
    Email AI-CRM
    Entities
    Opportunities
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Tunnel Protocol
    Web3 Wallet
    Multi-Vendor Store
    Inventory & Stock
    Vendor Management
    Commissions & Settlements
    Referral Codes (Refcodes)
    Affiliate & Referral Enablement
    Payment Integration
    PaymentConductor
    VideoConductor
    WayForPay Payment Integration
    News Module - Digital Newspaper Experience
    Member Blogs
    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
    CLI
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Database Backend Selection
    Token Economics Setup
    Payment Gateway Integration
    AI Agent Customization
    Reference Ring deployments
    Branding
    Features
    Localization
    Themes
    Components
    Web3
    Token launch jurisdictions
    Deployment
    Self-hosted deployment
    Vercel
    Docker
    Environment Configuration
    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
    Roadmap
    Examples
    Quick Start
    Authentication
    Email AI-CRM developer guide
    API Integration Examples
    Web3 Integration
    White Label
    Real World
    API Examples (cURL)
    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
    Database migrations
    First Success Validation
    Troubleshooting
    Next Steps
    Architecture
    Backend modes and databases
    Data Model
    Authentication Architecture
    Email AI-CRM architecture
    PaymentConductor architecture
    Refcodes architecture
    News Kingdom architecture
    Proxy and internationalization
    Real Time
    Discovery Mutation Sync
    Security
    Features
    Doc System
    Authentication
    Email AI-CRM
    Entities
    Opportunities
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Tunnel Protocol
    Web3 Wallet
    Multi-Vendor Store
    Inventory & Stock
    Vendor Management
    Commissions & Settlements
    Referral Codes (Refcodes)
    Affiliate & Referral Enablement
    Payment Integration
    PaymentConductor
    VideoConductor
    WayForPay Payment Integration
    News Module - Digital Newspaper Experience
    Member Blogs
    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
    CLI
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Database Backend Selection
    Token Economics Setup
    Payment Gateway Integration
    AI Agent Customization
    Reference Ring deployments
    Branding
    Features
    Localization
    Themes
    Components
    Web3
    Token launch jurisdictions
    Deployment
    Self-hosted deployment
    Vercel
    Docker
    Environment Configuration
    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
    Roadmap
    Examples
    Quick Start
    Authentication
    Email AI-CRM developer guide
    API Integration Examples
    Web3 Integration
    White Label
    Real World
    API Examples (cURL)
    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
    Customization
    Docs
    Customization
    Docs
    Customization

    Quick Start: Your First Ring Clone

    OSS self-host only

    Ringdom-managed hosting? ringdom.org — describe your platform in the homepage chat. After handoff use Customization guide.

    Time: 45–90 minutes · Prerequisites: Git, Node.js 20+, Docker optional for Postgres.

    OutcomeDetails
    Local apphttp://localhost:3000 via HomeWrapper
    BackendDB_BACKEND_MODE=k8s-postgres-fcm + PostgreSQL
    AuthAuth.js v5 — AUTH_SECRET + one OAuth provider
    Schemadata/schema.sql v4+ and kingdom migrations
    Configring-config.json + .env.local
    First-clone setup flow

    Recommended — from a fresh directory:

    install.sh v2.0:

    • Creates ring-config.json from template
    • Copies env.local.template → .env.local (includes DB_BACKEND_MODE=k8s-postgres-fcm)
    • Generates AUTH_SECRET / wallet keys
    • Runs npm install

    Flags: --clone-name my-ring, --quick, --help. See INSTALL.md.

    Smoke-test checklist

    • Home — locales/{locale}/pages.json → pages.home
    • /login — OAuth works
    • /entities, /opportunities — no DB adapter errors
    • npm run type-check passes

    Production outline

    1. 1

      Self-hosted deployment — Docker or npm run build && npm start.

    2. 2

      Environment — PaymentConductor, FCM, PSP keys.

    3. 3

      Ringdom settlers: ringdom.org chat — skip this Quick Start.

    Not recommended for full v1.6: Vercel + firebase-full only. Production default: k8s-postgres-fcm on your cluster.

    Customization guide

    Branding, HomeWrapper, locales

    Database selection

    DB_BACKEND_MODE matrix

    Payment integration

    PaymentConductor setup

    Architecture hub

    Clone running? Edit ring-config.json and locales/en/pages.json, then .reggie-propagate-exclude.json before Reggie propagation.

    Quick Start: Your First Ring Clone

    OSS self-host only

    Ringdom-managed hosting? ringdom.org — describe your platform in the homepage chat. After handoff use Customization guide.

    Time: 45–90 minutes · Prerequisites: Git, Node.js 20+, Docker optional for Postgres.

    OutcomeDetails
    Local apphttp://localhost:3000 via HomeWrapper
    BackendDB_BACKEND_MODE=k8s-postgres-fcm + PostgreSQL
    AuthAuth.js v5 — AUTH_SECRET + one OAuth provider
    Schemadata/schema.sql v4+ and kingdom migrations
    Configring-config.json + .env.local
    First-clone setup flow

    Recommended — from a fresh directory:

    install.sh v2.0:

    • Creates ring-config.json from template
    • Copies env.local.template → .env.local (includes DB_BACKEND_MODE=k8s-postgres-fcm)
    • Generates AUTH_SECRET / wallet keys
    • Runs npm install

    Flags: --clone-name my-ring, --quick, --help. See INSTALL.md.

    Smoke-test checklist

    • Home — locales/{locale}/pages.json → pages.home
    • /login — OAuth works
    • /entities, /opportunities — no DB adapter errors
    • npm run type-check passes

    Production outline

    1. 1

      Self-hosted deployment — Docker or npm run build && npm start.

    2. 2

      Environment — PaymentConductor, FCM, PSP keys.

    3. 3

      Ringdom settlers: ringdom.org chat — skip this Quick Start.

    Not recommended for full v1.6: Vercel + firebase-full only. Production default: k8s-postgres-fcm on your cluster.

    Customization guide

    Branding, HomeWrapper, locales

    Database selection

    DB_BACKEND_MODE matrix

    Payment integration

    PaymentConductor setup

    Architecture hub

    Clone running? Edit ring-config.json and locales/en/pages.json, then .reggie-propagate-exclude.json before Reggie propagation.

    Quick Start: Your First Ring Clone

    OSS self-host only

    Ringdom-managed hosting? ringdom.org — describe your platform in the homepage chat. After handoff use Customization guide.

    Time: 45–90 minutes · Prerequisites: Git, Node.js 20+, Docker optional for Postgres.

    OutcomeDetails
    Local apphttp://localhost:3000 via HomeWrapper
    BackendDB_BACKEND_MODE=k8s-postgres-fcm + PostgreSQL
    AuthAuth.js v5 — AUTH_SECRET + one OAuth provider
    Schemadata/schema.sql v4+ and kingdom migrations
    Configring-config.json + .env.local
    First-clone setup flow

    Recommended — from a fresh directory:

    install.sh v2.0:

    • Creates ring-config.json from template
    • Copies env.local.template → .env.local (includes DB_BACKEND_MODE=k8s-postgres-fcm)
    • Generates AUTH_SECRET / wallet keys
    • Runs npm install

    Flags: --clone-name my-ring, --quick, --help. See INSTALL.md.

    Smoke-test checklist

    • Home — locales/{locale}/pages.json → pages.home
    • /login — OAuth works
    • /entities, /opportunities — no DB adapter errors
    • npm run type-check passes

    Production outline

    1. 1

      Self-hosted deployment — Docker or npm run build && npm start.

    2. 2

      Environment — PaymentConductor, FCM, PSP keys.

    3. 3

      Ringdom settlers: ringdom.org chat — skip this Quick Start.

    Not recommended for full v1.6: Vercel + firebase-full only. Production default: k8s-postgres-fcm on your cluster.

    Customization guide

    Branding, HomeWrapper, locales

    Database selection

    DB_BACKEND_MODE matrix

    Payment integration

    PaymentConductor setup

    Architecture hub

    Clone running? Edit ring-config.json and locales/en/pages.json, then .reggie-propagate-exclude.json before Reggie propagation.

    System internals

    System internals

    System internals