Skip to content

The Matomo AddOn provides complete integration of the open-source web analytics platform Matomo into REDAXO 5. It enables easy downloading, installing, and managing of Matomo directly from the REDAXO backend.

License

Notifications You must be signed in to change notification settings

FriendsOfREDAXO/matomo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Matomo AddOn for REDAXO 5

The Matomo AddOn provides complete integrat### 4. View Statistics

  • Matomo β†’ Overview: Compact statistics for all domains with optional top 5 pages
  • Auto-login: Seamless access to Matomo without manual login
  • Direct Domain Links: Quick access to specific domain statistics

5. Dashboard & Info-Center Widgets πŸ“Š

Info-Center Widget (compact)

  • Automatic Integration: If Info-Center AddOn is installed
  • Permission-based: Only visible for users with matomo[overview] permission
  • Live Statistics: Shows today's visitors for top 3 websites
  • YRewrite-Synced: Automatically filters to YRewrite domains
  • Direct Access: One-click access to full Matomo overview

Dashboard Widget (extended)

  • Automatic Integration: If Dashboard AddOn is installed
  • Permission-based: Only visible for users with matomo[overview] permission
  • Extended Statistics: Top 5 websites with today's visitor counts in table format
  • Larger Format: 2-column layout for more information
  • YRewrite Integration: Automatic filtering to YRewrite domainsof the open-source web analytics platform Matomo into REDAXO 5. It enables easy downloading, installing, and managing of Matomo directly from the REDAXO backend.

πŸš€ Features

βœ… Automated Installation

  • One-click download of the latest Matomo version
  • Automatic configuration of URL and path
  • REDAXO-native implementation using rex_socket, rex_file, and rex_dir

πŸ“Š Statistics Overview

  • Compact overview page with statistics for all domains
  • Top 5 Pages Feature - shows most visited pages of the current week
  • Real-time data with automatic refresh (every 5 minutes)
  • Automatic Login System for seamless Matomo access
  • Direct links to specific Matomo dashboards

🌐 Domain Management

  • API-based domain management via Matomo API
  • YRewrite Integration - automatic filtering and import of YRewrite domains
  • Smart duplicate detection - prevents importing existing domains
  • Domain deletion - remove domains from Matomo with confirmation
  • Tracking code generation for each domain
  • Copy-to-clipboard functionality for tracking codes
  • Consent manager integration recommendations

βš™οΈ Advanced Configuration

  • Flexible API settings (timeout, SSL verification)
  • Privacy options (IP anonymization, cookie-free tracking)
  • Multi-token support (Admin + User Token)

πŸ”’ GDPR Compliance

  • IP anonymization can be enabled
  • Cookie-free tracking available
  • Do Not Track support
  • Consent manager integration recommended

🌍 Multi-language Support

  • Fully translated (German/English)
  • REDAXO i18n system integration
  • Consistent terminology across all pages

️ Installation

  1. Install AddOn via REDAXO installer or manually
  2. Activate AddOn in REDAXO backend
  3. Access Matomo Setup and perform installation

πŸ“– Usage

1. Matomo Setup

Under Matomo β†’ Matomo Setup:

  • Automatically download and install Matomo
  • Or manually configure path, URL, and API token

2. Configuration

Under Matomo β†’ Configuration:

  • API settings (timeout, SSL verification)
  • Tracking options (IP anonymization, cookie-free tracking)
  • Configure privacy settings

3. Manage Domains

Under Matomo β†’ Domains:

  • Add new domains to Matomo manually
  • Import YRewrite domains - select and import domains from YRewrite configuration
  • Delete domains from Matomo with safety confirmation
  • Display and copy tracking codes
  • Follow consent manager recommendations

YRewrite Integration:

  • Automatic filtering: Overview shows only YRewrite domains (+ default domain)
  • Smart import: Select YRewrite domains to import into Matomo
  • Duplicate prevention: Already existing domains are marked and skipped
  • Domain synchronization: Keep Matomo and YRewrite domains in sync

4. View Statistics

  • Matomo β†’ Overview: Compact statistics for all domains with optional Top 5 pages
  • Auto Login: Seamless access to Matomo without manual login
  • Direct Domain Links: Quick access to specific domain statistics

