Skip to content

🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.

Add account, organization, and subscription settings to meta.json; enhance site settings documentation

Bill Yang25ecac493493
diff --git a/docs/content/docs/account-settings.mdx b/docs/content/docs/account-settings.mdx
new file mode 100644
index 000000000..f34e3f575
--- /dev/null
+++ b/docs/content/docs/account-settings.mdx
@@ -0,0 +1,69 @@
+---
+title: Account settings
+description: Manage your personal account settings including profile, security, and API keys
+---
+
+import { Callout } from 'fumadocs-ui/components/callout';
+
+Access your account settings by clicking your profile icon and selecting "Account Settings".
+
+![account settings](/docs/account-settings.png)
+
+## Account
+
+### Name
+
+Update your display name shown across the platform. This name is visible to other members in your organization.
+
+### Email
+
+Update your email address for account notifications and login. This is the primary email associated with your account.
+
+### Weekly Email Reports <span className="text-green-500 text-sm">(Cloud)</span>
+
+Enable or disable automatic weekly email reports. When enabled, you'll receive a summary of your analytics performance delivered to your inbox each week.
+
+### Sign Out
+
+Sign out of your current session.
+
+## Security
+
+### Change Password
+
+Update your password to keep your account secure.
+
+### Delete Account
+
+Permanently delete your account and all associated data.
+
+<Callout type="warn">
+ This action cannot be undone. If you have an active subscription, you must cancel it before deleting your account.
+</Callout>
+
+## API Keys
+
+Generate API keys to access Rybbit's analytics endpoints from your applications.
+
+### Creating an API Key
+
+1. Enter a name for your API key (e.g., "Production App", "Development")
+2. Click "Create"
+3. Copy and save the generated key immediately
+
+<Callout type="warn">
+ API keys are only shown once when created. Store your key securely as you won't be able to view it again.
+</Callout>
+
+### Managing API Keys
+
+Your existing API keys are displayed in a table showing:
+- **Name** - The name you assigned to the key
+- **Key** - A preview of the key (first few characters)
+- **Created** - When the key was created
+
+You can delete API keys that are no longer needed. Deleting a key immediately revokes access for any applications using it.
+
+### Using API Keys
+
+Include your API key in requests to Rybbit's API endpoints. See the [API documentation](/docs/api) for available endpoints and usage examples.
diff --git a/docs/content/docs/meta.json b/docs/content/docs/meta.json
index 1a540de07..24f563233 100644
--- a/docs/content/docs/meta.json
+++ b/docs/content/docs/meta.json
@@ -26,6 +26,9 @@
"self-hosting-guides",
"v1-migration",
"---Settings---",
+ "account-settings",
+ "organization-settings",
+ "subscription-settings",
"inviting-users",
"site-settings",
"data-import",
diff --git a/docs/content/docs/organization-settings.mdx b/docs/content/docs/organization-settings.mdx
new file mode 100644
index 000000000..871917834
--- /dev/null
+++ b/docs/content/docs/organization-settings.mdx
@@ -0,0 +1,45 @@
+---
+title: Organization settings
+description: Manage your organization, team members, roles, and permissions
+---
+
+import { Callout } from 'fumadocs-ui/components/callout';
+
+Access organization settings by clicking your profile icon and selecting "Organization Settings".
+
+![organization settings](/docs/organization-settings.png)
+
+## Organization
+
+### Organization Name
+
+Update your organization's display name. Only the organization owner can change this setting.
+
+### Delete Organization
+
+Permanently delete the organization and all associated data including sites, analytics, reports, and member associations.
+
+<Callout type="warn">
+ This action cannot be undone. You must type the organization name to confirm deletion. If you have an active subscription, you must cancel it before deleting the organization.
+</Callout>
+
+## Members
+
+View and manage all members in your organization. The members table shows:
+- **Name** - Member's display name
+- **Email** - Member's email address
+- **Role** - Owner, Admin, or Member
+- **Site Access** - Which sites the member can access
+- **Joined** - When they joined the organization
+
+### Member Roles
+
+| Role | Permissions |
+|------|-------------|
+| **Owner** | Full access to all features, can manage members, billing, and delete the organization |
+| **Admin** | Can manage members and access all sites, cannot delete the organization or manage billing |
+| **Member** | Can view analytics for assigned sites only, cannot manage settings or other members |
+
+### Inviting Members
+
+Owners can invite new members or create user accounts. See the [Inviting Users](/docs/inviting-users) guide for detailed instructions.
diff --git a/docs/content/docs/site-settings.mdx b/docs/content/docs/site-settings.mdx
index 49f3f08c6..06517f94d 100644
--- a/docs/content/docs/site-settings.mdx
+++ b/docs/content/docs/site-settings.mdx
@@ -1,58 +1,109 @@
---
title: Site settings
-description: Configure your site settings including public analytics, privacy options, domain changes, and site management
+description: Configure your site settings including privacy options, analytics features, traffic filtering, and more
---
-import Image from "next/image";
import { Callout } from 'fumadocs-ui/components/callout';
-Access your site settings by navigating to the settings page in your site's Rybbit dashboard.
+Access your site settings by clicking the settings icon in your site's Rybbit dashboard.
-<Image src="/settings.png" alt="Site Settings" width={500} height={500} />
+![site settings](/docs/site-settings.png)
-## Public Analytics
+## Privacy & Security
-You can make your analytics public by enabling the "Public Analytics" option in your site settings. Once enabled, you can share the page link with anyone.
+### Public Analytics
-- External viewers will not be able to edit any of your settings or add/remove/edit any existing reports, funnels, or goals
-- Your other websites will not be affected
-- Viewers have read-only access to your analytics data
+Make your analytics publicly accessible by enabling the "Public Analytics" toggle.
-## Enhanced Privacy (User ID Salting)
+- External viewers have read-only access to your analytics data
+- Viewers cannot edit settings, reports, funnels, or goals
+- Your other websites are not affected
-Rybbit stores user IDs as a hashed combination of IP + user agent. This allows us to identify users across many sessions on the same device, but can be seen as storing personally identifiable data under GDPR.
+### User ID Salting
-You can enable enhanced privacy by turning on the "User ID Salting" option in your site settings.
+Rybbit stores user IDs as a hashed combination of IP + user agent. This allows identifying users across sessions, but may be considered storing personally identifiable data under GDPR.
-When enabled, Rybbit will forget about unique users every day. If a user visits your site 10 times in one day, Rybbit will count that as one user with 10 sessions. But if they visit once a day for 10 days, they will be seen as a new user every day.
+Enable "User ID Salting" to have Rybbit forget about unique users every day. If a user visits 10 times in one day, they count as one user with 10 sessions. But if they visit once a day for 10 days, they appear as a new user each day.
-### Downsides of enabling user ID salting:
+**Downsides of enabling user ID salting:**
+- User session history beyond 24 hours is not available
+- Unique user counts over periods longer than 24 hours will be inflated
+- The user retention page becomes effectively useless
-- You will no longer see user session history beyond 24 hours
-- Unique user count over a period longer than 24 hours will be inflated
-- The user retention page will effectively be useless
+### Block Bot Traffic
+
+Enable "Block Bot Traffic" to prevent traffic from known bots and crawlers from being tracked in your analytics.
+
+### Track IP Address
+
+Enable "Track IP Address" to store the IP address of visitors.
+
+<Callout type="warn">
+ This is not GDPR compliant. Only enable if you have a legitimate need and proper consent mechanisms in place.
+</Callout>
+
+## Analytics Features
+
+### Session Replay <span className="text-green-500 text-sm">(Pro)</span>
+
+Record and replay user sessions to understand user behavior. This feature allows you to see exactly how users interact with your site.
+
+### Web Vitals <span className="text-green-500 text-sm">(Standard)</span>
+
+Track Core Web Vitals metrics including:
+- **LCP** (Largest Contentful Paint)
+- **CLS** (Cumulative Layout Shift)
+- **INP** (Interaction to Next Paint)
+- **FCP** (First Contentful Paint)
+- **TTFB** (Time to First Byte)
+
+### Error Tracking <span className="text-green-500 text-sm">(Standard)</span>
+
+Capture JavaScript errors and exceptions from your site to identify and fix issues affecting your users.
+
+### Track Outbound Links
+
+Track when users click on external links leaving your site. Enabled by default.
+
+### Track URL Parameters
+
+Include query string parameters in page tracking. Enabled by default. Disable if you want cleaner URLs in your analytics or need to exclude sensitive parameters.
+
+### Track Initial Page View
+
+Automatically track the first page view when the tracking script loads. Enabled by default.
+
+### Track SPA Navigation
+
+Automatically track navigation in single-page applications (SPAs). Enabled by default. This detects URL changes via the History API and tracks them as page views.
## Traffic Filtering
-You can filter unwanted traffic from your analytics using IP and country exclusions. See the [Filter Traffic](/docs/filter-traffic) guide for detailed information on:
+### IP Exclusions
+
+Block specific IP addresses or ranges from being tracked. Supports:
+- Individual IP addresses (e.g., `192.168.1.1`)
+- CIDR notation (e.g., `192.168.1.0/24`)
+- IPv4 ranges (e.g., `192.168.1.1-192.168.1.255`)
-- **IP Exclusions**: Block specific IP addresses or ranges (supports CIDR notation and IPv4 ranges)
-- **Country Exclusions**: Block all traffic from specific countries using ISO country codes
+### Country Exclusions
+
+Block all traffic from specific countries using ISO country codes (e.g., `US`, `DE`, `FR`).
Both filtering methods work at the server level, ensuring blocked traffic never reaches your analytics database.
-## Changing Domains
+## Google Search Console <span className="text-green-500 text-sm">(Cloud)</span>
+
+Connect your Google Search Console account to see search performance data alongside your analytics.
-You can update the domain of your site directly from the settings page.
+## Change Domain
-- Changing domains will not affect any existing data
-- All historical analytics will be preserved
-- Currently we only support one domain per site
+Update the domain for your site. Changing domains does not affect existing data - all historical analytics are preserved.
-## Deleting Sites
+## Delete Site
-You can permanently delete a site by clicking the "Delete Site" button in the settings page.
+Permanently delete a site and all associated data.
<Callout type="warn">
- This action will delete all data associated with the site and cannot be undone.
-</Callout>
\ No newline at end of file
+ This action cannot be undone. All analytics data, reports, funnels, and goals will be permanently deleted.
+</Callout>
diff --git a/docs/content/docs/subscription-settings.mdx b/docs/content/docs/subscription-settings.mdx
new file mode 100644
index 000000000..dfa2c1fdd
--- /dev/null
+++ b/docs/content/docs/subscription-settings.mdx
@@ -0,0 +1,11 @@
+---
+title: Subscription settings
+description: Manage your subscription, billing, and usage for Rybbit Cloud
+---
+
+import { Callout } from 'fumadocs-ui/components/callout';
+
+Access subscription settings by hovering over the sidebar and clicking "Subscription".
+
+Subscriptions are scoped to a single organization. If you have multiple organizations, each one requires its own subscription. Switching organizations will show that organization's subscription status.
+
diff --git a/docs/public/dashboard.png b/docs/public/dashboard.png
deleted file mode 100644
index c87478992..000000000
Binary files a/docs/public/dashboard.png and /dev/null differ
diff --git a/docs/public/docs/account-settings.png b/docs/public/docs/account-settings.png
new file mode 100644
index 000000000..4eaf0ca3d
Binary files /dev/null and b/docs/public/docs/account-settings.png differ
diff --git a/docs/public/docs/organization-settings.png b/docs/public/docs/organization-settings.png
new file mode 100644
index 000000000..9eefb1349
Binary files /dev/null and b/docs/public/docs/organization-settings.png differ
diff --git a/docs/public/docs/site-settings.png b/docs/public/docs/site-settings.png
new file mode 100644
index 000000000..43173d84a
Binary files /dev/null and b/docs/public/docs/site-settings.png differ
diff --git a/docs/public/settings.png b/docs/public/settings.png
deleted file mode 100644
index 1052647b9..000000000
Binary files a/docs/public/settings.png and /dev/null differ
diff --git a/docs/src/mdx-components.tsx b/docs/src/mdx-components.tsx
index 65c8e66cf..9d2d49eb2 100644
--- a/docs/src/mdx-components.tsx
+++ b/docs/src/mdx-components.tsx
@@ -1,7 +1,8 @@
-import defaultMdxComponents from 'fumadocs-ui/mdx';
-import type { MDXComponents } from 'mdx/types';
-import { Mermaid } from '@/components/Mermaid';
-import * as TabsComponents from 'fumadocs-ui/components/tabs';
+import defaultMdxComponents from "fumadocs-ui/mdx";
+import type { MDXComponents } from "mdx/types";
+import { Mermaid } from "@/components/Mermaid";
+import * as TabsComponents from "fumadocs-ui/components/tabs";
+import { ImageZoom } from "fumadocs-ui/components/image-zoom";
// use this function to get MDX components, you will need it for rendering MDX
export function getMDXComponents(components?: MDXComponents): MDXComponents {
@@ -9,6 +10,7 @@ export function getMDXComponents(components?: MDXComponents): MDXComponents {
...defaultMdxComponents,
...TabsComponents,
Mermaid,
+ img: props => <ImageZoom {...(props as any)} />,
...components,
};
}