Loading documentation...
Preparing Ring content
Concepts, value, and typical clone scenarios — less code.
Concepts, value, and typical clone scenarios — less code.
Preparing Ring content
Preparing Ring content
Preparing Ring content
Ringdom-managed hosting? ringdom.org — describe your platform in the homepage chat. After handoff use Customization guide.
Time: 45–90 minutes · Prerequisites: Git, Node.js 20+, Docker optional for Postgres.
| Outcome | Details |
|---|---|
| Local app | http://localhost:3000 via HomeWrapper |
| Backend | DB_BACKEND_MODE=k8s-postgres-fcm + PostgreSQL |
| Auth | Auth.js v5 — AUTH_SECRET + one OAuth provider |
| Schema | data/schema.sql v4+ and kingdom migrations |
| Config | ring-config.json + .env.local |
Recommended — from a fresh directory:
install.sh v2.0:
ring-config.json from templateenv.local.template → .env.local (includes DB_BACKEND_MODE=k8s-postgres-fcm)AUTH_SECRET / wallet keysnpm installFlags: --clone-name my-ring, --quick, --help. See INSTALL.md.
locales/{locale}/pages.json → pages.home/login — OAuth works/entities, /opportunities — no DB adapter errorsnpm run type-check passesSelf-hosted deployment — Docker or npm run build && npm start.
Environment — PaymentConductor, FCM, PSP keys.
Ringdom settlers: ringdom.org chat — skip this Quick Start.
Not recommended for full v1.6: Vercel + firebase-full only. Production default: k8s-postgres-fcm on your cluster.
Branding, HomeWrapper, locales
DB_BACKEND_MODE matrix
PaymentConductor setup
System internals
Clone running? Edit ring-config.json and locales/en/pages.json, then .reggie-propagate-exclude.json before Reggie propagation.
Ringdom-managed hosting? ringdom.org — describe your platform in the homepage chat. After handoff use Customization guide.
Time: 45–90 minutes · Prerequisites: Git, Node.js 20+, Docker optional for Postgres.
| Outcome | Details |
|---|---|
| Local app | http://localhost:3000 via HomeWrapper |
| Backend | DB_BACKEND_MODE=k8s-postgres-fcm + PostgreSQL |
| Auth | Auth.js v5 — AUTH_SECRET + one OAuth provider |
| Schema | data/schema.sql v4+ and kingdom migrations |
| Config | ring-config.json + .env.local |
Recommended — from a fresh directory:
install.sh v2.0:
ring-config.json from templateenv.local.template → .env.local (includes DB_BACKEND_MODE=k8s-postgres-fcm)AUTH_SECRET / wallet keysnpm installFlags: --clone-name my-ring, --quick, --help. See INSTALL.md.
locales/{locale}/pages.json → pages.home/login — OAuth works/entities, /opportunities — no DB adapter errorsnpm run type-check passesSelf-hosted deployment — Docker or npm run build && npm start.
Environment — PaymentConductor, FCM, PSP keys.
Ringdom settlers: ringdom.org chat — skip this Quick Start.
Not recommended for full v1.6: Vercel + firebase-full only. Production default: k8s-postgres-fcm on your cluster.
Branding, HomeWrapper, locales
DB_BACKEND_MODE matrix
PaymentConductor setup
System internals
Clone running? Edit ring-config.json and locales/en/pages.json, then .reggie-propagate-exclude.json before Reggie propagation.
Ringdom-managed hosting? ringdom.org — describe your platform in the homepage chat. After handoff use Customization guide.
Time: 45–90 minutes · Prerequisites: Git, Node.js 20+, Docker optional for Postgres.
| Outcome | Details |
|---|---|
| Local app | http://localhost:3000 via HomeWrapper |
| Backend | DB_BACKEND_MODE=k8s-postgres-fcm + PostgreSQL |
| Auth | Auth.js v5 — AUTH_SECRET + one OAuth provider |
| Schema | data/schema.sql v4+ and kingdom migrations |
| Config | ring-config.json + .env.local |
Recommended — from a fresh directory:
install.sh v2.0:
ring-config.json from templateenv.local.template → .env.local (includes DB_BACKEND_MODE=k8s-postgres-fcm)AUTH_SECRET / wallet keysnpm installFlags: --clone-name my-ring, --quick, --help. See INSTALL.md.
locales/{locale}/pages.json → pages.home/login — OAuth works/entities, /opportunities — no DB adapter errorsnpm run type-check passesSelf-hosted deployment — Docker or npm run build && npm start.
Environment — PaymentConductor, FCM, PSP keys.
Ringdom settlers: ringdom.org chat — skip this Quick Start.
Not recommended for full v1.6: Vercel + firebase-full only. Production default: k8s-postgres-fcm on your cluster.
Branding, HomeWrapper, locales
DB_BACKEND_MODE matrix
PaymentConductor setup
System internals
Clone running? Edit ring-config.json and locales/en/pages.json, then .reggie-propagate-exclude.json before Reggie propagation.