Blocklist Manager Documentation

Welcome to the Blocklist Manager documentation. Here you'll find guides for users, administrators, and developers.

---

Table of Contents

• Introduction
• Features
• Getting Started
• User Guide
• Blocklist Management
• Importing & Exporting
• API Usage
• Theming
• Security
• FAQ
• Contributing

---

Introduction

Blocklist Manager is an open-source platform for creating, managing, and sharing blocklists for security, privacy, and content filtering. It supports collaboration, analytics, and automation for individuals and organizations.

Features

• User authentication and roles (admin/member)
• Create, edit, and delete blocklists
• Public/private blocklists
• Import/export in multiple formats (TXT, CSV, Pi-hole, AdGuard, etc.)
• API for automation
• Statistics and analytics
• Light and dark themes
• Notifications and logging

Getting Started

1. Install requirements: PHP 7.4+, MySQL 5.7+, web server, SMTP for email
2. Clone the repository and set up the database
3. Configure the app and set permissions
4. Register an admin account and log in

See the full documentation for detailed setup instructions.

User Guide

• Register and verify your email
• Access your dashboard to manage blocklists
• Create, edit, and delete blocklists
• Share blocklists or invite collaborators

Blocklist Management

• Types: Domain, IP, IPv6, email, URL, custom
• Categories: Organize blocklists by category
• Visibility: Set blocklists as public or private
• Entries: Add, edit, or remove entries manually or via import

Importing & Exporting

• Import: Upload a file or provide a URL to import entries
• Export: Download blocklists in various formats

API Usage

• See API documentation for endpoints and usage
• Authenticate using API keys or OAuth (if enabled)
• Endpoints for creating, updating, deleting, and fetching blocklists and entries

Theming

• Switch between light and dark mode using the theme switcher
• Add custom themes in templates/default/

Security

• Passwords are hashed (bcrypt)
• CSRF protection on all forms
• Input validation and sanitization
• Session security and email verification

FAQ

See the FAQ page for common questions and answers.

Contributing

• Fork the repository and submit pull requests
• Report issues and request features via GitHub
• See CONTRIBUTING.md for guidelines

---

For more details, see the full documentation or contact the maintainers.