**English** | [简体中文](README.zh.md)

<p align="center">
  <img src="assets/banner-en.png" alt="AngusInsight — Know Your Users, Grow Your Product" width="100%" />
</p>

<p align="center">
  <a href="https://www.anguskit.com/en/pricing"><img alt="Community Edition" src="https://img.shields.io/badge/Community-Free-3d7a5a"></a>
  <a href="LICENSE"><img alt="License" src="https://img.shields.io/badge/License-GPL--3.0-blue"></a>
  <a href="https://www.anguskit.com/en/docs/insight"><img alt="Docs" src="https://img.shields.io/badge/docs-anguskit.com-3d7a5a"></a>
  <a href="https://www.anguskit.com"><img alt="Website" src="https://img.shields.io/badge/website-anguskit.com-c96128"></a>
</p>

# AngusInsight

**Know Your Users, Grow Your Product. Private Analytics, Zero Compromise.**

Private Product Analytics — the Analyze product in [AngusKit](https://github.com/AngusKit/AngusKit).

> **This repository hosts documentation only.** AngusInsight source code is distributed through private deployment packages, not through this GitHub repository. Earlier revisions of this repository contained application source; as of this update, distribution has moved to AngusKit's packaging pipeline (see [Get the Community Edition](#get-the-community-edition-free) below). This repository now focuses on product information, quickstart guides, and links to the full documentation site.

## What is AngusInsight

AngusInsight is lightweight user-behavior analytics for enterprise and internal products, built to run entirely on infrastructure you control. Events land in your own database — dashboards, funnels, and error monitoring run on-prem, turning real post-release usage into insight without shipping behavior data to a public cloud.

<sub>AngusInsight is private-deployment only — it is not offered as a hosted SaaS.</sub>

## Key capabilities

- **Lightweight SDK** — fast Web/H5 install with PV, custom events, conversions, and `identify` out of the box; automatic SPA capture
- **Dashboard & realtime** — PV/UV/session overview and trends, plus a realtime window for online users and event streams
- **China channel rules** — UTM, referrer, and common click-ID rules assign channel codes; compare campaigns by campaign ID
- **Conversion funnels** — multi-step ordered event funnels with per-step pass rates and drop-off highlights
- **Paths & user timeline** — in-session page-path Sankey diagrams and single-user event-sequence reconstruction
- **Errors in the same stack** — JS, resource, and API errors captured and grouped alongside behavior data

## Screenshot

<p align="center">
  <img src="assets/screenshot-en.png" alt="AngusInsight console" width="100%" />
</p>

## Get the Community Edition (free)

About **250 MB**. This zip is **AngusGM + AngusInsight**. At least **2 cores / 4 GB** RAM and **40 GB** disk (more when event volume is high). Docker Engine + Compose v2.

This first-run path matches the official docs: Docker Compose, the install wizard, **access mode 2** (bundled Caddy), HTTP `:80` (no certificate).

1. Resolve names to this machine (or add to `/etc/hosts` for a local trial). Public DNS name in the wizard is the **suffix** (e.g. `example.com`), not `gm.example.com`.

```bash
127.0.0.1 gm.example.com insight.example.com
```

Open host **80**. App ports stay behind the proxy — do not use `localhost:8801`. Stop Nginx/Caddy/IIS if they already bind 80. On macOS + Docker Desktop, do not run `./install.sh` with `sudo`.

2. Download, unzip, and run the wizard from the package root:

```bash
curl --fail --location --progress-bar -o AngusInsight-Community-1.0.0.zip \
  https://repo.anguskit.com/raw/raw-public/AngusKit/insight/AngusInsight-Community-1.0.0.zip
unzip AngusInsight-Community-1.0.0.zip
cd AngusInsight-1.0.0
./install.sh
```

Answer: Install mode `1` (Compose) → Access **`2`** (bundled reverse proxy — do not press Enter) → Proxy `1` (Caddy) → TLS **`4`** (HTTP `:80`, no certificate) → Database `1` (MySQL 8 in Compose) → Public DNS name = `example.com` → set admin password (default user `admin`). Wait for `Install finished.`

3. Confirm health, then open the console:

```bash
./bin/angusctl.sh doctor
```

Look for `doctor: OK`. Open `http://gm.example.com/`, sign in, then open `http://insight.example.com/`. Collect URL on this path: `http://insight.example.com/pubapi/v1/collect`.

Need the full suite? Use `AngusKit-Community-1.0.0.zip` from [AngusKit](https://github.com/AngusKit/AngusKit).

First-run guide: **[insight quickstart](https://www.anguskit.com/en/docs/insight/get-started/quickstart)** · Full install (host ZIP, Helm preview, TLS, offline): **[install docs](https://www.anguskit.com/en/docs/insight/latest/en/manual/02-install-deploy)**

## Community vs. Team / Enterprise

| | Community | Team / Enterprise |
|---|---|---|
| Price | Free | Paid, private deployment |
| Users | Up to 10 | Higher / unlimited seats |
| Apps | Up to 5 | Higher / unlimited |
| Data retention | 30 days | Longer / configurable |
| Funnels, path analysis, advanced error rules, MCP | Not included | Included |
| Delivery model | Private deployment only | Private deployment only |

Community Edition source is licensed under GPL-3.0 and distributed with each Community installation package. Team and Enterprise editions are proprietary, governed by the **[XCan Business License, Version 1.0](https://www.anguskit.com/licenses/XCBL-1.0)** (XCBL-1.0), distributed only under a paid subscription.

Full pricing and feature comparison: **[anguskit.com/pricing](https://www.anguskit.com/en/pricing)**

## Related AngusKit products

| Product | Focus | Repository |
|---|---|---|
| AngusKit | The full suite (this product + 5 others + AngusGM) | [AngusKit/AngusKit](https://github.com/AngusKit/AngusKit) |
| AngusAI | AI agent development | [AngusKit/AngusAI](https://github.com/AngusKit/AngusAI) |
| AngusGit | AI-native code collaboration | [AngusKit/AngusGit](https://github.com/AngusKit/AngusGit) |
| AngusRepo | Universal artifact management | [AngusKit/AngusRepo](https://github.com/AngusKit/AngusRepo) |
| AngusTester | AI-native software testing | [AngusKit/AngusTester](https://github.com/AngusKit/AngusTester) |
| AngusSecurity | Application security & governance | [AngusKit/AngusSecurity](https://github.com/AngusKit/AngusSecurity) |

## Documentation & support

- Full docs: [anguskit.com/docs/insight](https://www.anguskit.com/en/docs/insight)
- Contact / sales: [anguskit.com/contact](https://www.anguskit.com/en/contact) · `sales@anguskit.com`
- This repository's Issues are for **documentation feedback and install troubleshooting**. This repository does not accept source code pull requests — see [CONTRIBUTING.md](CONTRIBUTING.md).

## License

- This repository's documentation content: see [LICENSE](LICENSE) (GPL-3.0, matching the Community Edition source it describes).
- AngusInsight Community Edition product source: GPL-3.0, distributed with each Community installation package.
- AngusInsight Team / Enterprise Edition: proprietary, [XCan Business License, Version 1.0](LICENSE-XCBL-1.0) (XCBL-1.0) — see https://www.anguskit.com/licenses/XCBL-1.0. Distributed under a paid subscription only.