# Technical Documentation: rybbit-io/rybbit

> ℹ️ **Provenance:** Hybrid Fusion: `rybbit-io/rybbit` (README + 2 In-Tree Chapters) · [CodeWiki Reference](https://codewiki.google/github.com/rybbit-io/rybbit) · Recency: Active (< 180 days)

## 1. Project Overview & Quickstart (rybbit-io/rybbit)

[Rybbit](https://rybbit.com/) is the modern open source and privacy friendly alternative to Google Analytics. It takes only a couple minutes to setup and is super intuitive to use.







<hr>

## 🚀 Getting Started

There are two ways to start using Rybbit:

| Option                                                   | Description                                                   |
| -------------------------------------------------------- | ------------------------------------------------------------- |
| **[Hosted Service](https://rybbit.com)**                 | The fastest way to get started                                |
| **[Self-Hosting](https://rybbit.com/docs/self-hosting)** | Deploy and manage Rybbit on your own VPS for complete control |

📚 Explore our [documentation](https://rybbit.com/docs) to learn more about installation, configuration, and usage.

<hr>

## ✨ Key Features

- All key web analytics metrics including sessions, unique users, pageviews, bounce rate, session duration
- Session replays
- No cookies & privacy friendly
- Customizable goals. retention, user journeys, and funnels dashboards
- Advanced filtering across 15+ dimensions
- Custom events with JSON properties
- 3 level location tracking (country -> region -> city) + advanced map visualizations
- Real time dashboard
- Support for organizations and unlimited number of sites

<hr>

## 📊 Comparison

See how Rybbit compares to other analytics solutions:

| Feature                           | Rybbit | GA4        | Plausible  | Cloudflare |
| --------------------------------- | ------ | ---------- | ---------- | ---------- |
| **Open Source**                   | ✅     | ❌         | ✅         | ❌         |
| **Self-Hosting**                  | ✅     | ❌         | ✅\*       | ❌         |
| **Cookieless & Privacy friendly** | ✅     | ❌         | ✅         | ✅         |
| **Advanced Maps**                 | ✅     | ❌         | ❌         | ❌         |
| **Advanced Filters**              | ✅     | ⚠️ Limited | ⚠️ Limited | ❌         |
| **Web Vitals**                    | ✅\*\* | ❌         | ❌         | ❌         |
| **Session Details**               | ✅     | ❌         | ❌         | ❌         |
| **User Profiles**                 | ✅     | ❌         | ❌         | ❌         |
| **Session Replays**               | ✅     | ❌         | ❌         | ❌         |
| **Funnels**                       | ✅     | ✅         | ✅\*\*     | ❌         |
| **User Journeys**                 | ✅     | ✅         | ❌         | ❌         |
| **Retention Analysis**            | ✅     | ✅         | ❌         | ❌         |
| **Goals & Events**                | ✅     | ✅         | ✅         | ❌         |
| **Real-time Dashboard**           | ✅     | ✅         | ✅         | ✅         |
| **Custom Events (JSON)**          | ✅     | ✅         | ⚠️ Limited | ❌         |
| **Error Tracking**                | ✅     | ❌         | ❌         | ❌         |
| **Public Dashboards**             | ✅     | ❌         | ✅         | ❌         |
| **Organizations**                 | ✅     | ✅         | ✅         | ✅         |
| **Frog 🐸**                       | ✅     | ❌         | ❌         | ❌         |

\* Plausible's Community Edition has very limited features compared to their cloud version

\*\* Only available on paid tiers

<hr>

## 📊 Dashboard Preview

### Map






## Session Replay



### Journeys



### Funnels



### Goals



### Users



### Errors



### Retention



### Web Vitals (Cloud only)



<hr>

## ⭐ Star History

[](https://www.star-history.com/#rybbit-io/rybbit&Date)

## 2. In-Tree Documentation Chapters (rybbit-io/rybbit)

## File: README.md

[Rybbit](https://rybbit.com/) is the modern open source and privacy friendly alternative to Google Analytics. It takes only a couple minutes to setup and is super intuitive to use.







<hr>

## 🚀 Getting Started

There are two ways to start using Rybbit:

| Option                                                   | Description                                                   |
| -------------------------------------------------------- | ------------------------------------------------------------- |
| **[Hosted Service](https://rybbit.com)**                 | The fastest way to get started                                |
| **[Self-Hosting](https://rybbit.com/docs/self-hosting)** | Deploy and manage Rybbit on your own VPS for complete control |

📚 Explore our [documentation](https://rybbit.com/docs) to learn more about installation, configuration, and usage.

<hr>

## ✨ Key Features

- All key web analytics metrics including sessions, unique users, pageviews, bounce rate, session duration
- Session replays
- No cookies & privacy friendly
- Customizable goals. retention, user journeys, and funnels dashboards
- Advanced filtering across 15+ dimensions
- Custom events with JSON properties
- 3 level location tracking (country -> region -> city) + advanced map visualizations
- Real time dashboard
- Support for organizations and unlimited number of sites

<hr>

## 📊 Comparison

See how Rybbit compares to other analytics solutions:

| Feature                           | Rybbit | GA4        | Plausible  | Cloudflare |
| --------------------------------- | ------ | ---------- | ---------- | ---------- |
| **Open Source**                   | ✅     | ❌         | ✅         | ❌         |
| **Self-Hosting**                  | ✅     | ❌         | ✅\*       | ❌         |
| **Cookieless & Privacy friendly** | ✅     | ❌         | ✅         | ✅         |
| **Advanced Maps**                 | ✅     | ❌         | ❌         | ❌         |
| **Advanced Filters**              | ✅     | ⚠️ Limited | ⚠️ Limited | ❌         |
| **Web Vitals**                    | ✅\*\* | ❌         | ❌         | ❌         |
| **Session Details**               | ✅     | ❌         | ❌         | ❌         |
| **User Profiles**                 | ✅     | ❌         | ❌         | ❌         |
| **Session Replays**               | ✅     | ❌         | ❌         | ❌         |
| **Funnels**                       | ✅     | ✅         | ✅\*\*     | ❌         |
| **User Journeys**                 | ✅     | ✅         | ❌         | ❌         |
| **Retention Analysis**            | ✅     | ✅         | ❌         | ❌         |
| **Goals & Events**                | ✅     | ✅         | ✅         | ❌         |
| **Real-time Dashboard**           | ✅     | ✅         | ✅         | ✅         |
| **Custom Events (JSON)**          | ✅     | ✅         | ⚠️ Limited | ❌         |
| **Error Tracking**                | ✅     | ❌         | ❌         | ❌         |
| **Public Dashboards**             | ✅     | ❌         | ✅         | ❌         |
| **Organizations**                 | ✅     | ✅         | ✅         | ✅         |
| **Frog 🐸**                       | ✅     | ❌         | ❌         | ❌         |

\* Plausible's Community Edition has very limited features compared to their cloud version

\*\* Only available on paid tiers

<hr>

## 📊 Dashboard Preview

### Map






## Session Replay



### Journeys



### Funnels



### Goals



### Users



### Errors



### Retention



### Web Vitals (Cloud only)



<hr>

## ⭐ Star History

[](https://www.star-history.com/#rybbit-io/rybbit&Date)

---

## File: docs/README.md

# docs-v2

This is a Next.js application generated with
[Create Fumadocs](https://github.com/fuma-nama/fumadocs).

Run development server:

```bash
npm run dev
# or
pnpm dev
# or
yarn dev
```

Open http://localhost:3000 with your browser to see the result.

## Explore

In the project, you can see:

- `lib/source.ts`: Code for content source adapter, [`loader()`](https://fumadocs.dev/docs/headless/source-api) provides the interface to access your content.
- `app/layout.config.tsx`: Shared options for layouts, optional but preferred to keep.

| Route                     | Description                                            |
| ------------------------- | ------------------------------------------------------ |
| `app/(home)`              | The route group for your landing page and other pages. |
| `app/docs`                | The documentation layout and pages.                    |
| `app/api/search/route.ts` | The Route Handler for search.                          |

### Fumadocs MDX

A `source.config.ts` config file has been included, you can customise different options like frontmatter schema.

Read the [Introduction](https://fumadocs.dev/docs/mdx) for further details.

## Learn More

To learn more about Next.js and Fumadocs, take a look at the following
resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js
  features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
- [Fumadocs](https://fumadocs.vercel.app) - learn about Fumadocs

--- METRICS ---
- Files Extracted: 3
- Estimated Token Budget: ~2215 tokens
- Recency Window: Active (< 180 days)
- Canonical Reference: https://codewiki.google/github.com/rybbit-io/rybbit