Service: Rybbit - EyevinnOSC/community GitHub Wiki
Rybbit (serviceId rybbit-io-rybbit) is an open source (AGPL-3.0), privacy-friendly alternative to Google Analytics with real-time dashboards, session replay, custom events, funnels and geographic tracking. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance that needs a PostgreSQL and a ClickHouse database. Source: rybbit-io/rybbit.
- Collect and show web analytics: pageviews, events, sessions, funnels and real-time dashboards.
- Record session replays.
- Show geographic analytics (country, region, city) and map visualizations when a Mapbox token is configured.
- Run privately: sign-up can be disabled so only invited users can access it.
Create the dependencies first and confirm they are running:
-
PostgreSQL (serviceId
birme-osc-postgresql) for application metadata (user accounts, site configuration, organization settings). Note the user, password and database name you set. -
ClickHouse (serviceId
clickhouse-clickhouse) for analytics data. Do not set a ClickHouse user, so it uses thedefaultuser: Rybbit uses thedefaultusername and has no option to change it. Set a password, because Rybbit requiresClickhousePassword. Usedescribe-service-instanceto get the ClickHouse instance URL, which looks likehttps://<name>.clickhouse-clickhouse.auto.prod-se.osaas.io. - Optionally Valkey (serviceId
valkey-io-valkey) for caching and queues.
Create service secrets with create-service-secret on serviceId rybbit-io-rybbit for the passwords and for BetterAuthSecret, a long random string you can generate with openssl rand -hex 32. Then call create-service-instance with serviceId: "rybbit-io-rybbit":
{
"name": "myrybbit",
"PostgresHost": "<postgres-host>",
"PostgresPort": "<postgres-port>",
"PostgresUser": "<postgres-user>",
"PostgresPassword": "{{secrets.pgpassword}}",
"PostgresDb": "<postgres-db>",
"ClickhouseHost": "https://<name>.clickhouse-clickhouse.auto.prod-se.osaas.io",
"ClickhousePassword": "{{secrets.chpassword}}",
"BetterAuthSecret": "{{secrets.rybbitauth}}"
}Wait for the instance to be running (wait-for-service-ready) and use describe-service-instance for the URL. Open it, create your first admin account and start adding websites to track.
Common mistakes:
-
ClickhouseHostmust be a full URL with protocol. A bare IP such as203.0.113.10makes the app crash with "ClickHouse URL is malformed". - Creating the ClickHouse instance with a custom user means Rybbit cannot authenticate; leave the user empty.
-
ClickhousePasswordmust match the password set on thedefaultuser of the ClickHouse instance.
| Option | Required | Type | Meaning |
|---|---|---|---|
| name | Yes | string | Name of the instance. Alphanumeric, at most 20 characters. |
| PostgresHost | Yes | string | Hostname or IP address of the PostgreSQL server, used for user accounts, site configuration and organization settings. |
| PostgresPort | No | string | Port of the PostgreSQL server. Defaults to 5432. |
| PostgresUser | Yes | string | PostgreSQL user. It needs permission to create, read, update and delete data in the database. |
| PostgresPassword | Yes | string, sensitive | Password of the PostgreSQL user. |
| PostgresDb | Yes | string | Name of the PostgreSQL database Rybbit uses for its application data. |
| ClickhouseHost | Yes | string | Full URL of the ClickHouse server (see above), used for high-volume analytics data (pageviews, events, sessions). Not a bare IP address. |
| ClickhouseDb | No | string | ClickHouse database for analytics data. Defaults to default if not set. |
| ClickhousePassword | Yes | string, sensitive | Password of the ClickHouse default user. |
| BetterAuthSecret | Yes | string, sensitive | Secret used by Rybbit's authentication system to encrypt and sign tokens and sessions. A long random string, unique to your installation. |
| RedisHost | No | string | Hostname of a Redis-compatible server, used for caching, session storage and queues. Optional, recommended for production. |
| RedisPort | No | string | Port of the Redis server. Defaults to 6379. |
| RedisPassword | No | string, sensitive | Password of the Redis server, if authentication is enabled. |
| DisableSignup | No | boolean | When true, new users cannot create accounts through sign-up. Useful for private installations. |
| MapboxToken | No | string | Mapbox API token enabling the advanced map visualizations (interactive globe, location maps down to city level). |
| ResendApiKey | No | string, sensitive | Resend API key for transactional emails such as password resets and invitations. Without it, email-dependent features may not work. |
Sensitive options (PostgresPassword, ClickhousePassword, BetterAuthSecret, RedisPassword, ResendApiKey) should be service secrets passed as {{secrets.NAME}} as the whole field value. Changing a secret later does not restart a running instance.