Rybbit WP

A WordPress plugin for integrating Rybbit privacy-first analytics.

Features

• Simple setup with Site ID configuration
• Support for self-hosted Rybbit instances
• Option to ignore logged-in users (enabled by default)
• Query parameter tracking control
• SPA mode for AJAX-based themes
• Modern React-based settings interface
• Pre-configured download support for Rybbit integration

Installation

Manual Installation

1. Download the latest release zip file
2. Go to WordPress Admin > Plugins > Add New > Upload Plugin
3. Upload the zip file and activate

From Source

git clone https://github.com/wolfdevs/rybbit-wp.git
cd rybbit-wp
npm install
npm run build

Copy the plugin folder to /wp-content/plugins/ and activate.

Configuration

1. Navigate to Settings > Rybbit Analytics
2. Enter your Site ID (found in your Rybbit dashboard)
3. Optionally configure:
   • Host URL - For self-hosted instances (default: https://app.rybbit.io)
   • Ignore logged-in users - Exclude admin activity from tracking
   • Track query parameters - Include URL query strings
   • SPA mode - For single-page applications

Development

# Install dependencies
npm install

# Development mode with hot reload
npm run dev

# Production build
npm run build

Build Script

Create distributable zip files using the build script:

# Interactive mode (prompts for site ID)
./build-zip.sh

# With arguments (for automation)
./build-zip.sh "your-site-id" "https://app.rybbit.io"

# Generic build (press Enter to skip site ID prompt)
./build-zip.sh

Output:

• Generic: rybbit-wp.zip
• Pre-configured: rybbit-wp-{site-id}.zip

Rybbit Integration

This plugin supports pre-configured downloads for seamless Rybbit integration.

How It Works

1. Build script bundles a rybbit-config.json with the user's settings:

   {
     "site_id": "your-site-id",
     "host_url": "https://app.rybbit.io"
   }

2. On plugin activation, WordPress reads the config and auto-saves settings

3. Config file is deleted after applying - analytics starts immediately

Integration with Rybbit Dashboard

Rybbit can offer "Download WordPress Plugin" by:

• Hosting a base zip and injecting config client-side (using JSZip)
• Or calling the build script server-side with user's site ID

File Structure

rybbit-wp/
├── rybbit-wp.php           # Main plugin file
├── includes/
│   └── class-rybbit-wp.php # Core plugin class
├── src/
│   ├── main.jsx            # React entry point
│   ├── App.jsx             # Settings component
│   └── styles.css          # Tailwind styles
├── build/                  # Compiled assets
├── build-zip.sh            # Build script
├── package.json
├── vite.config.js
├── tailwind.config.js
├── readme.txt              # WordPress readme
└── README.md

Requirements

• WordPress 5.8+
• PHP 7.4+

License

GPL v2 or later

Credits

• Plugin by WolfDevs
• Analytics by Rybbit