Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/webshieldapp/webshield

A new wide-spectrum content blocker for Safari designed to be performant, efficient, and effective.
https://github.com/webshieldapp/webshield

adblock adblocker apple ios ipad ipados iphone mac macos safari ublock ublock-origin vision-pro visionos

Last synced: 1 day ago
JSON representation

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

Awesome Lists containing this project

README 

        
> [!TIP]

> * [Here](https://github.com/arjpar/WebShield-staging/tree/ldev) is my code.

> * [Here](http://discord.com/invite/gQ4ygPKyur) is the Discord if you want to communicate through instant messaging and get real time updates on the project.

> * [Here](https://github.com/WebShieldApp/WebShield/discussions/) are general announcements and discussions.

> * You can [donate](#Donate) to me if you want me to ship WebShield faster for TestFlight release to meet the $100/yr Apple Developer License. WebShield is 100% funded by its users; no ads and no third party deals ever.



# 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 15 or later

- iOS 18 or later

- visionOS 2 or later



## Installation



### App Store (Coming Soon)



1. Download and install WebShield from the [App Store](https://example.com) (Coming Soon).

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:

   ```bash

   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](CONTRIBUTING.md) file for details on how to get started.



## License



This project is licensed under the GNU GPLv3 License - see the [LICENSE](LICENSE) file for details.



## Support



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



- [Discord](http://discord.com/invite/gQ4ygPKyur)

- [GitHub Discussions](https://github.com/WebShieldApp/WebShield/discussions)

- Email: [[email protected]](mailto:[email protected])



## 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.



## Donate

If you would like to donate to me to support this project here are a few links:

- Ko-Fi: [@imarjuna](https://ko-fi.com/imarjuna)

- Buy Me a Coffee: [@imarjuna](https://buymeacoffee.com/imarjuna)

- GitHub Sponsors: [@arjpar](https://github.com/sponsors/arjpar)

- LiberaPay: [@imarjuna](https://liberapay.com/imarjuna/)



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 user donations 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 to create the best possible ad-blocking experience for Safari users. While supporting the project is entirely optional, every donation directly 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.



---



Happy browsing! 🛡️