zen-desktop README

The project's README from github.com/irbis-sh/zen-desktop. As one markdown file: README.md.

Zen's Blue Shield Logo

Zen: Your Comprehensive Ad-Blocker and Privacy Guard

There is, simply, no way, to ignore privacy. Because a citizenry’s freedoms are interdependent, to surrender your own privacy is really to surrender everyone’s.

Edward Snowden, Permanent Record

GitHub License GitHub release GitHub download counter

Website • Mastodon • Bluesky • Discord • Documentation

Zen is an open-source system-wide ad-blocker and privacy guard for Windows, macOS, and Linux. It works by setting up a proxy that intercepts HTTP requests from all applications, and blocks those serving ads, tracking scripts that monitor your behavior, malware, and other unwanted content. By operating at the system level, Zen can protect against threats that browser extensions cannot, such as trackers embedded in desktop applications and operating system components. Zen comes with many pre-installed filters, but also allows you to easily add hosts files and EasyList-style filters, enabling you to tailor your protection to your specific needs.

Downloads

During the first run, Zen will prompt you to install a root certificate. This is required for Zen to be able to intercept and modify HTTPS requests. This certificate is generated locally and never leaves your device. For details on how this works and the steps we take to secure it, see our security architecture.

Windows

Unsure which version to download? Click on 'Start' and type 'View processor info'. The 'System type' field under 'Device specifications' will tell you which one you need.

Winget

Zen is available via Winget (Windows Package Manager). To install, run:

winget install ZenPrivacy.ZenDesktop

macOS

Unsure which version to download? Learn at Apple's website.

🍺 Homebrew

Zen is available via Homebrew for both Intel and Apple Silicon. To install it, run:

brew install --cask zen-privacy

Linux

Zen has an install script that covers most Linux distributions. To install, run:

curl -fsSL https://raw.githubusercontent.com/irbis-sh/zen-desktop/master/install.sh | sh

To uninstall, run:

curl -fsSL https://raw.githubusercontent.com/irbis-sh/zen-desktop/master/install.sh | sh -s -- --uninstall

Other installation methods:

On Linux, automatic proxy configuration is currently only supported on GNOME- and KDE-based desktop environments.

Screenshots

Request history Filter list manager
Request history shows all requests blocked by Zen. Each request can be inspected to see which filter and rule blocked it. Zen comes with many pre-installed filters. You can also add your own by providing a URL to a hosts file or an EasyList-style filter.
Screenshot of Zen's Home screen showing blocked network requests. One entry details a blocked request to a Marketo tracking script from politico.com, with several other advertising and analytics domains listed below. Navigation tabs and a Donate button appear at the top, and a blue Stop button is visible at the bottom. Screenshot of Zen's Filter lists screen showing a regional category with multiple ad-block filter lists from different countries. Each list includes a name, a source URL, and toggle switches indicating whether it is enabled.

Development

Follow the getting started guide to begin working on Zen development. If you have any questions, feel free to ask in the Discussions.

Contributing

Zen needs your help! You can report bugs, suggest and implement features, improve the codebase, or help translate Zen into your language. Please refer to the Contributing Guidelines for more information.

Special Thanks

Zen exists thanks to the support of many incredible people and organizations, including:

License

This project is licensed under the MIT License. Some code and assets included with Zen are licensed under different terms. For more information, see the COPYING file.

zen-desktop (irbis-sh/zen-desktop)

Searching Database…

What is this?Zen is an open-source, system-wide ad-blocker and privacy guard for Windows, macOS, and Linux that blocks ads, trackers, and malware across all applications, not just a browser.
Is this just another browser extension?No. It runs as a desktop app that sets up a local proxy intercepting HTTP/HTTPS requests from all apps on your system, so it can block trackers in desktop software and OS components that browser extensions can't touch.
Do I need anything extra for it to work?On first run, Zen asks you to install a locally-generated root certificate so it can intercept and decrypt HTTPS traffic; this certificate never leaves your device.
Does automatic proxy setup work the same on every Linux desktop?No, on Linux automatic proxy configuration currently only works on GNOME- and KDE-based desktop environments; other setups may need manual configuration.
Which CPU architectures are supported?Zen ships separate builds for x64 (Intel) and ARM64 (including Apple Silicon) on Windows and macOS, plus x64/ARM64 portable builds on Linux.
Is the HTTPS-decrypting certificate sent anywhere?No, the root certificate Zen installs is generated locally on your machine and never leaves your device.
Can I customize what Zen blocks?Yes, beyond the pre-installed filters, you can add your own hosts files or EasyList-style filter URLs to tailor protection to your needs.
Can I see what Zen has blocked?Yes, the request history view shows every blocked request and lets you inspect which filter and rule caused the block.
What language is Zen written in?Zen is written in Go.
Creator
irbis-sh
Size
10.5 MB
Stars
4.3K
Age
3y
Commits · 90 Days