πŸ” Setting up API Tokens

Admin Token (required)

For administrative tasks like domain creation:

  1. Log into Matomo
  2. Administration β†’ Platform β†’ API β†’ User Authentication
  3. Copy Admin Token and paste into REDAXO

User Token (optional)

For statistics access:

  1. Open User Authentication in Matomo
  2. Copy User Token (if not available, Admin Token will be used)

Auto-Login Setup (optional)

For automatic login via "Auto Login" buttons:

  1. Enter Matomo username and password in settings
  2. Automatic configuration: The AddOn can automatically set login_allow_logme = 1 in Matomo's config.ini.php
  3. Manual configuration: If automatic setup fails, manually add to config/config.ini.php:
    [General]
    login_allow_logme = 1

🎯 Tracking Code Integration

Important: The AddOn does not automatically embed tracking codes.

Recommended Integration:

  1. Use Consent Manager AddOn (recommended: "Consent Manager")
  2. Copy tracking code from the domains page
  3. Manually insert into templates or manage via consent manager

GDPR-compliant Options:

  • Enable IP anonymization
  • Use cookie-free tracking
  • Respect Do Not Track
  • Use consent manager for cookie consent

πŸ”§ Configuration Options

API Settings

  • api_timeout: Request timeout (10-120 seconds)
  • ssl_verify: SSL certificate verification

Tracking Options

  • anonymize_ip: Anonymize IP addresses
  • cookieless_tracking: Cookie-free tracking
  • respect_dnt: Respect Do Not Track header
  • cookie_lifetime: Cookie lifetime

Statistics Features

  • show_top_pages: Enable/disable Top 5 Pages feature

Auto-Login

  • matomo_user: Matomo username for automatic login
  • matomo_password: Matomo password for automatic login

πŸ”„ API Integration

The AddOn uses the Matomo HTTP API for:

  • Site management (create, list)
  • Statistics queries (visitors, page views)
  • Tracking code generation

All HTTP requests are made via rex_socket with configurable timeouts and SSL options.

πŸ†˜ Troubleshooting

Matomo not found

  • Check path and URL in configuration
  • Ensure Matomo is correctly installed

API errors

  • Verify API tokens
  • Test Matomo URL in browser
  • Check SSL settings for HTTPS

πŸ“ Changelog

Version 2.1

  • YRewrite Integration: Full integration with YRewrite AddOn (now required)
  • Automatic Domain Filtering: Shows only YRewrite domains in overview (+ default domain)
  • Smart Domain Import: Import YRewrite domains into Matomo with selection interface
  • Info-Center Widget: Compact Matomo statistics in REDAXO Info-Center (only for users with matomo[overview] permission)
  • Dashboard Widget: Extended Matomo statistics in REDAXO Dashboard AddOn (Top 5 websites, table view)
  • Domain Deletion: Remove domains from Matomo with safety confirmation
  • Smart Duplicate Detection: Prevents importing existing domains
  • Complete Internationalization: All texts professionally translated
  • Improved UX: User-friendly dialogs and informative status messages
  • Clean Architecture: YRewrite as dependency for consistent multi-domain management

Version 2.0

  • Auto-Login System: Seamless Matomo access without manual login
  • Top 5 Pages Feature: Shows most visited pages of the current week
  • External Matomo Support: Full integration of external Matomo installations
  • Enhanced Overview Page: Extended statistics with trend indicators
  • Automatic Configuration: Auto-login can be automatically configured in Matomo
  • Improved UI: Consistent panel design and better user guidance
  • Namespace Migration: Complete migration to FriendsOfRedaxo\Matomo namespace
  • Dashboard Removal: Focus on streamlined overview-based approaches

Credits

Project Leads
Daniel Springer

Thomas Skerbis

🀝 Support

πŸ“„ License

This AddOn is available under the MIT License. Matomo itself is available under the GPL v3 License.


Developed by Friends Of REDAXO
For REDAXO 5.16.1+ | Matomo 4.x/5.x compatible

About

The Matomo AddOn provides complete integration of the open-source web analytics platform Matomo into REDAXO 5. It enables easy downloading, installing, and managing of Matomo directly from the REDAXO backend.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Contributors 5

Languages