Завантаження документації...
Підготовка контенту платформи Ring
Concepts, value, and typical clone scenarios — less code.
Concepts, value, and typical clone scenarios — less code.
Підготовка контенту платформи Ring
Підготовка контенту платформи Ring
Підготовка контенту платформи Ring
Connect a Ring clone to the services your community already uses — Ukrainian and global payment rails, EVM wallets, OAuth identity, Firebase push, business mailboxes, self-hosted media storage, and automation clients — through config-driven adapters documented here.
Ring does not hard-code vendor lock-in. Operators enable integrations via ring-config.json, .env.local, and documented service modules: PaymentConductor (WayForPay / Stripe / credits), Wagmi v3 (WalletConnect and injected wallets), Auth.js v5 (OAuth + magic links), FCM (web push), Email AI-CRM (IMAP/SMTP), RingFileBase + Ring CDN (file() storage), and REST / Tunnel / MCP for external apps. Start with Environment configuration, then open the guide for your integration class below.
DB_BACKEND_MODE, PaymentConductor, FCM, OAuth, WalletConnect, Email AI-CRM blocks.
Server Actions, same-origin REST, Tunnel realtime, and MCP automation paths.
PaymentConductor operator guide — WayForPay, Stripe, internal credit ledger.
Per-clone Model Context Protocol gateway for Cursor and automation hosts.
| Plane | Primary integration | Canonical doc |
|---|---|---|
| Object storage | file() → RingBaseAdapter | RingFileBase |
| Media CDN | NGINX edge /files/... | Ring CDN |
| EVM wallets | Wagmi v3 + viem connectors | Ethereum wallets |
| Card & membership checkout | PaymentConductor → PSP webhooks | Payment integration |
| Ukrainian PSP deep dive | WayForPay HMAC webhooks | WayForPay integration |
| Sign-in |
Each card links to a dedicated reference page under /docs/integrations/.
Injected, MetaMask, Coinbase Wallet, WalletConnect — env vars and white-label connector lineup.
file() → RingBaseAdapter → MinIO/RGW — provider SSOT, tokens, k8s wiring.
Public cdn.<domain>/files/..., host→bucket map, multi-zone edges.
Additional first-party integration pages (Stripe operator checklist, OAuth provider matrix, ConnectPlatform bridge) will appear here as they are authored. Deep dives that already live under Features, Customization, or Examples are linked below until migrated.
Authenticated uploads for product images, KYC, chat, and generative media.
Cacheable public reads in front of MinIO — pair with RingFileBase writes.
NEXT_PUBLIC_STORAGE_PROVIDER, RINGBASE_*, local vs Blob vs filebase.
Object buckets are a separate backup asset from Postgres.
PaymentConductor purposes, webhook dispatcher, ledger idempotency.
Membership upgrades, HMAC verification, sandbox cards, revenue flows.
Rails overview — store, membership, news promotion, top-up.
User-facing checkout surfaces and credit balance UX.
Auth.js v5 providers, magic links, wallet sign-in, role gates.
Proxy vs layout protection, OAuth callbacks, KYC upload flow.
Legacy ethers examples retired — pointer to Wagmi v3 guide.
Token registry, Server Action upsert, service worker, stale-token cleanup.
SSE, WebSocket, long-poll transports — pair with FCM when tabs are closed.
REST contract for inbox and FCM register routes.
IMAP ingest, AI drafts, admin approve/send, JSONB persistence.
Admin routes, cron poll, inbound webhook contract.
fetch('/api/...'), Tunnel hooks, curl smoke tests, error handling.
Full route catalog — entities, opportunities, messaging, wallet, admin.
ring-mcp stdio server → /api/mcp/v1/* service-token gateway.
| Requirement | Notes |
|---|---|
| Running Ring clone | npm run dev locally or k8s deploy |
ring-config.json | Branding, membership amounts, feature flags |
.env.local from template | Copy env.local.template; never commit secrets |
| Migrations applied | Payment ledger, FCM, Email CRM as needed per integration |
| PSP / OAuth dashboards | Callback URLs must match your clone hostname |
| Your goal | Start here |
|---|---|
| Accept UAH card payments for membership | WayForPay integration → Payment integration |
| Add MetaMask / WalletConnect | Ethereum wallets |
| Self-host product images / leave Vercel Blob | RingFileBase → Ring CDN |
| Enable Google or Apple sign-in | Authentication + OAuth block in Environment |
| Mobile-style web push | Push notifications (FCM) |
| Live chat / unread badges without refresh | Tunnel protocol |
| Automate from Cursor or CI |
Connect a Ring clone to the services your community already uses — Ukrainian and global payment rails, EVM wallets, OAuth identity, Firebase push, business mailboxes, self-hosted media storage, and automation clients — through config-driven adapters documented here.
Ring does not hard-code vendor lock-in. Operators enable integrations via ring-config.json, .env.local, and documented service modules: PaymentConductor (WayForPay / Stripe / credits), Wagmi v3 (WalletConnect and injected wallets), Auth.js v5 (OAuth + magic links), FCM (web push), Email AI-CRM (IMAP/SMTP), RingFileBase + Ring CDN (file() storage), and REST / Tunnel / MCP for external apps. Start with Environment configuration, then open the guide for your integration class below.
DB_BACKEND_MODE, PaymentConductor, FCM, OAuth, WalletConnect, Email AI-CRM blocks.
Server Actions, same-origin REST, Tunnel realtime, and MCP automation paths.
PaymentConductor operator guide — WayForPay, Stripe, internal credit ledger.
Per-clone Model Context Protocol gateway for Cursor and automation hosts.
| Plane | Primary integration | Canonical doc |
|---|---|---|
| Object storage | file() → RingBaseAdapter | RingFileBase |
| Media CDN | NGINX edge /files/... | Ring CDN |
| EVM wallets | Wagmi v3 + viem connectors | Ethereum wallets |
| Card & membership checkout | PaymentConductor → PSP webhooks | Payment integration |
| Ukrainian PSP deep dive | WayForPay HMAC webhooks | WayForPay integration |
| Sign-in |
Each card links to a dedicated reference page under /docs/integrations/.
Injected, MetaMask, Coinbase Wallet, WalletConnect — env vars and white-label connector lineup.
file() → RingBaseAdapter → MinIO/RGW — provider SSOT, tokens, k8s wiring.
Public cdn.<domain>/files/..., host→bucket map, multi-zone edges.
Additional first-party integration pages (Stripe operator checklist, OAuth provider matrix, ConnectPlatform bridge) will appear here as they are authored. Deep dives that already live under Features, Customization, or Examples are linked below until migrated.
Authenticated uploads for product images, KYC, chat, and generative media.
Cacheable public reads in front of MinIO — pair with RingFileBase writes.
NEXT_PUBLIC_STORAGE_PROVIDER, RINGBASE_*, local vs Blob vs filebase.
Object buckets are a separate backup asset from Postgres.
PaymentConductor purposes, webhook dispatcher, ledger idempotency.
Membership upgrades, HMAC verification, sandbox cards, revenue flows.
Rails overview — store, membership, news promotion, top-up.
User-facing checkout surfaces and credit balance UX.
Auth.js v5 providers, magic links, wallet sign-in, role gates.
Proxy vs layout protection, OAuth callbacks, KYC upload flow.
Legacy ethers examples retired — pointer to Wagmi v3 guide.
Token registry, Server Action upsert, service worker, stale-token cleanup.
SSE, WebSocket, long-poll transports — pair with FCM when tabs are closed.
REST contract for inbox and FCM register routes.
IMAP ingest, AI drafts, admin approve/send, JSONB persistence.
Admin routes, cron poll, inbound webhook contract.
fetch('/api/...'), Tunnel hooks, curl smoke tests, error handling.
Full route catalog — entities, opportunities, messaging, wallet, admin.
ring-mcp stdio server → /api/mcp/v1/* service-token gateway.
| Requirement | Notes |
|---|---|
| Running Ring clone | npm run dev locally or k8s deploy |
ring-config.json | Branding, membership amounts, feature flags |
.env.local from template | Copy env.local.template; never commit secrets |
| Migrations applied | Payment ledger, FCM, Email CRM as needed per integration |
| PSP / OAuth dashboards | Callback URLs must match your clone hostname |
| Your goal | Start here |
|---|---|
| Accept UAH card payments for membership | WayForPay integration → Payment integration |
| Add MetaMask / WalletConnect | Ethereum wallets |
| Self-host product images / leave Vercel Blob | RingFileBase → Ring CDN |
| Enable Google or Apple sign-in | Authentication + OAuth block in Environment |
| Mobile-style web push | Push notifications (FCM) |
| Live chat / unread badges without refresh | Tunnel protocol |
| Automate from Cursor or CI |
Connect a Ring clone to the services your community already uses — Ukrainian and global payment rails, EVM wallets, OAuth identity, Firebase push, business mailboxes, self-hosted media storage, and automation clients — through config-driven adapters documented here.
Ring does not hard-code vendor lock-in. Operators enable integrations via ring-config.json, .env.local, and documented service modules: PaymentConductor (WayForPay / Stripe / credits), Wagmi v3 (WalletConnect and injected wallets), Auth.js v5 (OAuth + magic links), FCM (web push), Email AI-CRM (IMAP/SMTP), RingFileBase + Ring CDN (file() storage), and REST / Tunnel / MCP for external apps. Start with Environment configuration, then open the guide for your integration class below.
DB_BACKEND_MODE, PaymentConductor, FCM, OAuth, WalletConnect, Email AI-CRM blocks.
Server Actions, same-origin REST, Tunnel realtime, and MCP automation paths.
PaymentConductor operator guide — WayForPay, Stripe, internal credit ledger.
Per-clone Model Context Protocol gateway for Cursor and automation hosts.
| Plane | Primary integration | Canonical doc |
|---|---|---|
| Object storage | file() → RingBaseAdapter | RingFileBase |
| Media CDN | NGINX edge /files/... | Ring CDN |
| EVM wallets | Wagmi v3 + viem connectors | Ethereum wallets |
| Card & membership checkout | PaymentConductor → PSP webhooks | Payment integration |
| Ukrainian PSP deep dive | WayForPay HMAC webhooks | WayForPay integration |
| Sign-in |
Each card links to a dedicated reference page under /docs/integrations/.
Injected, MetaMask, Coinbase Wallet, WalletConnect — env vars and white-label connector lineup.
file() → RingBaseAdapter → MinIO/RGW — provider SSOT, tokens, k8s wiring.
Public cdn.<domain>/files/..., host→bucket map, multi-zone edges.
Additional first-party integration pages (Stripe operator checklist, OAuth provider matrix, ConnectPlatform bridge) will appear here as they are authored. Deep dives that already live under Features, Customization, or Examples are linked below until migrated.
Authenticated uploads for product images, KYC, chat, and generative media.
Cacheable public reads in front of MinIO — pair with RingFileBase writes.
NEXT_PUBLIC_STORAGE_PROVIDER, RINGBASE_*, local vs Blob vs filebase.
Object buckets are a separate backup asset from Postgres.
PaymentConductor purposes, webhook dispatcher, ledger idempotency.
Membership upgrades, HMAC verification, sandbox cards, revenue flows.
Rails overview — store, membership, news promotion, top-up.
User-facing checkout surfaces and credit balance UX.
Auth.js v5 providers, magic links, wallet sign-in, role gates.
Proxy vs layout protection, OAuth callbacks, KYC upload flow.
Legacy ethers examples retired — pointer to Wagmi v3 guide.
Token registry, Server Action upsert, service worker, stale-token cleanup.
SSE, WebSocket, long-poll transports — pair with FCM when tabs are closed.
REST contract for inbox and FCM register routes.
IMAP ingest, AI drafts, admin approve/send, JSONB persistence.
Admin routes, cron poll, inbound webhook contract.
fetch('/api/...'), Tunnel hooks, curl smoke tests, error handling.
Full route catalog — entities, opportunities, messaging, wallet, admin.
ring-mcp stdio server → /api/mcp/v1/* service-token gateway.
| Requirement | Notes |
|---|---|
| Running Ring clone | npm run dev locally or k8s deploy |
ring-config.json | Branding, membership amounts, feature flags |
.env.local from template | Copy env.local.template; never commit secrets |
| Migrations applied | Payment ledger, FCM, Email CRM as needed per integration |
| PSP / OAuth dashboards | Callback URLs must match your clone hostname |
| Your goal | Start here |
|---|---|
| Accept UAH card payments for membership | WayForPay integration → Payment integration |
| Add MetaMask / WalletConnect | Ethereum wallets |
| Self-host product images / leave Vercel Blob | RingFileBase → Ring CDN |
| Enable Google or Apple sign-in | Authentication + OAuth block in Environment |
| Mobile-style web push | Push notifications (FCM) |
| Live chat / unread badges without refresh | Tunnel protocol |
| Automate from Cursor or CI |
| Auth.js OAuth + magic links |
| Authentication |
| Web push | Firebase Cloud Messaging | Push notifications (FCM) |
| Live UI | Tunnel broker (SSE / WS) | Tunnel protocol |
| Public inbox CRM | IMAP poll + SMTP + Claude drafts | Email AI-CRM |
| Headless clients | REST + session cookie or MCP bearer | API integration examples |
On-platform RING credits, top-up, and membership spend paths.
| Build a mobile app on Ring APIs | API integration examples |
| Auth.js OAuth + magic links |
| Authentication |
| Web push | Firebase Cloud Messaging | Push notifications (FCM) |
| Live UI | Tunnel broker (SSE / WS) | Tunnel protocol |
| Public inbox CRM | IMAP poll + SMTP + Claude drafts | Email AI-CRM |
| Headless clients | REST + session cookie or MCP bearer | API integration examples |
On-platform RING credits, top-up, and membership spend paths.
| Build a mobile app on Ring APIs | API integration examples |
| Auth.js OAuth + magic links |
| Authentication |
| Web push | Firebase Cloud Messaging | Push notifications (FCM) |
| Live UI | Tunnel broker (SSE / WS) | Tunnel protocol |
| Public inbox CRM | IMAP poll + SMTP + Claude drafts | Email AI-CRM |
| Headless clients | REST + session cookie or MCP bearer | API integration examples |
On-platform RING credits, top-up, and membership spend paths.
| Build a mobile app on Ring APIs | API integration examples |