Завантаження документації...
Підготовка контенту платформи Ring
Підготовка контенту платформи Ring
Підготовка контенту платформи Ring
Підготовка контенту платформи Ring
Concepts, value, and typical clone scenarios — less code.
Concepts, value, and typical clone scenarios — less code.
Concepts, value, and typical clone scenarios — less code.
Bootstrap a Ring Platform white-label clone on your machine. This hub maps the real dev flow used in the open-source tree (connectplatform/ring) and on ring-platform.org — the community portal for self-hosted enthusiasts.
| Path | Time | Outcome |
|---|---|---|
./install.sh --quick + existing PostgreSQL | ~20–40 min | Clone config, deps, env scaffold — you still apply schema + OAuth |
| Full Postgres-primary bootstrap | 45–90 min | Production-parity local stack (k8s-postgres-fcm) |
Prototype (firebase-full) | ~15–30 min | Firestore-only — skips ERP, News Kingdom, PaymentConductor depth |
New to the vision first? Read Welcome to Ring, then return here.
Self-hosting from GitHub? Follow this section. Ringdom turn-key hosting? Start at ringdom.org — after handoff use Customization guide. The public OSS tree ships install.sh and community scripts; enterprise k8s/CLI tooling stays outside the public boundary (FEATURESET.md).
| Layer | Canonical artifact | Purpose |
|---|---|---|
| Clone identity | ring-config.json | Branding, feature flags, domains (ring-config.template.json) |
| Secrets & backend | .env.local | DB_BACKEND_MODE, AUTH_*, Firebase FCM, tunnel deploy target |
| Application data | PostgreSQL ring_platform | data/schema.sql v4.0.1+ + kingdom migrations |
| Auth | Auth.js v5 (auth.ts) | AUTH_SECRET + at least one OAuth provider for login |
| Dev runtime | server.ts | npm run dev — Next.js 16 + React 19 + native WSS when RING_DEPLOY_TARGET=self-hosted |
Interactive paths with copyable install commands — self-deploy from GitHub, LegioX-guided customization, or Promptor partnership.
Production and local dev use DB_BACKEND_MODE=k8s-postgres-fcm — PostgreSQL for app data, Firebase Admin only for FCM push when configured.
Skip the installer wizard — same outcome, more control:
Deep dive: Installation.
Node.js 20+, hardware, OS support, Firebase/Google Cloud accounts
Full install paths, env reference, tunnel config, common issues table
schema.sql v4.0.1+, kingdom files 002–011, clone DB matrix
Smoke-test auth, entities, opportunities, and API health
White-label clone checklist beyond first boot
k8s-postgres-fcm vs supabase-fcm vs firebase-full
Project structure, testing, Homebrew Postgres bootstrap
BackendSelector, adapters, FCM vs Firestore
| Task | Command |
|---|---|
| One-command install | git clone … && ./install.sh --quick |
| Env wizard | npm run setup:env |
| Dev env script | ./scripts/setup-dev.sh |
| Apply migration file | ./scripts/run-migration.sh data/schema.sql |
| Dev server | npm run dev |
| Type check | npm run type-check |
| Portal health | npm run portal:health |
| Repo install guide | INSTALL.md |
install.sh — first-time clone bootstrap (config files + npm install). setup-dev.sh — post-clone environment hardening and optional service wiring. Use npm run setup:env for a non-destructive interactive pass over an existing .env.local.
Bootstrap a Ring Platform white-label clone on your machine. This hub maps the real dev flow used in the open-source tree (connectplatform/ring) and on ring-platform.org — the community portal for self-hosted enthusiasts.
| Path | Time | Outcome |
|---|---|---|
./install.sh --quick + existing PostgreSQL | ~20–40 min | Clone config, deps, env scaffold — you still apply schema + OAuth |
| Full Postgres-primary bootstrap | 45–90 min | Production-parity local stack (k8s-postgres-fcm) |
Prototype (firebase-full) | ~15–30 min | Firestore-only — skips ERP, News Kingdom, PaymentConductor depth |
New to the vision first? Read Welcome to Ring, then return here.
Self-hosting from GitHub? Follow this section. Ringdom turn-key hosting? Start at ringdom.org — after handoff use Customization guide. The public OSS tree ships install.sh and community scripts; enterprise k8s/CLI tooling stays outside the public boundary (FEATURESET.md).
| Layer | Canonical artifact | Purpose |
|---|---|---|
| Clone identity | ring-config.json | Branding, feature flags, domains (ring-config.template.json) |
| Secrets & backend | .env.local | DB_BACKEND_MODE, AUTH_*, Firebase FCM, tunnel deploy target |
| Application data | PostgreSQL ring_platform | data/schema.sql v4.0.1+ + kingdom migrations |
| Auth | Auth.js v5 (auth.ts) | AUTH_SECRET + at least one OAuth provider for login |
| Dev runtime | server.ts | npm run dev — Next.js 16 + React 19 + native WSS when RING_DEPLOY_TARGET=self-hosted |
Interactive paths with copyable install commands — self-deploy from GitHub, LegioX-guided customization, or Promptor partnership.
Production and local dev use DB_BACKEND_MODE=k8s-postgres-fcm — PostgreSQL for app data, Firebase Admin only for FCM push when configured.
Skip the installer wizard — same outcome, more control:
Deep dive: Installation.
Node.js 20+, hardware, OS support, Firebase/Google Cloud accounts
Full install paths, env reference, tunnel config, common issues table
schema.sql v4.0.1+, kingdom files 002–011, clone DB matrix
Smoke-test auth, entities, opportunities, and API health
White-label clone checklist beyond first boot
k8s-postgres-fcm vs supabase-fcm vs firebase-full
Project structure, testing, Homebrew Postgres bootstrap
BackendSelector, adapters, FCM vs Firestore
| Task | Command |
|---|---|
| One-command install | git clone … && ./install.sh --quick |
| Env wizard | npm run setup:env |
| Dev env script | ./scripts/setup-dev.sh |
| Apply migration file | ./scripts/run-migration.sh data/schema.sql |
| Dev server | npm run dev |
| Type check | npm run type-check |
| Portal health | npm run portal:health |
| Repo install guide | INSTALL.md |
install.sh — first-time clone bootstrap (config files + npm install). setup-dev.sh — post-clone environment hardening and optional service wiring. Use npm run setup:env for a non-destructive interactive pass over an existing .env.local.
Bootstrap a Ring Platform white-label clone on your machine. This hub maps the real dev flow used in the open-source tree (connectplatform/ring) and on ring-platform.org — the community portal for self-hosted enthusiasts.
| Path | Time | Outcome |
|---|---|---|
./install.sh --quick + existing PostgreSQL | ~20–40 min | Clone config, deps, env scaffold — you still apply schema + OAuth |
| Full Postgres-primary bootstrap | 45–90 min | Production-parity local stack (k8s-postgres-fcm) |
Prototype (firebase-full) | ~15–30 min | Firestore-only — skips ERP, News Kingdom, PaymentConductor depth |
New to the vision first? Read Welcome to Ring, then return here.
Self-hosting from GitHub? Follow this section. Ringdom turn-key hosting? Start at ringdom.org — after handoff use Customization guide. The public OSS tree ships install.sh and community scripts; enterprise k8s/CLI tooling stays outside the public boundary (FEATURESET.md).
| Layer | Canonical artifact | Purpose |
|---|---|---|
| Clone identity | ring-config.json | Branding, feature flags, domains (ring-config.template.json) |
| Secrets & backend | .env.local | DB_BACKEND_MODE, AUTH_*, Firebase FCM, tunnel deploy target |
| Application data | PostgreSQL ring_platform | data/schema.sql v4.0.1+ + kingdom migrations |
| Auth | Auth.js v5 (auth.ts) | AUTH_SECRET + at least one OAuth provider for login |
| Dev runtime | server.ts | npm run dev — Next.js 16 + React 19 + native WSS when RING_DEPLOY_TARGET=self-hosted |
Interactive paths with copyable install commands — self-deploy from GitHub, LegioX-guided customization, or Promptor partnership.
Production and local dev use DB_BACKEND_MODE=k8s-postgres-fcm — PostgreSQL for app data, Firebase Admin only for FCM push when configured.
Skip the installer wizard — same outcome, more control:
Deep dive: Installation.
Node.js 20+, hardware, OS support, Firebase/Google Cloud accounts
Full install paths, env reference, tunnel config, common issues table
schema.sql v4.0.1+, kingdom files 002–011, clone DB matrix
Smoke-test auth, entities, opportunities, and API health
White-label clone checklist beyond first boot
k8s-postgres-fcm vs supabase-fcm vs firebase-full
Project structure, testing, Homebrew Postgres bootstrap
BackendSelector, adapters, FCM vs Firestore
| Task | Command |
|---|---|
| One-command install | git clone … && ./install.sh --quick |
| Env wizard | npm run setup:env |
| Dev env script | ./scripts/setup-dev.sh |
| Apply migration file | ./scripts/run-migration.sh data/schema.sql |
| Dev server | npm run dev |
| Type check | npm run type-check |
| Portal health | npm run portal:health |
| Repo install guide | INSTALL.md |
install.sh — first-time clone bootstrap (config files + npm install). setup-dev.sh — post-clone environment hardening and optional service wiring. Use npm run setup:env for a non-destructive interactive pass over an existing .env.local.
install.shinstall.sh v2.0 (see INSTALL.md):
ring-config.json from template (--clone-name for white-label slug)env.local.template → .env.local with generated AUTH_SECRET and WALLET_ENCRYPTION_KEYnpm installnext.config.mjs, docker-compose.yml, Dockerfile from templatesFlags: --quick, --clone-name my-ring, --verbose, --help.
Start Postgres 16+ and database ring_platform (user ring_user). Options:
docker compose -f docker-compose.dev.yml up -d postgres or ./infrastructure/postgres/bootstrap-brew-dev.shDB_HOST / DB_* in .env.localFull order, idempotent increments, and Ring-clone matrix: Database migrations. Helper: ./scripts/run-migration.sh when pointed at your ring-postgres-dev container.
Minimum in .env.local:
Add Google OAuth redirect: http://localhost:3000/api/auth/callback/google.
Interactive env wizard (after template copy): npm run setup:env or ./scripts/setup-dev.sh.
Expect: Ready on http://localhost:3000 [self-hosted] and native WSS at /api/tunnel/ws.
Then run First success validation — homepage, /login, entities/opportunities without DB adapter errors. Optional: npm run type-check, npm run portal:health.
Visit http://localhost:3000. Customize branding in ring-config.json and explore Next steps.
FETCH_FAILED, wallet bootstrap, OAuth redirects, diagnostics
install.shinstall.sh v2.0 (see INSTALL.md):
ring-config.json from template (--clone-name for white-label slug)env.local.template → .env.local with generated AUTH_SECRET and WALLET_ENCRYPTION_KEYnpm installnext.config.mjs, docker-compose.yml, Dockerfile from templatesFlags: --quick, --clone-name my-ring, --verbose, --help.
Start Postgres 16+ and database ring_platform (user ring_user). Options:
docker compose -f docker-compose.dev.yml up -d postgres or ./infrastructure/postgres/bootstrap-brew-dev.shDB_HOST / DB_* in .env.localFull order, idempotent increments, and Ring-clone matrix: Database migrations. Helper: ./scripts/run-migration.sh when pointed at your ring-postgres-dev container.
Minimum in .env.local:
Add Google OAuth redirect: http://localhost:3000/api/auth/callback/google.
Interactive env wizard (after template copy): npm run setup:env or ./scripts/setup-dev.sh.
Expect: Ready on http://localhost:3000 [self-hosted] and native WSS at /api/tunnel/ws.
Then run First success validation — homepage, /login, entities/opportunities without DB adapter errors. Optional: npm run type-check, npm run portal:health.
Visit http://localhost:3000. Customize branding in ring-config.json and explore Next steps.
FETCH_FAILED, wallet bootstrap, OAuth redirects, diagnostics
install.shinstall.sh v2.0 (see INSTALL.md):
ring-config.json from template (--clone-name for white-label slug)env.local.template → .env.local with generated AUTH_SECRET and WALLET_ENCRYPTION_KEYnpm installnext.config.mjs, docker-compose.yml, Dockerfile from templatesFlags: --quick, --clone-name my-ring, --verbose, --help.
Start Postgres 16+ and database ring_platform (user ring_user). Options:
docker compose -f docker-compose.dev.yml up -d postgres or ./infrastructure/postgres/bootstrap-brew-dev.shDB_HOST / DB_* in .env.localFull order, idempotent increments, and Ring-clone matrix: Database migrations. Helper: ./scripts/run-migration.sh when pointed at your ring-postgres-dev container.
Minimum in .env.local:
Add Google OAuth redirect: http://localhost:3000/api/auth/callback/google.
Interactive env wizard (after template copy): npm run setup:env or ./scripts/setup-dev.sh.
Expect: Ready on http://localhost:3000 [self-hosted] and native WSS at /api/tunnel/ws.
Then run First success validation — homepage, /login, entities/opportunities without DB adapter errors. Optional: npm run type-check, npm run portal:health.
Visit http://localhost:3000. Customize branding in ring-config.json and explore Next steps.
FETCH_FAILED, wallet bootstrap, OAuth redirects, diagnostics