---
title: "Початок роботи"
description: "Локальний bootstrap Ring Platform — install.sh, PostgreSQL-primary, Auth.js v5, міграції схеми та перша валідація"
locale: "uk"
---
# Початок роботи

Запустіть **white-label клон Ring Platform** на своєму комп’ютері. Цей хаб відображає реальний dev-flow з open-source дерева ([connectplatform/ring](https://github.com/connectplatform/ring)) і **ring-platform.org** — community-порталу для self-hosted ентузіастів.

| Шлях | Час | Результат |
|------|-----|-----------|
| **`./install.sh --quick`** + наявний PostgreSQL | ~20–40 хв | Клон, залежності, env — схему та OAuth ще потрібно додати |
| **Повний Postgres-primary bootstrap** | 45–90 хв | Локальний стек як у production (`k8s-postgres-fcm`) |
| **Прототип (`firebase-full`)** | ~15–30 хв | Лише Firestore — без глибини ERP, News Kingdom, PaymentConductor |

Спочатку бачення? [Ласкаво просимо до Ring](/docs/welcome.md), потім поверніться сюди.

**Self-host з GitHub?** Ця секція для вас. **Turn-key хостинг Ringdom?** Почніть на [ringdom.org](https://ringdom.org) — після handoff див. [Посібник з кастомізації](/docs/customization/customization-guide.md). Публічне OSS-дерево містить `install.sh`; enterprise k8s/CLI залишається поза публічною межею ([`FEATURESET.md`](https://github.com/connectplatform/ring/blob/main/FEATURESET.md)).

## Що ви налаштуєте

| Шар | Артефакт | Призначення |
|-----|----------|-------------|
| **Ідентичність клону** | `ring-config.json` | Брендинг, feature flags, домени (`ring-config.template.json`) |
| **Секрети та backend** | `.env.local` | `DB_BACKEND_MODE`, `AUTH_*`, Firebase FCM, tunnel deploy target |
| **Дані застосунку** | PostgreSQL `ring_platform` | `data/schema.sql` v4.0.1+ + kingdom migrations |
| **Auth** | Auth.js v5 (`auth.ts`) | `AUTH_SECRET` + щонайменше один OAuth-провайдер |
| **Dev runtime** | `server.ts` | `npm run dev` — Next.js 16 + React 19 + native WSS при `RING_DEPLOY_TARGET=self-hosted` |

## Три способи отримати Ring Platform

Інтерактивні шляхи з **копійованими командами** — self-deploy з GitHub, LegioX-кастомізація або партнерство Promptor.

## Рекомендований bootstrap (Postgres-primary)

Production і локальний dev використовують **`DB_BACKEND_MODE=k8s-postgres-fcm`** — PostgreSQL для даних, Firebase Admin **лише для FCM push**, якщо налаштовано.

### 1 — Клон і `install.sh`

{`git clone https://github.com/connectplatform/ring.git
cd ring
chmod +x install.sh
./install.sh --quick`}

`install.sh` v2.0 (див. [`INSTALL.md`](https://github.com/connectplatform/ring/blob/main/INSTALL.md)):

- Перевірка системних вимог (Node.js 20+, npm 10+)
- Створює **`ring-config.json`** з шаблону (`--clone-name` для white-label slug)
- Копіює **`env.local.template`** → **`.env.local`** з `AUTH_SECRET` і `WALLET_ENCRYPTION_KEY`
- Запускає **`npm install`**
- За потреби матеріалізує `next.config.mjs`, `docker-compose.yml`, `Dockerfile`

Прапорці: `--quick`, `--clone-name my-ring`, `--verbose`, `--help`.

### 2 — PostgreSQL

Запустіть Postgres 16+ і БД **`ring_platform`** (користувач **`ring_user`**). Варіанти:

- **Docker** — dev-контейнер (див. [Встановлення](/docs/getting-started/installation.md#postgresql-setup))
- **Ringdom monorepo** — `docker compose -f docker-compose.dev.yml up -d postgres` або `./infrastructure/postgres/bootstrap-brew-dev.sh`
- **Існуючий сервер** — створіть БД і вкажіть `DB_HOST` / `DB_*` у `.env.local`

### 3 — Схема та kingdom migrations

{`export DATABASE_URL="postgresql://ring_user:ring_password_2024@localhost:5432/ring_platform"
psql "$DATABASE_URL" -f data/schema.sql
psql "$DATABASE_URL" -f data/migrations/002_news_content_schema.sql
psql "$DATABASE_URL" -f data/migrations/003_news_kingdom_upgrade.sql
psql "$DATABASE_URL" -f data/migrations/004_payment_transactions.sql`}

Повний порядок і матриця клонів: [Міграції БД](/docs/getting-started/migrations.md). Хелпер: `./scripts/run-migration.sh` для контейнера `ring-postgres-dev`.

### 4 — Auth і локальні URL

Мінімум у `.env.local`:

{`DB_BACKEND_MODE=k8s-postgres-fcm
AUTH_SECRET=          # openssl rand -base64 32
AUTH_GOOGLE_ID=
AUTH_GOOGLE_SECRET=
NEXT_PUBLIC_BASE_URL=http://localhost:3000
RING_DEPLOY_TARGET=self-hosted
NEXT_PUBLIC_RING_DEPLOY_TARGET=self-hosted`}

Додайте Google OAuth redirect: `http://localhost:3000/api/auth/callback/google`.

Інтерактивний майстер: `npm run setup:env` або `./scripts/setup-dev.sh`.

### 5 — Dev-сервер і валідація

{`npm run dev`}

Очікуйте: `Ready on http://localhost:3000 [self-hosted]` і native WSS на `/api/tunnel/ws`.

Далі [Перший успіх](/docs/getting-started/first-success.md) — homepage, `/login`, entities/opportunities без помилок адаптера БД. Опційно: `npm run type-check`, `npm run portal:health`.

Відкрийте [http://localhost:3000](http://localhost:3000). Брендинг у `ring-config.json`, далі [Наступні кроки](/docs/getting-started/next-steps.md).

## Альтернативні шляхи

Без інсталятора — той самий результат, більше контролю:

{`git clone https://github.com/connectplatform/ring.git
cd ring
npm install
cp env.local.template .env.local
cp ring-config.template.json ring-config.json
# edit ring-config.json + .env.local
# provision PostgreSQL + apply migrations (кроки 2–3 вище)
npm run dev`}

Детально: [Встановлення](/docs/getting-started/installation.md).

Швидкий Vercel-edge прототип — **не** production data plane ring-platform.org:

{`DB_BACKEND_MODE=firebase-full`}

Firebase Admin + client keys з `env.local.template`. Без `data/schema.sql`. Прогалини: [Вибір БД](/docs/customization/database-selection.md).

Коли `ring-platform.org` у checkout Ringdom:

{`docker compose -f docker-compose.dev.yml up -d postgres
cd ring-platform.org
npm install
# .env.local already or: npm run setup:env
npm run dev`}

Маніфест multi-clone Postgres: `infrastructure/postgres/DEV-DATABASE-MANIFEST.json`.

## Посібники в цій секції

  
- **[Передумови](/docs/getting-started/prerequisites.md)** — Node.js 20+, залізо, ОС, облікові записи Firebase/Google Cloud

  
- **[Встановлення](/docs/getting-started/installation.md)** — Повні шляхи install, env, tunnel, типові проблеми

  
- **[Міграції БД](/docs/getting-started/migrations.md)** — `schema.sql` v4.0.1+, kingdom 002–011, матриця клонів

  
- **[Перший успіх](/docs/getting-started/first-success.md)** — Smoke-test auth, entities, opportunities, API health

  
- **[Усунення несправностей](/docs/getting-started/troubleshooting.md)** — FETCH_FAILED, wallet bootstrap, OAuth redirects

  
- **[Наступні кроки](/docs/getting-started/next-steps.md)** — Admin, перша entity, opportunities, messaging, deploy

## Пов’язана документація

  
- **[Customization quick start](/docs/customization/quick-start.md)** — White-label checklist після першого boot

  
- **[Вибір backend БД](/docs/customization/database-selection.md)** — `k8s-postgres-fcm` vs `supabase-fcm` vs `firebase-full`

  
- **[Локальна розробка](/docs/development/local-setup.md)** — Структура проєкту, тести, Homebrew Postgres

  
- **[Архітектура — backend modes](/docs/architecture/backend-modes-and-databases.md)** — BackendSelector, адаптери, FCM vs Firestore

## Швидка довідка — bootstrap

| Завдання | Команда |
|----------|---------|
| One-command install | `git clone … && ./install.sh --quick` |
| Env wizard | `npm run setup:env` |
| Dev env script | `./scripts/setup-dev.sh` |
| Apply migration | `./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`](https://github.com/connectplatform/ring/blob/main/INSTALL.md) |

**`install.sh`** — перший bootstrap клону (config + `npm install`). **`setup-dev.sh`** — після клону, hardening env. **`npm run setup:env`** — інтерактивний прохід по існуючому `.env.local`.