Skip to content

A new wide-spectrum content blocker for Safari designed to be performant, efficient, and effective.

License

Notifications You must be signed in to change notification settings

WebShieldApp/WebShield

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tip

  • Here is my code.
  • Here are updates (devlog).

WebShield - Safari Adblocker

Build Status Version License

The Ultimate Adblocker for Safari, Designed for Performance & Privacy

Introducing WebShield, the cutting-edge, lightweight adblocker crafted exclusively for Safari. Experience lightning-fast, clutter-free browsing across iOS, iPadOS, and macOS with our unified, native SwiftUI interface. WebShield harnesses the full potential of Safari's content blocking API and integrates AdGuard's advanced scriptlets and extended CSS library, delivering unparalleled ad-blocking precision. Say goodbye to unwanted ads, trackers, and pop-ups, and hello to a cleaner, faster, and more private web experience. WebShield isn't just an adblocker – it's your shield against digital distractions, fine-tuned for Apple's ecosystem.

Important

Note: WebShield is currently in early alpha (version 0.0.0-alpha.0). Features and documentation are subject to change as we continue to develop and improve the project.

Features

  • 🚀 Blazing Fast: Utilizes Safari's content blocking API for high-performance, efficient ad blocking.
  • 🛡️ Comprehensive Ad Blocking: Incorporates AdGuard's scriptlets and extended CSS library for enhanced blocking capabilities, handling all major ad networks and trackers with ease.
  • 🔒 Privacy First: No data collection, fully compliant with Safari's privacy policies.
  • 🌍 Cross-Platform Support: Unified app design works seamlessly on macOS, iOS, iPadOS, and visionOS.
  • 📦 Customizable Filter Lists: Supports custom filter lists like EasyList, EasyPrivacy, and more.
  • 🔧 User-Friendly: Native SwiftUI interface provides a smooth, platform-consistent user experience, allowing effortless management of filters and block rules.
  • 🔓 Open Source: First fully free & source-available Safari adblocker with AdGuard technology integration.

System Requirements

  • macOS 14 or later
  • iOS 17 or later
  • visionOS 1 or later

Installation

App Store (Coming Soon)

  1. Download and install WebShield from the App Store (Coming Soong).
  2. Open Safari and navigate to Preferences > Extensions.
  3. Enable WebShield and its content blockers.

From Source (Coming Soon)

For developers and advanced users who want to build from source:

  1. Clone the repository:
    git clone https://github.com/WebShieldApp/WebShield.git
  2. Open the project in Xcode and build the app for your platform.
  3. Follow platform-specific steps for enabling the extension in Safari.

Note: Detailed installation instructions will be added once the project reaches a stable release.

Usage

Once installed and enabled, WebShield will automatically start blocking ads and trackers in Safari. To manage filters or customize the blocking rules:

  1. Open WebShield to add, remove, or update filter lists.

To add a new filter list manually:

  • Click "Add Filter List" and paste the URL of the filter list (e.g., EasyList).

Usage examples and screenshots will be provided in future updates.

Contributing

We welcome contributions to WebShield! Here's how you can help:

  1. Bug Reports & Feature Requests: Use the GitHub Issues to report bugs or request features.
  2. Code Contributions: Fork the repository, create a feature branch, and submit a pull request.
  3. Documentation Improvements: Found a typo or have better wording suggestions? Feel free to submit a PR!

For detailed guidelines, please see our CONTRIBUTING.md file for details on how to get started.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you need help or have any questions, you can reach out through:

Acknowledgments

WebShield was inspired by projects like uBlock Origin and Safari's focus on privacy and performance. Special thanks to the open-source community for filter lists like EasyList and EasyPrivacy.

Special thanks to @0xCube for the ongoing collaboration and liaison between our projects.


Happy browsing! 🛡️

About

A new wide-spectrum content blocker for Safari designed to be performant, efficient, and effective.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published