Skip to content

arjpar/WebShield

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

68 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Testflight for WebShield

https://testflight.apple.com/join/1t5HfEGS

Tip

  • Here is the Discord if you want to communicate through instant messaging and get real time updates on the project.
  • Here are general announcements and discussions.
  • You can contribute financially to me if you want to financially support the project and help it become sustainable.
    • WebShield is 100% funded by its users; no "acceptable ads" and no third party deals ever.
    • Financial contribution is optional, and no features are behind a paywall, all features are accessible to all.
    • If you do choose to contribute, whether financially or otherwise, your voice will cary greater weight in the development of the project.
    • Gaining a greater voice in the project is called WebShield+.

WebShield - Safari Adblocker

Introduction

WebShield is a wide-spectrum content blocker, akin to uBlock Origin, specifically for Safari.

Important

Note: WebShield is currently in a beta stage of maturity. Features and documentation are subject to change as we continue to develop and improve the project.

Features

WebShield can block ads, trackers, cookie notices, and more. You can also import custom filter lists. WebShield supports Safari's Content Blocking API as well as scriptlets & extended css for more advanced, targeted blocking.

System Requirements

These requirements are tentative and due to change. I will try to support older OSes as much as I can.

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

Installation

Testflight

  1. Download & install WebShield from TestFlight
  2. (macOS) Open Safari and navigate to Settings > Extensions; (iOS) Open Settings > Safari > Extensions
  3. Enable all "WebShield" extensions
  4. (macOS) Go to Websites (in Safai Settings) > "WebShield Advanced"
  5. (macOS) Change "For other websites" to "Allow"
  6. (iOS) Go to "WebShield Advanced" (in Settings > Safari > Extensions)
  7. (iOS) Change "All Websites" to "Allow"

App Store (Coming Soon)

An App Store release will happen when we reach a stable level of maturity.

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

There will be documentation on usage soon.

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 GNU GPLv3 License - see the LICENSE file for details.

Support

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

Acknowledgments

WebShield draws inspiration from privacy and performance-focused projects like uBlock Origin. This project wouldn't be possible without the dedication of filter list maintainers who work tirelessly to keep the web clean. I'm deeply grateful to stand on the shoulders of these projects and their contributors. Special thanks to AdGuard, whose tools — particularly SafariConverterLib and Scriptlets/ExtendedCSS — have been instrumental to WebShield's development. I'd also like to thank @0xCube for our ongoing collaboration and the valuable connection between our projects.

Financial Contributions and Support

If you would like to help support this project financially here are a few links:

WebShield is and will always remain free, with all core ad-blocking functionality available to everyone. We believe in keeping the web clean and accessible, without hiding essential features behind paywalls.

As an independent, self-funded project, WebShield relies exclusively on funds out of my pocket and user contributed funds to sustain its development. This funding model is intentional—it ensures our incentives align perfectly with our users' interests. By choosing this path over revenue from ads, tracking, or deals with ad companies, we maintain our independence and stay true to our privacy-first principles.

WebShield+ offers a tiered support system: the more you contribute, the greater your influence on WebShield's future development. Your level of support directly correlates with the weight your voice carries in shaping our roadmap and future features.

For a modest contribution (starting at $1 either monthly or as a one-time payment), WebShield+ offers:

  • Early access to release candidate versions and experimental features
  • Direct communication with the development team
  • Influence on WebShield's roadmap (scaled with contribution level)
  • A special badge on Discord
  • The satisfaction of supporting a truly independent ad-blocker

I develop WebShield as a full-time student, dedicating and paying with my free time and out of pocket funds to create the best possible ad-blocking experience for Safari users. While supporting the project is entirely optional, every financial contribution funds our continued development and independence. This user-supported model allows us to maintain our unwavering focus on privacy and performance, free from the compromises that come with alternative funding sources.

Our commitment to providing a powerful, free ad-blocker for all Safari users remains unchanged. We believe in creating a product valuable enough that users choose to support it, rather than forcing their hand through paywalls or compromising with "acceptable ads."

Together, we can redefine ad-blocking for Safari, prioritizing user privacy, performance, and a cleaner web experience for everyone.

About Donations & Financial Transparency

  • Tax Considerations: While we may use the term "donations", "contributions", "support" for simplicity, please be aware that these financial contributions may be legally classified as income rather than charitable donations. Since WebShield+ offers specific benefits in exchange for financial support (early access, increased influence, etc.), these transactions may technically function as a support contract. But I'm not a lawyer.
  • Non-Profit Status: WebShield is not a registered non-profit organization, and contributions are not tax-deductible for donors.
  • Distribution Notice: WebShield is currently distributed through TestFlight. We continue explore long-term distribution options (meaning App Store or currently TestFlight, those are the only two options) that align with our values. We're committed to being transparent about our distribution methods and any changes to them.
  • Hobby Project Status: WebShield is a side project developed in my free time as a full-time student. While I'm dedicated to its continued development and improvement, the pace of updates may reflect its hobby status. All financial "donations", "contributions", and "support" are sent to my personage under my name.
  • Disclaimer: This disclosure is for informational purposes only and does not constitute legal or tax advice.

Happy browsing! 🛡️