---
title: "Welcome to Ring"
description: "Ring Platform is a free, open-source white-label platform that connects people to relevant opportunities through AI matching and direct-message notifications. Self-host from GitHub or get a managed clone on ringdom.org."
locale: "en"
---
# Welcome to Ring Platform

> **Info**
> Use the **Founder** / **Developer** tabs in the docs sidebar to filter this page. `audience` frontmatter controls in-page blocks; sidebar visibility is controlled by `lib/docs/audience-curated-docs.ts`.

Ring Platform is a **free, open-source white-label platform** that connects people to the opportunities that match them — through AI matching and direct-message notifications — instead of leaving them to scroll a catalog of listings. One codebase, your brand, your domain, your vertical.

  Ring is my contribution to world peace and decentralized abundance. It is 100% free and open source, forever available at [connectplatform/ring](https://github.com/connectplatform/ring). It is a fully-featured, clonable digital platform — matcher, messenger, contacts, web3 wallet, token contracts, store, and more — so you can run your business from your favourite messenger. If we adopt Ring everywhere, the AI matcher brings everyone prosperity through abundance of valid choice.

## The gateway: emit, match, notify

Ring turns the way opportunities usually work upside down. Instead of a passive database where posts wait to be searched, Ring **actively finds matches and notifies** the people who fit — when the fit appears.

| Previous | Ring equivalent |
|----------|-----------------|
| Post a listing and hope someone searches | Post an opportunity → Matcher scores candidates → notify the best fits |
| You search a dead catalog | The match comes to you as a notification |
| Offers only (one-directional) | Dual-nature `offer` and `request` opportunities |
| Opaque ranking | Eight scored factors + configurable `scoreThreshold` |

### How a match is scored

The Matcher scores every candidate across **eight factors** (`MatchFactors` in `lib/ai/types.ts`, each 0–100): `skillMatch`, `experienceMatch`, `industryMatch`, `locationMatch`, `budgetMatch`, `availabilityMatch`, `careerMatch`, `cultureMatch`. Notifications explain *why* something matched in **≤160 characters** (`MatchingService` truncates longer LLM text).

Defaults come from `ring-config.json → matcher` and are tunable per clone — not kingdom-wide SLAs: `scoreThreshold` **0.7**, `maxMatches` **10**, `autoApprove` **false**. Quality bands (high ≥80 / medium 60–79 / low <60) are analytics signals, not a published accuracy guarantee.

### For founders

## Why this matters for your clone

Ring is a **white-label codebase**: you deploy your own branded platform and keep the users, the data, and the brand — without rebuilding marketplace, matching, messaging, payments, and auth from scratch.

- **Ship a vertical platform, not a generic app.** Enable only the modules your community needs.
- **Grow by matching, not by search.** Members get notified the moment a relevant opportunity appears.
- **Own the relationship.** Your domain, your locale, your payment provider, your rules.
- **No per-seat licensing.** Full source access, deploy anywhere.

### Start here

  
- **[Start your clone](/docs/customization/quick-start.md)** — OSS install.sh or Ringdom-managed hosting

  
- **[See live clones](/docs/customization/success-stories.md)** — Real Ring deployments across verticals

  
- **[Understand matching](/docs/features/opportunities.md)** — The eight-factor Matcher loop

  
- **[Make money](/docs/features/store.md)** — Store, payments, and subscriptions

### Reference deployments (real, live clones)

These are actual Ring clones in the Ringdom empire — visit them to evaluate Ring for your own product. The full roster with module detail lives in [Reference Ring deployments](/docs/customization/success-stories.md).

| Clone | Vertical |
|-------|----------|
| **ring-greenfood-live** | Agricultural multi-vendor marketplace |
| **ring-vikka-ua** | Regional newsroom (Cherkasy, UA) |
| **ring-zemna-ai** | Scientific publishing + live agent chat |
| **ring-petfriend-app** | Pet-friendly map marketplace |
| **ring-ring-ck-ua** | Cherkasy regional IT opportunities |
| **ring-wellness-gov-ua** | Healthcare / civic (UA) |
| **ring-subiworx-com** | Local Subaru services (Tempe, AZ) |
| **ring-ringdom-org** | Empire hub + work opportunities marketplace |

### For developers

## What you are integrating

Ring ships as a **Next.js 16 + React 19** App Router application with **Auth.js v5**, **Tailwind 4**, and a **PostgreSQL-primary** backend. The canonical public tree is [connectplatform/ring](https://github.com/connectplatform/ring).

| Layer | Canonical artifact | Notes |
|-------|--------------------|-------|
| Clone identity | `ring-config.json` | Branding, feature flags, domains (`ring-config.template.json`) |
| Secrets & backend | `.env.local` | `DB_BACKEND_MODE`, `AUTH_*`, Firebase FCM, deploy target |
| Application data | PostgreSQL `ring_platform` | `data/schema.sql` + kingdom migrations |
| Auth | Auth.js v5 (`auth.ts`) | `AUTH_SECRET` + OAuth provider |
| Dev runtime | `server.ts` | `npm run dev` — native WSS when `RING_DEPLOY_TARGET=self-hosted` |

### Boot a local clone

**Clone and install**

{`git clone https://github.com/connectplatform/ring.git
cd ring
./install.sh`}

`install.sh` copies `env.local.template` → `.env.local`, seeds `ring-config.json` if missing, generates `AUTH_SECRET`, and runs `npm install`.

**Apply schema and run**

{`npm run dev`}

Apply `data/schema.sql` against a local PostgreSQL 16 instance, then smoke-test. The default backend is `DB_BACKEND_MODE=k8s-postgres-fcm` (PostgreSQL for app data; Firebase Admin only for FCM push when configured).

A full, time-budgeted bootstrap lives in [Getting Started](/docs/getting-started.md) — install paths, prerequisites, migrations, and first-success validation.

### Verified module surfaces

The platform is organized around documented features and services, not a monolith:

- **Opportunities + Matcher** — `lib/ai/matcher.ts`, `OpportunityMatchingService` ([Opportunities](/docs/features/opportunities.md))
- **DatabaseService** — `lib/database/DatabaseService.ts`, result contract `{ success, data, error }` ([Architecture](/docs/architecture.md))
- **Payments** — PaymentConductor, canonical webhooks under `/api/payments/*/webhook` ([PaymentConductor](/docs/features/payment-conductor.md))
- **Notifications** — `notification-service`, entity block filters ([Notifications](/docs/features/notifications.md))

Explore the rest with the feature explorer below.

## Feature ecosystem

## Get your own Ring

Two real paths, one codebase:

| Path | Best when | You get |
|------|-----------|---------|
| **OSS self-host** | You operate your own infra (laptop, VPS, k3s) | Full source tree + `install.sh` ([Quick Start](/docs/customization/quick-start.md)) |
| **Ringdom managed** | You want k8s, DNS, and ops handled for you | Managed clone provisioned from [ringdom.org](https://ringdom.org) |

## Related documentation

  
- [getting-started/index](/docs/getting-started/index.md) — Next-step: bootstrap a clone locally with install.sh, schema migrations, and first-success validation.

  
- [customization/quick-start](/docs/customization/quick-start.md) — Same-workflow: choose OSS self-host or Ringdom-managed and stand up your own Ring.

  
- [features/opportunities](/docs/features/opportunities.md) — Deep-dive: the eight-factor Matcher, dual-nature offers/requests, and the create → match → notify loop.

  
- [customization/success-stories](/docs/customization/success-stories.md) — See-also: the roster of real Ring clones with verticals, modules, and public links.