Home

AdBlock Compiler Wiki

Welcome to the AdBlock Compiler documentation wiki! This wiki contains comprehensive documentation for the adblock-compiler project - a compiler-as-a-service for adblock filter lists.

Overview

AdBlock Compiler transforms, optimizes, and combines filter lists from multiple sources with real-time progress tracking. It's designed to work universally across Deno, Node.js, Cloudflare Workers, and browsers.

🌐 Live Web UI | 🚀 API Endpoint | 📦 JSR Package

Getting Started

• Quick Start Guide - Get up and running with Docker in minutes
• API Documentation - REST API reference and examples
• Client Libraries - Client examples for Python, TypeScript, and Go
• Main Project README - Installation and basic usage

Deployment Guides

• Docker Deployment - Complete Docker guide with Kubernetes examples
• Cloudflare Containers - Deploy to Cloudflare edge network
• Queue Support - Asynchronous compilation with Cloudflare Queues
• Queue Architecture - Queue system architecture and design

Development & Extension

• Extensibility Guide - Custom transformations and extensions
• Testing Guide - How to run and write tests
• Benchmarks - Performance benchmarking guide
• Implementation Summary - Technical implementation details

Reference Documentation

• Migration Guide - Migrating from @adguard/hostlist-compiler
• Troubleshooting - Common issues and solutions
• Diagnostics - Debugging and diagnostic tools
• Cloudflare D1 - D1 database integration
• Prisma Evaluation - Prisma ORM evaluation notes
• AI Assistant Guide - Context for AI assistants working with this codebase

Key Features

• 🎯 Multi-Source Compilation - Combine filter lists from URLs, files, or inline rules
• ⚡ Performance - Gzip compression (70-80% cache reduction), request deduplication, smart caching
• 🔄 Circuit Breaker - Automatic retry with exponential backoff for unreliable sources
• 📊 Visual Diff - See what changed between compilations
• 🎪 Batch Processing - Compile up to 10 lists in parallel
• 📡 Event Pipeline - Real-time progress tracking via Server-Sent Events
• 🌍 Universal - Works in Deno, Node.js, Cloudflare Workers, browsers
• 🎨 11 Transformations - Deduplicate, compress, validate, and more

Contributing

Contributions are welcome! Please see the main repository for contribution guidelines.

License

GPL-3.0 License - See LICENSE for details