Об этом проекте

## Обзор Talivia — это open-source платформа аналитики с фокусом на атрибуцию выручки для основателей. Она предоставляет веб-аналитику, Session Replay, функции командной работы, общие панели аналитики, возможности импорта/экспорта, а также прямые подключения к данным о выручке клиентов от платежных процессоров. Проект представляет собой self-hosted подмножество коммерчески размещенного сервиса Talivia Cloud. Managed hosting добавляет интеграции с Google Search Console, Bing Webmaster Tools, активностью GitHub и социальными упоминаниями с таких платформ, как X, Reddit и TikTok. ## Особенности - **Веб-аналитика**: отслеживание визитов через внедряемый JavaScript сниппет. - **Session Replay**: опциональный replay сессий пользователей на сайтах. - **Атрибуция выручки**: жизненный цикл подписки, возвраты, споры, first-touch и last-touch атрибуция. - **Платежные интеграции**: Stripe, LemonSqueezy, Polar, Dodo, Yolfi и Manual Payment API. - **Сотрудничество**: коллеги по сайтам и общие панели аналитики. - **Импорт/экспорт**: миграция данных и workflows резервного копирования. - **Crypto conversions**: опциональное преобразование через CoinGecko. - **AI Agent Kit**: open-source MCP-compatible toolkit для Codex, Claude Code, ChatGPT и других агентов для установки tracking snippet, генерации планов настройки, проверки live events и подключения визитов к платежной атрибуции. ## Технологический стек - Runtime: Node.js 22 LTS или 24 LTS - Package manager: pnpm 10+ - База данных: PostgreSQL - ORM: Prisma - Containerization: Docker Engine с Docker Compose ## Установка ### Локальная разработка 1. Убедитесь, что Node.js 22/24 LTS, pnpm 10+ и свежий экземпляр PostgreSQL доступны. 2. Скопируйте `.env.example` в `.env` и сгенерируйте 32-байтовый secret с помощью `openssl rand -hex 32`. 3. Установите `DATABASE_URL` и `APP_SECRET` в `.env`. 4. Установите зависимости и запустите миграции: ```bash pnpm install --frozen-lockfile pnpm exec prisma migrate deploy pnpm dev ``` 5. Откройте `http://localhost:3000` и войдите как `admin` / `admin`. Немедленно измените bootstrap пароль в разделе **Settings → Account**. ### Docker ```bash cp .env.example .env openssl rand -hex 32 docker compose up --build -d ``` Контейнер автоматически применяет OSS database migration перед запуском приложения. После запуска измените admin пароль по умолчанию. ## Конфигурация | Переменная | Required | Purpose | |---|---|---| | `DATABASE_URL` | Да | PostgreSQL connection string | | `APP_SECRET` | Да | 32-байтовое случайное значение для session signing и credential encryption | | `COINGECKO_API_KEY` | Нет | Включает crypto exchange-rate conversion; приложение остается функциональным без него | ## Первое использование 1. Создайте website entry в Talivia. 2. Вставьте предоставленный tracking snippet на целевой сайт. 3. Убедитесь, что visit появляется на dashboard. 4. Опционально включите Session Replay в настройках сайта. 5. Подключите customer revenue в разделе **Website settings → Payments**. При работе за reverse proxy передавайте оригинальные заголовки `Host` и `X-Forwarded-Proto`, чтобы webhook URLs генерировались корректно. ## Резервное копирование и обновления Резервную копию PostgreSQL базы данных перед обновлением. Для Compose deployments: ```bash docker compose exec -T postgres pg_dump -U talivia -d talivia_oss > talivia-backup.sql ``` Будущие релизы добавляют ordered migrations под `prisma/migrations`. Применяйте их с помощью `pnpm exec prisma migrate deploy`; официальный container запускает это автоматически при старте. Существующие миграции нельзя редактировать. ## AI Agent Kit и MCP Talivia распространяет open-source Agent Kit ([github.com/talivia-group/agent](https://github.com/talivia-group/agent)) совместимый с MCP-enabled клиентами. Agents могут устанавливать tracking, генерировать framework-specific setup plans, проверять live analytics events и отслеживать визиты к платежной атрибуции. - Hosted OAuth endpoint (Talivia Cloud): `https://talivia.com/mcp` - Local stdio mode: `npx -y @talivia/agent mcp` Self-hosted edition не exposes Talivia Cloud OAuth endpoint. ## Безопасность и лицензия Отчетность об уязвимостях и guidance по развертыванию находятся в [SECURITY.md](SECURITY.md). Details workflow разработки в [CONTRIBUTING.md](CONTRIBUTING.md). Talivia выпущена под MIT License. ## Сравнение Talivia позиционирует себя как альтернатива Datafast, подчеркивая built-in revenue attribution и multi-processor payment integrations внутри единой self-hosted deployment.