> ## Documentation Index
> Fetch the complete documentation index at: https://docs.veristar.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Veristar

> Privacy-friendly web and API analytics for projects building on Stellar, run as a shared and free service.

Veristar gives projects in the Stellar ecosystem clear numbers about how their sites and APIs are
used, without cookies and without storing anyone's IP address. It runs as one shared service for
the Stellar Community Fund (SCF): every project gets private dashboards of its own traffic, and
SCF operators get a cross-project view built from aggregates.

The service is free. No fees are charged to projects or to anyone else.

## What you get

> [card] [Web analytics](https://docs.veristar.app/onboarding/web/quickstart.md)
>
> Pageviews, visitors, visits, visit duration, bounce rate, referrers, countries, devices and
> browsers from one script tag, with custom events when you want them.

> [card] [API analytics](https://docs.veristar.app/onboarding/api/quickstart.md)
>
> Request volume, status codes and latency percentiles per service, method and route, sent by
> your backend with OpenTelemetry next to the tools you already use.

> [card] [Privacy by design](https://docs.veristar.app/compliance/privacy-strategy.md)
>
> No cookies, no stored IP addresses, and visitor counts based on a daily secret that is
> destroyed at midnight UTC.

> [card] [Open and verifiable](https://docs.veristar.app/security/verify-tracker.md)
>
> Open source from tracker to infrastructure, with version-pinned tracker files you can check
> byte for byte.

## Who it is for

* **Project teams (tenants)** building on Stellar who want to understand the use of their sites,
  dapps and APIs. Start with the [tenant guides](https://docs.veristar.app/onboarding/overview.md).
* **SCF operators** who review projects and compare them on shared metrics for funding and
  ecosystem decisions. Start with the [operator guide](https://docs.veristar.app/operators/overview.md).
* **Whoever runs the service**, today or after a handover. Start with
  [deploy and operate](https://docs.veristar.app/deploy/overview.md) and the [runbooks](https://docs.veristar.app/runbooks/overview.md).

## How to start

**1. Sign in and enroll your project**

Sign in to the console with GitHub and enroll your project. The console shows the addresses
of the service you use; the guides use the example domain `analytics.example`.

**2. Add web analytics**

Register a site, copy its script tag into your pages and open your dashboard. The
[web quickstart](https://docs.veristar.app/onboarding/web/quickstart.md) walks through it, and there is a guide for each
common framework.

**3. Add API analytics**

Create an OTLP token and add a second exporter to your application. The
[API quickstart](https://docs.veristar.app/onboarding/api/quickstart.md) explains the setup, and there are guides for
Node.js, Python, Go and Rust.

**4. Get help**

Questions and problems go to the public issue tracker, as described in [support](https://docs.veristar.app/support.md).

## Learn more

> [card] [How it works](https://docs.veristar.app/how-it-works.md)
>
> The path an event takes from a page or an app to a dashboard.

> [card] [Architecture](https://docs.veristar.app/architecture.md)
>
> The services, hosts, queues and stores, with diagrams.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.