Documentation

    Documentation

    Documentation

    Ring Platform Logo

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

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

    Ring Platform Logo

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

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

    Ring Platform Logo

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

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

    1. /Customization

    Updated Jun 12, 20263 min listen

    1. /Customization

    Updated Jun 12, 20263 min listen

    1. /Customization

    Updated Jun 12, 20263 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
    Docs
    Docs

    Customization

    What this section is: Ring is a white-label platform — one open-source codebase, your brand, your domain. These docs are for operators and builders who run a clone (yourself or with Ringdom). They are not the Ringdom order flow.

    Two ways to get a clone

    How you get your Ring

    Free forever on GitHub

    Use when you control infrastructure (laptop, VPS, your k3s) and want the full source tree.

    StepAction
    1Quick Start — install.sh or manual clone + .env.local + Postgres
    2Customization guide — ring-config.json, locales, HomeWrapper
    3Self-hosted deployment — Docker / production process
    4Deep guides below — database, payments, tokens, AI

    Agentic setup: Manual clone pairs well with Cursor + LegioX — describe your vertical; the agent walks env.local.template, migrations, and ring-config.json. The bash installer automates the same baseline.

    What belongs in this section vs elsewhere

    DocPurpose
    This hubChoose OSS vs Ringdom; map of child guides
    Quick StartOSS only — local smoke test
    Customization guideAfter you have a clone (OSS or Ringdom) — brand, features, home, propagation
    ArchitectureHow Ring works internally
    LocalizationLocale env + locales/ SSOT
    Child pages belowDatabase mode, payments, tokens, white-label clones, AI, case studies

    Quick Start gets OSS developers running; the guides below are where every operator makes the platform theirs.

    Why customize Ring?

    AdvantageWhat it means
    Full product surfaceOpportunities, entities, store, messaging, news, wallet, admin — per-clone toggles
    Postgres-primaryDB_BACKEND_MODE=k8s-postgres-fcm; Firebase for FCM push, not primary SQL
    Config-firstring-config.json + env + locales/ before forking components
    PaymentConductorWayForPay, Stripe, ledger + webhooks
    Safe upgradesReggie propagate from ring-greenfood-live + .reggie-propagate-exclude.json

    Operator guides

    Quick Start (OSS)

    install.sh or manual clone — localhost smoke test

    Customization guide

    ring-config, HomeWrapper, locales, feature flags

    Database selection

    DB_BACKEND_MODE matrix — links to architecture SSOT

    Token economics

    UI customization

    Branding

    Logo, colors, typography

    Themes

    Tailwind CSS v4 tokens

    Feature toggles

    Enable/disable platform domains

    Localization

    Reference deployments

    CloneVertical
    ring-greenfood-liveAg marketplace — Reggie propagation source
    ring-vikka-uaRegional newsroom
    ring-zemna-aiScientific publishing + agent chat
    ring-petfriend-appMap marketplace, EN/UA
    ring-ring-ck-uaRegional IT opportunities
    ring-wellness-gov-uaHealthcare / civic
    ring-subiworx-comLocal services SMB
    ring-ringdom-orgEmpire hub + settler funnel

    OSS builders: Quick Start. Ringdom settlers: ringdom.org chat first, then Customization guide after handoff.

    Customization

    What this section is: Ring is a white-label platform — one open-source codebase, your brand, your domain. These docs are for operators and builders who run a clone (yourself or with Ringdom). They are not the Ringdom order flow.

    Two ways to get a clone

    How you get your Ring

    Free forever on GitHub

    Use when you control infrastructure (laptop, VPS, your k3s) and want the full source tree.

    StepAction
    1Quick Start — install.sh or manual clone + .env.local + Postgres
    2Customization guide — ring-config.json, locales, HomeWrapper
    3Self-hosted deployment — Docker / production process
    4Deep guides below — database, payments, tokens, AI

    Agentic setup: Manual clone pairs well with Cursor + LegioX — describe your vertical; the agent walks env.local.template, migrations, and ring-config.json. The bash installer automates the same baseline.

    What belongs in this section vs elsewhere

    DocPurpose
    This hubChoose OSS vs Ringdom; map of child guides
    Quick StartOSS only — local smoke test
    Customization guideAfter you have a clone (OSS or Ringdom) — brand, features, home, propagation
    ArchitectureHow Ring works internally
    LocalizationLocale env + locales/ SSOT
    Child pages belowDatabase mode, payments, tokens, white-label clones, AI, case studies

    Quick Start gets OSS developers running; the guides below are where every operator makes the platform theirs.

    Why customize Ring?

    AdvantageWhat it means
    Full product surfaceOpportunities, entities, store, messaging, news, wallet, admin — per-clone toggles
    Postgres-primaryDB_BACKEND_MODE=k8s-postgres-fcm; Firebase for FCM push, not primary SQL
    Config-firstring-config.json + env + locales/ before forking components
    PaymentConductorWayForPay, Stripe, ledger + webhooks
    Safe upgradesReggie propagate from ring-greenfood-live + .reggie-propagate-exclude.json

    Operator guides

    Quick Start (OSS)

    install.sh or manual clone — localhost smoke test

    Customization guide

    ring-config, HomeWrapper, locales, feature flags

    Database selection

    DB_BACKEND_MODE matrix — links to architecture SSOT

    Token economics

    UI customization

    Branding

    Logo, colors, typography

    Themes

    Tailwind CSS v4 tokens

    Feature toggles

    Enable/disable platform domains

    Localization

    Reference deployments

    CloneVertical
    ring-greenfood-liveAg marketplace — Reggie propagation source
    ring-vikka-uaRegional newsroom
    ring-zemna-aiScientific publishing + agent chat
    ring-petfriend-appMap marketplace, EN/UA
    ring-ring-ck-uaRegional IT opportunities
    ring-wellness-gov-uaHealthcare / civic
    ring-subiworx-comLocal services SMB
    ring-ringdom-orgEmpire hub + settler funnel

    OSS builders: Quick Start. Ringdom settlers: ringdom.org chat first, then Customization guide after handoff.

    Customization

    What this section is: Ring is a white-label platform — one open-source codebase, your brand, your domain. These docs are for operators and builders who run a clone (yourself or with Ringdom). They are not the Ringdom order flow.

    Two ways to get a clone

    How you get your Ring

    Free forever on GitHub

    Use when you control infrastructure (laptop, VPS, your k3s) and want the full source tree.

    StepAction
    1Quick Start — install.sh or manual clone + .env.local + Postgres
    2Customization guide — ring-config.json, locales, HomeWrapper
    3Self-hosted deployment — Docker / production process
    4Deep guides below — database, payments, tokens, AI

    Agentic setup: Manual clone pairs well with Cursor + LegioX — describe your vertical; the agent walks env.local.template, migrations, and ring-config.json. The bash installer automates the same baseline.

    What belongs in this section vs elsewhere

    DocPurpose
    This hubChoose OSS vs Ringdom; map of child guides
    Quick StartOSS only — local smoke test
    Customization guideAfter you have a clone (OSS or Ringdom) — brand, features, home, propagation
    ArchitectureHow Ring works internally
    LocalizationLocale env + locales/ SSOT
    Child pages belowDatabase mode, payments, tokens, white-label clones, AI, case studies

    Quick Start gets OSS developers running; the guides below are where every operator makes the platform theirs.

    Why customize Ring?

    AdvantageWhat it means
    Full product surfaceOpportunities, entities, store, messaging, news, wallet, admin — per-clone toggles
    Postgres-primaryDB_BACKEND_MODE=k8s-postgres-fcm; Firebase for FCM push, not primary SQL
    Config-firstring-config.json + env + locales/ before forking components
    PaymentConductorWayForPay, Stripe, ledger + webhooks
    Safe upgradesReggie propagate from ring-greenfood-live + .reggie-propagate-exclude.json

    Operator guides

    Quick Start (OSS)

    install.sh or manual clone — localhost smoke test

    Customization guide

    ring-config, HomeWrapper, locales, feature flags

    Database selection

    DB_BACKEND_MODE matrix — links to architecture SSOT

    Token economics

    UI customization

    Branding

    Logo, colors, typography

    Themes

    Tailwind CSS v4 tokens

    Feature toggles

    Enable/disable platform domains

    Localization

    Reference deployments

    CloneVertical
    ring-greenfood-liveAg marketplace — Reggie propagation source
    ring-vikka-uaRegional newsroom
    ring-zemna-aiScientific publishing + agent chat
    ring-petfriend-appMap marketplace, EN/UA
    ring-ring-ck-uaRegional IT opportunities
    ring-wellness-gov-uaHealthcare / civic
    ring-subiworx-comLocal services SMB
    ring-ringdom-orgEmpire hub + settler funnel

    OSS builders: Quick Start. Ringdom settlers: ringdom.org chat first, then Customization guide after handoff.

    RING contracts, membership, treasury

    Token launch jurisdictions

    EU MiCA, US, UK, Ukraine, FATF — official sources

    Payment integration

    WayForPay, Stripe, PaymentConductor

    Quick Start (new clone)

    One deployment per organization — Ringdom default

    AI customization

    Matcher tuning, agent costs

    Reference deployments

    Named Ringdom clones — verticals and live links (no fabricated KPIs)

    Add languages and locale SSOT

    Components

    Safe UI overrides

    RING contracts, membership, treasury

    Token launch jurisdictions

    EU MiCA, US, UK, Ukraine, FATF — official sources

    Payment integration

    WayForPay, Stripe, PaymentConductor

    Quick Start (new clone)

    One deployment per organization — Ringdom default

    AI customization

    Matcher tuning, agent costs

    Reference deployments

    Named Ringdom clones — verticals and live links (no fabricated KPIs)

    Add languages and locale SSOT

    Components

    Safe UI overrides

    RING contracts, membership, treasury

    Token launch jurisdictions

    EU MiCA, US, UK, Ukraine, FATF — official sources

    Payment integration

    WayForPay, Stripe, PaymentConductor

    Quick Start (new clone)

    One deployment per organization — Ringdom default

    AI customization

    Matcher tuning, agent costs

    Reference deployments

    Named Ringdom clones — verticals and live links (no fabricated KPIs)

    Add languages and locale SSOT

    Components

    Safe UI overrides