Skip to content

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

Update documentation for integrating Rybbit Analytics across various platforms

Bill Yangd91277a6c212
diff --git a/docs-v2/content/docs/guides/drupal.mdx b/docs-v2/content/docs/guides/drupal.mdx
index c06c6d103..205b9ffbf 100644
--- a/docs-v2/content/docs/guides/drupal.mdx
+++ b/docs-v2/content/docs/guides/drupal.mdx
@@ -3,12 +3,14 @@ title: Drupal
description: Integrate Rybbit Analytics with your Drupal site using theme files or modules
---
+import { Steps, Step } from 'fumadocs-ui/components/steps';
import { Callout } from 'fumadocs-ui/components/callout';
-
Integrating Rybbit Analytics with your Drupal site can be done by adding the tracking script to your theme or by using a module that allows adding custom JavaScript.
-## 1. Get Your Tracking Script
+<Steps>
+<Step>
+### Get Your Tracking Script
First, you'll need your Rybbit tracking script. You can find this in your Rybbit dashboard under **Site Settings > Tracking Code**. It will look something like this:
@@ -17,18 +19,26 @@ First, you'll need your Rybbit tracking script. You can find this in your Rybbit
```
Replace `YOUR_SITE_ID` with your actual Site ID from your Rybbit dashboard.
+</Step>
+</Steps>
## Method 1: Adding to Your Theme (Recommended for Themers)
If you are comfortable editing your Drupal theme files, this is a direct way to add the script.
-**a. Locate your theme's `html.html.twig` file:**
+<Steps>
+<Step>
+### Locate your theme's `html.html.twig` file
+
This file is responsible for the overall HTML structure of your pages. You can typically find it in your active theme's directory:
`themes/custom/your_theme_name/templates/layout/html.html.twig`
If your custom theme doesn't have one, you might need to copy it from your base theme (e.g., Stable, Classy) or from Drupal core (`core/themes/stable/templates/layout/html.html.twig`).
+</Step>
+
+<Step>
+### Add the script
-**b. Add the script:**
Open the `html.html.twig` file and paste the Rybbit tracking script just before the closing `</body>` tag.
```twig
@@ -50,22 +60,37 @@ Modify it to include the script:
</html>
```
Replace `YOUR_SITE_ID` with your actual Site ID.
+</Step>
+
+<Step>
+### Clear Drupal Caches
-**c. Clear Drupal Caches:**
After adding the script, you must clear Drupal's caches for the changes to take effect.
- Go to **Manage > Configuration > Development > Performance** (e.g., `/admin/config/development/performance`).
- Click the **Clear all caches** button.
- Alternatively, use Drush: `drush cr`
+</Step>
+</Steps>
+
+<Callout type="warn">
+ Be cautious when adding scripts directly to `html.html.twig` if you are not using a custom theme, as core or contrib theme updates might overwrite your changes. Creating a sub-theme is best practice.
+</Callout>
## Method 2: Using a Module (e.g., "Asset Injector")
For users less comfortable with code, or for more flexible management, a module like [Asset Injector](https://www.drupal.org/project/asset_injector) can be used.
-**a. Install and Enable Asset Injector:**
+<Steps>
+<Step>
+### Install and Enable Asset Injector
+
- Download and install the Asset Injector module from Drupal.org.
- Enable the module via **Manage > Extend** (`/admin/modules`).
+</Step>
+
+<Step>
+### Add a JavaScript Asset
-**b. Add a JavaScript Asset:**
- Go to **Manage > Configuration > Development > Asset Injector** (`/admin/config/development/asset-injector`).
- Click on **JS injector**.
- Click **+ Add JS inject**.
@@ -74,19 +99,26 @@ For users less comfortable with code, or for more flexible management, a module
- **Pages:** Configure where the script should appear. For sitewide tracking, you might select "Add on every page except the listed pages" and leave the list empty, or use specific conditions if needed.
- **Preprocess JavaScript:** Usually, you can leave this unchecked for external scripts.
- **Scope:** Select **Footer** to add the script to the bottom of the page.
+</Step>
+
+<Step>
+### Save and Clear Caches
-**c. Save and Clear Caches:**
- Save the asset.
- Clear Drupal's caches as described in Method 1.
+</Step>
+</Steps>
-<Callout type="warn">
- Be cautious when adding scripts directly to `html.html.twig` if you are not using a custom theme, as core or contrib theme updates might overwrite your changes. Creating a sub-theme is best practice.
-</Callout>
+## Verify Integration
-## 3. Verify Integration
+<Steps>
+<Step>
+### Test Your Integration
- Open your live Drupal website in a browser.
- Navigate through a few pages.
- Check your Rybbit dashboard for incoming data. It might take a few minutes for the first events to appear.
+</Step>
+</Steps>
That's it! Rybbit Analytics should now be integrated with your Drupal site.
\ No newline at end of file
diff --git a/docs-v2/content/docs/guides/hugo.mdx b/docs-v2/content/docs/guides/hugo.mdx
index 870734eeb..fdd01b5c9 100644
--- a/docs-v2/content/docs/guides/hugo.mdx
+++ b/docs-v2/content/docs/guides/hugo.mdx
@@ -3,10 +3,13 @@ title: Hugo
description: Integrate Rybbit Analytics with your Hugo static site using partial templates
---
+import { Steps, Step } from 'fumadocs-ui/components/steps';
Integrating Rybbit Analytics with your Hugo static site involves adding the tracking script to your site's templates. The best way to do this is by creating a partial template for the script and including it in your site's footer.
-## 1. Get Your Tracking Script
+<Steps>
+<Step>
+### Get Your Tracking Script
First, you'll need your Rybbit tracking script. You can find this in your Rybbit dashboard under **Site Settings > Tracking Code**. It will look something like this:
@@ -15,8 +18,10 @@ First, you'll need your Rybbit tracking script. You can find this in your Rybbit
```
Replace `YOUR_SITE_ID` with your actual Site ID from your Rybbit dashboard.
+</Step>
-## 2. Create a Partial Template
+<Step>
+### Create a Partial Template
In your Hugo project, navigate to the `layouts/partials/` directory. If it doesn't exist, create it.
@@ -34,8 +39,10 @@ Paste your Rybbit tracking script into this new file:
**Explanation:**
- `{{ if not .Site.IsServer }}`: This Hugo condition ensures that the tracking script is only included when you build your site for production (`hugo`) and not during local development (`hugo server`). This prevents tracking your own local page views.
- Replace `https://app.rybbit.io` and `YOUR_SITE_ID` with your actual details.
+</Step>
-## 3. Include the Partial in Your Footer
+<Step>
+### Include the Partial in Your Footer
Now, you need to include this partial in your site's main footer template. This is typically located in `layouts/_default/baseof.html` or a theme-specific footer partial (e.g., `layouts/partials/footer.html` or `themes/your-theme/layouts/partials/footer.html`).
@@ -51,12 +58,16 @@ Open your main base template or footer partial file. Just before the closing `</
```
If you named your partial differently, make sure to use that name (e.g., `{{ partial "my-analytics-script.html" . }}`).
+</Step>
+</Steps>
-## 4. Configure `config.toml` (Optional but Recommended)
+## Configure `config.toml` (Optional but Recommended)
To make your Site ID configurable, you can use Hugo's site parameters.
-**a. Update `rybbit-analytics.html`:**
+<Steps>
+<Step>
+### Update `rybbit-analytics.html`
Modify `layouts/partials/rybbit-analytics.html` to use a site parameter:
@@ -66,8 +77,10 @@ Modify `layouts/partials/rybbit-analytics.html` to use a site parameter:
<script async defer src="{{ .Site.Params.rybbitInstanceURL | default "https://app.rybbit.io" }}/api/script.js" data-site-id="{{ .Site.Params.rybbitSiteID }}"></script>
{{ end }}
```
+</Step>
-**b. Add parameters to `config.toml` (or `config.yaml` / `config.json`):**
+<Step>
+### Add parameters to `config.toml`
Open your Hugo configuration file (e.g., `config.toml`) and add:
@@ -78,21 +91,35 @@ Open your Hugo configuration file (e.g., `config.toml`) and add:
```
This approach keeps your specific IDs out of the templates and makes it easier to manage for different environments if needed.
+</Step>
+</Steps>
-## 5. Build and Deploy
+## Build and Deploy
+
+<Steps>
+<Step>
+### Build your Hugo site
Rebuild your Hugo site:
```bash
hugo
```
+</Step>
+
+<Step>
+### Deploy
Deploy the generated `public/` directory to your web server.
+</Step>
-## 6. Verify Integration
+<Step>
+### Verify Integration
- Open your live Hugo website in a browser.
- Navigate through a few pages.
- Check your Rybbit dashboard for incoming data. It might take a few minutes for the first events to appear.
+</Step>
+</Steps>
That's it! Rybbit Analytics is now integrated with your Hugo site and will only track visits on your production deployment.
\ No newline at end of file
diff --git a/docs-v2/content/docs/guides/jekyll.mdx b/docs-v2/content/docs/guides/jekyll.mdx
index ac03b84d4..1862fe9f0 100644
--- a/docs-v2/content/docs/guides/jekyll.mdx
+++ b/docs-v2/content/docs/guides/jekyll.mdx
@@ -3,10 +3,13 @@ title: Jekyll
description: Integrate Rybbit Analytics with your Jekyll static site using layout files or includes
---
+import { Steps, Step } from 'fumadocs-ui/components/steps';
Integrating Rybbit Analytics with your Jekyll static site involves adding the tracking script to your site's main layout file or by creating an include file.
-## 1. Get Your Tracking Script
+<Steps>
+<Step>
+### Get Your Tracking Script
First, you'll need your Rybbit tracking script. You can find this in your Rybbit dashboard under **Site Settings > Tracking Code**. It will look something like this:
@@ -15,13 +18,24 @@ First, you'll need your Rybbit tracking script. You can find this in your Rybbit
```
Replace `YOUR_SITE_ID` with your actual Site ID from your Rybbit dashboard.
+</Step>
+</Steps>
-## 2. Option A: Add to Default Layout
+## Option A: Add to Default Layout
The simplest way is to add the script directly to your default layout file.
-- In your Jekyll project, find your main layout file. This is often `_layouts/default.html`.
-- Open this file and paste the Rybbit tracking script just before the closing `</body>` tag.
+<Steps>
+<Step>
+### Locate your main layout file
+
+In your Jekyll project, find your main layout file. This is often `_layouts/default.html`.
+</Step>
+
+<Step>
+### Add the tracking script
+
+Open this file and paste the Rybbit tracking script just before the closing `</body>` tag.
```html
{{ site.title }}
@@ -42,12 +56,17 @@ The simplest way is to add the script directly to your default layout file.
**Explanation:**
- `{% raw %}{% if jekyll.environment == "production" %}{% endraw %}`: This Liquid tag condition ensures the script is only included when your site is built for production (e.g., when `JEKYLL_ENV=production jekyll build`). This prevents tracking your local development views.
- Replace `YOUR_SITE_ID` with your actual Site ID. The script source `https://app.rybbit.io/api/script.js` is for the standard cloud-hosted Rybbit instance.
+</Step>
+</Steps>
-## 3. Option B: Create an Include File (Recommended)
+## Option B: Create an Include File (Recommended)
A cleaner approach is to create an include file for the script.
-**a. Create the Include File:**
+<Steps>
+<Step>
+### Create the Include File
+
- In your Jekyll project, navigate to the `_includes/` directory. If it doesn't exist, create it.
- Create a new file named `rybbit-analytics.html` (or similar) inside `_includes/`.
- Paste the following into `_includes/rybbit-analytics.html`:
@@ -60,8 +79,11 @@ A cleaner approach is to create an include file for the script.
{% endif %}
{% endraw %}
```
+</Step>
+
+<Step>
+### Include in Layout
-**b. Include in Layout:**
- Open your main layout file (e.g., `_layouts/default.html`).
- Just before the closing `</body>` tag, add:
@@ -75,8 +97,11 @@ A cleaner approach is to create an include file for the script.
</body>
</html>
```
+</Step>
+
+<Step>
+### Configure `_config.yml`
-**c. Configure `_config.yml`:**
- Open your `_config.yml` file and add your Rybbit details:
```yaml
@@ -85,8 +110,14 @@ rybbit_instance_url: "https://app.rybbit.io" # Optional, defaults in include
rybbit_site_id: "YOUR_SITE_ID"
```
This method keeps your credentials in the configuration file and makes the script inclusion conditional on `rybbit_site_id` being set.
+</Step>
+</Steps>
-## 4. Build and Deploy
+## Build and Deploy
+
+<Steps>
+<Step>
+### Build your Jekyll site
Build your Jekyll site. For production, set the `JEKYLL_ENV` environment variable:
@@ -95,13 +126,21 @@ JEKYLL_ENV=production jekyll build
```
Or, if you use GitHub Pages, it typically sets `jekyll.environment` to `production` automatically during its build process.
+</Step>
+
+<Step>
+### Deploy
Deploy the generated `_site/` directory to your web server.
+</Step>
-## 5. Verify Integration
+<Step>
+### Verify Integration
- Open your live Jekyll website in a browser.
- Navigate through a few pages.
- Check your Rybbit dashboard for incoming data. It might take a few minutes for the first events to appear.
+</Step>
+</Steps>
That's it! Rybbit Analytics is now integrated with your Jekyll site and will only track visits on your production deployment.
\ No newline at end of file
diff --git a/docs-v2/content/docs/guides/laravel.mdx b/docs-v2/content/docs/guides/laravel.mdx
index 92ea4df40..762e54557 100644
--- a/docs-v2/content/docs/guides/laravel.mdx
+++ b/docs-v2/content/docs/guides/laravel.mdx
@@ -3,10 +3,13 @@ title: Laravel
description: Integrate Rybbit Analytics with your Laravel application using Blade templates
---
+import { Steps, Step } from 'fumadocs-ui/components/steps';
Integrating Rybbit Analytics with your Laravel application is straightforward. You'll typically add the Rybbit tracking script to your main Blade layout file.
-## 1. Get Your Tracking Script
+<Steps>
+<Step>
+### Get Your Tracking Script
First, you'll need your Rybbit tracking script. You can find this in your Rybbit dashboard under **Site Settings > Tracking Code**. It will look something like this:
@@ -15,8 +18,10 @@ First, you'll need your Rybbit tracking script. You can find this in your Rybbit
```
Replace `YOUR_SITE_ID` with your actual Site ID from your Rybbit dashboard.
+</Step>
-## 2. Locate Your Main Blade Layout File
+<Step>
+### Locate Your Main Blade Layout File
In a standard Laravel application, you'll have a main layout file that other Blade views extend. This file is often located at:
@@ -25,8 +30,10 @@ In a standard Laravel application, you'll have a main layout file that other Bla
- If you're using Laravel Jetstream or Breeze, the main layout file might be in a slightly different location within `resources/views/`.
Identify the primary layout file that wraps most or all of your site's pages.
+</Step>
-## 3. Add the Tracking Script to the Layout
+<Step>
+### Add the Tracking Script to the Layout
Open your main Blade layout file. Paste the Rybbit tracking script just before the closing `</body>` tag.
@@ -66,8 +73,10 @@ If you prefer not to use the config helper immediately, you can hardcode the val
@endif
```
Remember to replace placeholders with your actual script URL and Site ID.
+</Step>
-## 4. Configure Environment Variables (Recommended)
+<Step>
+### Configure Environment Variables (Recommended)
It's best practice to store your Rybbit Site ID and instance URL in your `.env` file and access them via Laravel's configuration.
@@ -97,12 +106,16 @@ return [
Now, the Blade template code from Step 3 using `config('services.rybbit.instance_url')` and `config('services.rybbit.site_id')` will work correctly.
Make sure to run `php artisan config:clear` if you've cached your configuration.
+</Step>
-## 5. Verify Integration
+<Step>
+### Verify Integration
- Deploy your Laravel application to your production environment (or set `APP_ENV=production` locally for testing, but be mindful of tracking local data).
- Open your live Laravel website in a browser.
- Navigate through a few pages.
- Check your Rybbit dashboard for incoming data. It might take a few minutes for the first events to appear.
+</Step>
+</Steps>
That's it! Rybbit Analytics is now integrated with your Laravel application and will only track visits in your production environment.
\ No newline at end of file
diff --git a/docs-v2/content/docs/guides/squarespace.mdx b/docs-v2/content/docs/guides/squarespace.mdx
index 2062ae98c..4efd5904d 100644
--- a/docs-v2/content/docs/guides/squarespace.mdx
+++ b/docs-v2/content/docs/guides/squarespace.mdx
@@ -3,13 +3,14 @@ title: "Squarespace"
description: "Integrate Rybbit Analytics with your Squarespace website using the Code Injection feature."
---
+import { Steps, Step } from 'fumadocs-ui/components/steps';
import { Callout } from "fumadocs-ui/components/callout";
-# Squarespace
-
Integrating Rybbit Analytics with your Squarespace website is straightforward. You'll need to use Squarespace's "Code Injection" feature to add the Rybbit tracking script to your site.
-## 1. Get Your Tracking Script
+<Steps>
+<Step>
+### Get Your Tracking Script
First, you'll need your Rybbit tracking script. You can find this in your Rybbit dashboard under **Site Settings > Tracking Code**. It will look something like this:
@@ -18,16 +19,20 @@ First, you'll need your Rybbit tracking script. You can find this in your Rybbit
```
Replace `YOUR_SITE_ID` with your actual Site ID from your Rybbit dashboard.
+</Step>
-## 2. Go to Squarespace Settings
+<Step>
+### Go to Squarespace Settings
Log in to your Squarespace account and go to the website you want to track.
From the main dashboard (Home Menu), navigate to:
- **Settings**
+</Step>
-## 3. Access Code Injection
+<Step>
+### Access Code Injection
In the Settings panel, find and click on:
@@ -37,25 +42,33 @@ In the Settings panel, find and click on:
<Callout type="info">
The Code Injection feature is available on Squarespace Business and Commerce plans. It may not be available on Personal plans.
</Callout>
+</Step>
-## 4. Paste Your Tracking Script
+<Step>
+### Paste Your Tracking Script
In the Code Injection settings, you'll see several fields (Header, Footer, Lock Page, Order Confirmation Page).
For sitewide tracking, paste your Rybbit tracking script into the **Footer** text area. This ensures the script loads after your page content, which is generally better for perceived page load performance.
Alternatively, you can place it in the **Header**, which might track users who leave before the page fully loads, but could slightly impact initial page load speed. For most analytics purposes, the Footer is recommended.
+</Step>
-## 5. Save Changes
+<Step>
+### Save Changes
After pasting the script, click the **Save** button at the top of the Code Injection panel.
+</Step>
-## 6. Verify Integration
+<Step>
+### Verify Integration
Once you've saved the changes, Rybbit Analytics should start tracking visitors on your Squarespace site.
- Open your Squarespace website in a new browser tab or incognito window.
- Navigate through a few pages.
- Check your Rybbit dashboard for incoming data. It might take a few minutes for the first events to appear.
+</Step>
+</Steps>
That's it! Rybbit Analytics is now integrated with your Squarespace website.
\ No newline at end of file
diff --git a/docs-v2/content/docs/guides/wix.mdx b/docs-v2/content/docs/guides/wix.mdx
index 1ed8d8983..97ce53dbc 100644
--- a/docs-v2/content/docs/guides/wix.mdx
+++ b/docs-v2/content/docs/guides/wix.mdx
@@ -3,13 +3,14 @@ title: "Wix"
description: "Integrate Rybbit Analytics with your Wix website using custom code snippets."
---
+import { Steps, Step } from 'fumadocs-ui/components/steps';
import { Callout } from "fumadocs-ui/components/callout";
-# Wix
-
Integrating Rybbit Analytics with your Wix website involves adding a custom code snippet to your site's tracking tools.
-## 1. Get Your Tracking Script
+<Steps>
+<Step>
+### Get Your Tracking Script
First, you'll need your Rybbit tracking script. You can find this in your Rybbit dashboard under **Site Settings > Tracking Code**. It will look something like this:
@@ -18,16 +19,20 @@ First, you'll need your Rybbit tracking script. You can find this in your Rybbit
```
Replace `YOUR_SITE_ID` with your actual Site ID from your Rybbit dashboard.
+</Step>
-## 2. Go to Wix Dashboard
+<Step>
+### Go to Wix Dashboard
Log in to your Wix account and select the site you want to track.
From your site's dashboard, navigate to:
- **Settings** (usually in the left-hand sidebar)
+</Step>
-## 3. Access Tracking Tools / Custom Code
+<Step>
+### Access Tracking Tools / Custom Code
In the Settings menu, look for a section related to tracking or advanced settings. This is often called:
@@ -37,15 +42,19 @@ In the Settings menu, look for a section related to tracking or advanced setting
<Callout type="info">
To add custom code, you'll need a Wix Premium plan and a connected domain. This feature is typically not available on free Wix plans.
</Callout>
+</Step>
-## 4. Add New Custom Code
+<Step>
+### Add New Custom Code
Once in the Tracking Tools or Custom Code section:
- Click on **+ New Tool** or **+ Add Custom Code**.
- Choose **Custom** from the list of options if prompted.
+</Step>
-## 5. Configure the Custom Code
+<Step>
+### Configure the Custom Code
You'll be presented with a form to add your code:
@@ -54,17 +63,23 @@ You'll be presented with a form to add your code:
- **Add Code to Pages:** Select **All pages** to track your entire site.
- You might have an option to **Load code once** or **Load code on each new page**. Choose the option that best reflects loading the script on every page view.
- **Place Code in:** Choose **Body - end**. This is generally recommended for analytics scripts to avoid impacting perceived page load speed. Some Wix versions might offer "Head" or "Body - start" as well. "Body - end" is usually the best choice.
+</Step>
-## 6. Apply Changes
+<Step>
+### Apply Changes
Click **Apply** or **Save** to add the custom code to your site.
+</Step>
-## 7. Verify Integration
+<Step>
+### Verify Integration
After applying the changes, Rybbit Analytics should start tracking visitors on your Wix site.
- Open your Wix website in a new browser tab or incognito window.
- Navigate through a few pages.
- Check your Rybbit dashboard for incoming data. It might take a few minutes for the first events to appear.
+</Step>
+</Steps>
That's it! Rybbit Analytics is now integrated with your Wix website.
\ No newline at end of file
diff --git a/docs-v2/content/docs/hiding-own-traffic.mdx b/docs-v2/content/docs/hiding-own-traffic.mdx
index bacaf50ab..81fa86419 100644
--- a/docs-v2/content/docs/hiding-own-traffic.mdx
+++ b/docs-v2/content/docs/hiding-own-traffic.mdx
@@ -8,66 +8,127 @@ import { Steps, Step } from 'fumadocs-ui/components/steps';
import { Callout } from 'fumadocs-ui/components/callout';
+
There are several ways to disable Rybbit tracking to hide your own visits from analytics.
-<Tabs items={['Browser Extensions', 'localStorage Method']}>
-<Tab value="Browser Extensions">
-**Browser Extensions (Recommended)**: The easiest way to disable tracking using community-maintained browser extensions.
+<Tabs items={['IP Exclusion', 'Browser Extensions', 'localStorage Method']}>
+ <Tab>
+ **IP Exclusion (Recommended)**: Block traffic from specific IP addresses or ranges at the server level for complete accuracy.
+
+ ### Setting Up IP Exclusion
+
+ 1. **Navigate to Site Settings**: Go to your site's settings page in the Rybbit dashboard
+ 2. **Find IP Exclusions section**: Scroll down to the "IP Exclusions" configuration
+ 3. **Add your IP addresses**: Enter the IP addresses or ranges you want to exclude
+
+ ### Supported IP Formats
+
+ Rybbit supports multiple IP exclusion formats:
+
+ - **Single IPv4**: `192.168.1.1`
+ - **Single IPv6**: `2001:db8::1`, `::1`
+ - **CIDR notation**: `192.168.1.0/24`, `2001:db8::/32`
+ - **IPv4 ranges**: `192.168.1.1-192.168.1.10` (IPv4 only)
+
+ ### Examples
+
+ ```
+ # Your home IP address
+ 203.0.113.45
+
+ # Your office network (CIDR)
+ 203.0.113.0/24
+
+ # IP range for your team
+ 198.51.100.10-198.51.100.20
+
+ # IPv6 address
+ 2001:db8::1
+ ```
+
+ ### Key Features
+
+ - **Server-side filtering**: Traffic is blocked before it reaches your analytics, providing highly accurate exclusion
+ - **Multiple formats**: Supports individual IPs, CIDR notation, and ranges
+ - **IPv4 and IPv6**: Full support for both IP versions
+ - **Near real-time updates**: Changes take effect within seconds
+ - **No browser dependency**: Works regardless of browser or device
+
+ <Callout type="info">
+ **IP Stability Note**: IP addresses can change due to factors like mobile networks, VPN usage, ISP changes, and IPv6 privacy extensions. You may need to periodically update your excluded IPs to maintain effective filtering.
+ </Callout>
+
+ <Callout type="info">
+ **Dynamic IP Addresses**: If you frequently use VPNs, mobile networks, or have a dynamic IP address that changes regularly, consider these approaches:
+ - Use CIDR ranges that cover your typical IP pool (consult your ISP or VPN provider)
+ - Combine IP exclusion with browser extensions for comprehensive coverage
+ - Check your current IP periodically and update exclusions as needed
+ - For corporate networks, exclude the entire office IP range rather than individual addresses
+ </Callout>
+
+ <Callout type="warning">
+ **Note**: IPv6 range notation (e.g., `2001:db8::1-2001:db8::ff`) is not supported. Use CIDR notation instead (e.g., `2001:db8::/32`).
+ </Callout>
+
+ <Callout type="info">
+ **Finding your IP**: You can find your current IP address by visiting sites like [whatismyipaddress.com](https://whatismyipaddress.com) or [ipinfo.io](https://ipinfo.io).
+ </Callout>
+ </Tab>
+
+ <Tab>
+ **Browser Extensions**: Easy client-side solution using community-maintained browser extensions.
+
+ ### Available Extensions
-### Available Extensions
+ - **[Chrome Extension](https://chrome.google.com/webstore/detail/gofnfdfidbkpellionhpmkejgaajieoo)**: Install from the Chrome Web Store
+ - **[Firefox Extension](https://addons.mozilla.org/en-US/firefox/addon/rybbit-opt-out/)**: Install from Firefox Add-ons
-- **[Chrome Extension](https://chrome.google.com/webstore/detail/gofnfdfidbkpellionhpmkejgaajieoo)**: Install from the Chrome Web Store
-- **[Firefox Extension](https://addons.mozilla.org/en-US/firefox/addon/rybbit-opt-out/)**: Install from Firefox Add-ons
+ These extensions automatically disable Rybbit tracking on all websites where you have Rybbit installed, without requiring any manual configuration.
-These extensions automatically disable Rybbit tracking on all websites where you have Rybbit installed, without requiring any manual configuration.
+ <Callout type="info">
+ **Self-hosted users**: These extensions require Rybbit version 1.1.0 or higher. If you're running an older version, please update your installation or use the localStorage method.
+ </Callout>
-<Callout type="info">
-**Self-hosted users**: These extensions require Rybbit version 1.1.0 or higher. If you're running an older version, please update your installation or use the localStorage method.
-</Callout>
+ *These extensions are community-maintained by [@davidfiala](https://github.com/davidfiala).*
+ </Tab>
+
+ <Tab>
+ **localStorage Method**: Manual configuration using your browser's developer console for more granular control.
-*These extensions are community-maintained by [@davidfiala](https://github.com/davidfiala).*
-</Tab>
+ <Steps>
-<Tab value="localStorage Method">
-**localStorage Method**: Manual configuration using your browser's developer console for more granular control.
+ ### 1. Open your browser's developer console
-<Steps>
-<Step>
-### Open your browser's developer console
+ Press **F12** or right-click the page and select "Inspect"
-Press **F12** or right-click the page and select "Inspect"
+ Navigate to the "Console" tab
-Navigate to the "Console" tab
-</Step>
+ ### 2. Disable tracking
-<Step>
-### Disable tracking
+ Enter this command to disable tracking:
-Enter this command to disable tracking:
+ ```js
+ localStorage.setItem('disable-rybbit', 'true');
+ ```
-```js
-localStorage.setItem('disable-rybbit', 'true');
-```
-</Step>
+ ### 3. Re-enable tracking (when needed)
-<Step>
-### Re-enable tracking (when needed)
+ If you want to re-enable tracking later, enter:
-If you want to re-enable tracking later, enter:
+ ```js
+ localStorage.removeItem('disable-rybbit');
+ ```
-```js
-localStorage.removeItem('disable-rybbit');
-```
-</Step>
-</Steps>
-</Tab>
+ </Steps>
+ </Tab>
</Tabs>
## Summary
-Both methods are useful for developers testing sites or site owners who don't want to track their own visits:
+Multiple methods are available for hiding your own traffic, each with different advantages:
-- **Browser extensions** provide the most convenient solution, automatically working across all your Rybbit-enabled websites
-- **localStorage method** offers more granular control for specific websites or temporary disabling
+- **IP exclusion** provides the most accurate solution by blocking traffic at the server level, working regardless of browser or device
+- **Browser extensions** offer convenience by automatically working across all your Rybbit-enabled websites
+- **localStorage method** gives granular control for specific websites or temporary disabling
-Once disabled through either method, the Rybbit script will not send any tracking data while preserving the API functions to prevent JavaScript errors.
\ No newline at end of file
+For most users, **IP exclusion is recommended** as it provides highly accurate filtering for all devices accessing your site from the excluded IP addresses. The other methods work at the browser level and may be useful for additional flexibility or temporary exclusions.
\ No newline at end of file