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
    Payments Overview
    Public Pools & DAO Jars
    WayForPay Payment Integration
    Wallet & Credit System
    WalletConductor
    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
    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
    Branding
    Themes
    Features
    Localization
    Token Economics Setup
    Payment Gateway Integration
    Reference Ring deployments
    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
    Docker
    Environment Configuration
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Architecture
    Data Model
    Security
    Real Time
    Discovery Mutation Sync
    PaymentConductor architecture
    WalletConductor architecture
    Development
    Ring MCP Server

    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
    Payments Overview
    Public Pools & DAO Jars
    WayForPay Payment Integration
    Wallet & Credit System
    WalletConductor
    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
    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
    Branding
    Themes
    Features
    Localization
    Token Economics Setup
    Payment Gateway Integration
    Reference Ring deployments
    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
    Docker
    Environment Configuration
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Architecture
    Data Model
    Security
    Real Time
    Discovery Mutation Sync
    PaymentConductor architecture
    WalletConductor architecture
    Development
    Ring MCP Server

    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
    Payments Overview
    Public Pools & DAO Jars
    WayForPay Payment Integration
    Wallet & Credit System
    WalletConductor
    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
    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
    Branding
    Themes
    Features
    Localization
    Token Economics Setup
    Payment Gateway Integration
    Reference Ring deployments
    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
    Docker
    Environment Configuration
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Architecture
    Data Model
    Security
    Real Time
    Discovery Mutation Sync
    PaymentConductor architecture
    WalletConductor architecture
    Development
    Ring MCP Server

    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)
    1. Docs
    2. /Getting Started
    3. /First Success Validation

    Updated Jun 22, 20264 min listen

    Ring Platform Logo

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

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

    1. Docs
    2. /Getting Started
    3. /First Success Validation

    Updated Jun 22, 20264 min listen

    Ring Platform Logo

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

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

    1. Docs
    2. /Getting Started
    3. /First Success Validation

    Updated Jun 22, 20264 min listen

    Ring Platform Logo

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

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

    First Success Validation

    Filter with Founder / Developer in the docs sidebar. Run this after Installation and Migrations. Estimated time: 10–15 minutes for core checks; Web3 and payments are optional follow-ups.

    First success means the dev server serves pages, Auth.js can establish a session, DatabaseService reads/writes without adapter errors, and core marketplace routes load. It does not require WayForPay, FCM, or wallet connectivity on day one.

    Success levels

    LevelCriteriaGood enough to…
    CoreHomepage + /api/health + sign-in + one CRUD pathCustomize branding, invite testers
    ExtendedTunnel test ready, entities + opportunities UIDemo realtime notifications
    OptionalWallet balance, Web3 connect, payments sandboxToken / checkout features

    What founders should validate

    Before showing the clone to stakeholders, confirm the happy path a member would take:

    Land on the homepage

    No blank screen or “database adapter” errors in the terminal.

    Sign in

    Google, Apple, or Ring Mailer OTP / magic link — whichever you configured (SMTP or Ethereal).

    Create an entity

    Proves Postgres JSONB writes and your role gates work.

    Browse opportunities

    Smoke-test procedure

    Checklist summary

    CheckPass?
    npm run dev starts without DB adapter crash☐
    GET /api/health → healthy or fix AUTH_SECRET☐
    Sign-in completes for one Auth.js provider☐
    Entity create/list works in UI☐
    Opportunities list loads☐
    GET /api/tunnel/test → status: ready☐

    Next steps

    Customize branding

    ring-config.json and themes after smoke pass.

    Next steps hub

    Feature exploration and deployment pointers.

    Monitoring

    Wire health checks and analytics after deploy.

    Troubleshooting

    Common auth and database fixes.

    Core checks green? Explore features with Welcome or open the admin analytics path once you have an admin account (Monitoring).

    First Success Validation

    Filter with Founder / Developer in the docs sidebar. Run this after Installation and Migrations. Estimated time: 10–15 minutes for core checks; Web3 and payments are optional follow-ups.

    First success means the dev server serves pages, Auth.js can establish a session, DatabaseService reads/writes without adapter errors, and core marketplace routes load. It does not require WayForPay, FCM, or wallet connectivity on day one.

    Success levels

    LevelCriteriaGood enough to…
    CoreHomepage + /api/health + sign-in + one CRUD pathCustomize branding, invite testers
    ExtendedTunnel test ready, entities + opportunities UIDemo realtime notifications
    OptionalWallet balance, Web3 connect, payments sandboxToken / checkout features

    What founders should validate

    Before showing the clone to stakeholders, confirm the happy path a member would take:

    Land on the homepage

    No blank screen or “database adapter” errors in the terminal.

    Sign in

    Google, Apple, or Ring Mailer OTP / magic link — whichever you configured (SMTP or Ethereal).

    Create an entity

    Proves Postgres JSONB writes and your role gates work.

    Browse opportunities

    Smoke-test procedure

    Checklist summary

    CheckPass?
    npm run dev starts without DB adapter crash☐
    GET /api/health → healthy or fix AUTH_SECRET☐
    Sign-in completes for one Auth.js provider☐
    Entity create/list works in UI☐
    Opportunities list loads☐
    GET /api/tunnel/test → status: ready☐

    Next steps

    Customize branding

    ring-config.json and themes after smoke pass.

    Next steps hub

    Feature exploration and deployment pointers.

    Monitoring

    Wire health checks and analytics after deploy.

    Troubleshooting

    Common auth and database fixes.

    Core checks green? Explore features with Welcome or open the admin analytics path once you have an admin account (Monitoring).

    First Success Validation

    Filter with Founder / Developer in the docs sidebar. Run this after Installation and Migrations. Estimated time: 10–15 minutes for core checks; Web3 and payments are optional follow-ups.

    First success means the dev server serves pages, Auth.js can establish a session, DatabaseService reads/writes without adapter errors, and core marketplace routes load. It does not require WayForPay, FCM, or wallet connectivity on day one.

    Success levels

    LevelCriteriaGood enough to…
    CoreHomepage + /api/health + sign-in + one CRUD pathCustomize branding, invite testers
    ExtendedTunnel test ready, entities + opportunities UIDemo realtime notifications
    OptionalWallet balance, Web3 connect, payments sandboxToken / checkout features

    What founders should validate

    Before showing the clone to stakeholders, confirm the happy path a member would take:

    Land on the homepage

    No blank screen or “database adapter” errors in the terminal.

    Sign in

    Google, Apple, or Ring Mailer OTP / magic link — whichever you configured (SMTP or Ethereal).

    Create an entity

    Proves Postgres JSONB writes and your role gates work.

    Browse opportunities

    Smoke-test procedure

    Checklist summary

    CheckPass?
    npm run dev starts without DB adapter crash☐
    GET /api/health → healthy or fix AUTH_SECRET☐
    Sign-in completes for one Auth.js provider☐
    Entity create/list works in UI☐
    Opportunities list loads☐
    GET /api/tunnel/test → status: ready☐

    Next steps

    Customize branding

    ring-config.json and themes after smoke pass.

    Next steps hub

    Feature exploration and deployment pointers.

    Monitoring

    Wire health checks and analytics after deploy.

    Troubleshooting

    Common auth and database fixes.

    Core checks green? Explore features with Welcome or open the admin analytics path once you have an admin account (Monitoring).

    Confirms list pages and discovery caches are wired.

    Partial success is OK

    If auth and one CRUD flow work but push notifications or wallet are not configured yet, you still have a valid dev clone. Add FCM and PaymentConductor before production checkout (Environment).

    When to stop and fix

    • Terminal shows repeated Postgres connection failures → revisit Prerequisites DB_* vars.
    • Login redirects loop → AUTH_SECRET and OAuth redirect URIs (http://localhost:3000/api/auth/callback/google).
    • Entity save fails with 403 → expected for visitor role; sign in as member or adjust test account role.
    1. 1

      1 — Dev server

      Expect Next.js ready on http://localhost:3000. Custom server.ts may log native WSS when RING_DEPLOY_TARGET=self-hosted.

    2. 2

      2 — Health endpoint

      Real shape (app/api/health/route.ts): status is healthy | degraded | unhealthy (not "ok"). services.database is postgresql or firebase. Missing AUTH_SECRET → degraded and HTTP 503.

    3. 3

      3 — Homepage

      Expect 200. Open in browser; check console for red errors (ignore dev-only Auth.js JWT noise documented in lib/logger.ts filters).

    4. 4

      4 — Authentication

      1. Visit /login (locale prefix may apply: /en/login).
      2. Complete one configured provider from auth.ts: Google OAuth, Apple, Ring Mailer (OTP / magic link), Google One Tap, or crypto wallet — not GitHub/Discord (not in default provider list).
      3. Confirm session: /profile shows user data; refresh persists session.

      Optional: GET /api/auth/session with browser cookies returns { user: { id, email, role, … } }.

    5. 5

      5 — PostgreSQL (postgres-primary)

      Expect count ≥ 1 after first sign-in. No /api/test-db route in this tree — use psql or authenticated API calls.

    6. 6

      6 — Authenticated APIs

      /api/entities and /api/opportunities require a session — 401 without cookies is expected.

      After browser login, DevTools → copy session cookie, or test in UI:

      1. /entities — list + create entity form submits.
      2. /opportunities — list loads for your role.
    7. 7

      7 — Tunnel readiness

      Expect "ready" and provider list from lib/tunnel/config. For live SSE: Network tab → /api/tunnel/sse after sign-in. See Tunnel protocol.

    8. 8

      8 — Optional checks

      CheckCommand / actionExpected
      TypeScriptnpm run type-checkExit 0
      Wallet APIGET /api/wallet/balance (logged in){ balance } or 404 until wallet created
      Buildnpm run buildCompletes (runs type-check by default)
    First-success flow

    Confirms list pages and discovery caches are wired.

    Partial success is OK

    If auth and one CRUD flow work but push notifications or wallet are not configured yet, you still have a valid dev clone. Add FCM and PaymentConductor before production checkout (Environment).

    When to stop and fix

    • Terminal shows repeated Postgres connection failures → revisit Prerequisites DB_* vars.
    • Login redirects loop → AUTH_SECRET and OAuth redirect URIs (http://localhost:3000/api/auth/callback/google).
    • Entity save fails with 403 → expected for visitor role; sign in as member or adjust test account role.
    1. 1

      1 — Dev server

      Expect Next.js ready on http://localhost:3000. Custom server.ts may log native WSS when RING_DEPLOY_TARGET=self-hosted.

    2. 2

      2 — Health endpoint

      Real shape (app/api/health/route.ts): status is healthy | degraded | unhealthy (not "ok"). services.database is postgresql or firebase. Missing AUTH_SECRET → degraded and HTTP 503.

    3. 3

      3 — Homepage

      Expect 200. Open in browser; check console for red errors (ignore dev-only Auth.js JWT noise documented in lib/logger.ts filters).

    4. 4

      4 — Authentication

      1. Visit /login (locale prefix may apply: /en/login).
      2. Complete one configured provider from auth.ts: Google OAuth, Apple, Ring Mailer (OTP / magic link), Google One Tap, or crypto wallet — not GitHub/Discord (not in default provider list).
      3. Confirm session: /profile shows user data; refresh persists session.

      Optional: GET /api/auth/session with browser cookies returns { user: { id, email, role, … } }.

    5. 5

      5 — PostgreSQL (postgres-primary)

      Expect count ≥ 1 after first sign-in. No /api/test-db route in this tree — use psql or authenticated API calls.

    6. 6

      6 — Authenticated APIs

      /api/entities and /api/opportunities require a session — 401 without cookies is expected.

      After browser login, DevTools → copy session cookie, or test in UI:

      1. /entities — list + create entity form submits.
      2. /opportunities — list loads for your role.
    7. 7

      7 — Tunnel readiness

      Expect "ready" and provider list from lib/tunnel/config. For live SSE: Network tab → /api/tunnel/sse after sign-in. See Tunnel protocol.

    8. 8

      8 — Optional checks

      CheckCommand / actionExpected
      TypeScriptnpm run type-checkExit 0
      Wallet APIGET /api/wallet/balance (logged in){ balance } or 404 until wallet created
      Buildnpm run buildCompletes (runs type-check by default)
    First-success flow

    Confirms list pages and discovery caches are wired.

    Partial success is OK

    If auth and one CRUD flow work but push notifications or wallet are not configured yet, you still have a valid dev clone. Add FCM and PaymentConductor before production checkout (Environment).

    When to stop and fix

    • Terminal shows repeated Postgres connection failures → revisit Prerequisites DB_* vars.
    • Login redirects loop → AUTH_SECRET and OAuth redirect URIs (http://localhost:3000/api/auth/callback/google).
    • Entity save fails with 403 → expected for visitor role; sign in as member or adjust test account role.
    1. 1

      1 — Dev server

      Expect Next.js ready on http://localhost:3000. Custom server.ts may log native WSS when RING_DEPLOY_TARGET=self-hosted.

    2. 2

      2 — Health endpoint

      Real shape (app/api/health/route.ts): status is healthy | degraded | unhealthy (not "ok"). services.database is postgresql or firebase. Missing AUTH_SECRET → degraded and HTTP 503.

    3. 3

      3 — Homepage

      Expect 200. Open in browser; check console for red errors (ignore dev-only Auth.js JWT noise documented in lib/logger.ts filters).

    4. 4

      4 — Authentication

      1. Visit /login (locale prefix may apply: /en/login).
      2. Complete one configured provider from auth.ts: Google OAuth, Apple, Ring Mailer (OTP / magic link), Google One Tap, or crypto wallet — not GitHub/Discord (not in default provider list).
      3. Confirm session: /profile shows user data; refresh persists session.

      Optional: GET /api/auth/session with browser cookies returns { user: { id, email, role, … } }.

    5. 5

      5 — PostgreSQL (postgres-primary)

      Expect count ≥ 1 after first sign-in. No /api/test-db route in this tree — use psql or authenticated API calls.

    6. 6

      6 — Authenticated APIs

      /api/entities and /api/opportunities require a session — 401 without cookies is expected.

      After browser login, DevTools → copy session cookie, or test in UI:

      1. /entities — list + create entity form submits.
      2. /opportunities — list loads for your role.
    7. 7

      7 — Tunnel readiness

      Expect "ready" and provider list from lib/tunnel/config. For live SSE: Network tab → /api/tunnel/sse after sign-in. See Tunnel protocol.

    8. 8

      8 — Optional checks

      CheckCommand / actionExpected
      TypeScriptnpm run type-checkExit 0
      Wallet APIGET /api/wallet/balance (logged in){ balance } or 404 until wallet created
      Buildnpm run buildCompletes (runs type-check by default)
    First-success flow