Blockit Save

WebKitGTK adblock extension with Brave's Rust-based adblock engine for backend.

Project README

BlocKit

WebKitGTK adblock extension with Brave's Rust-based adblock engine for backend.

Features

  • Network and cosmetic filtering
  • Supports Adblock Plus filter syntax
  • Automatic filter lists updating
  • Element picker/zapper
  • Simple GUI

Installation

  1. Install adblock-rust-server:
cargo install adblock-rust-server
  1. Clone this repository and install:
git clone https://github.com/dudik/blockit
cd blockit
sudo make install
  1. Link the library located at /usr/local/lib/blockit.so with the WebKitGTK based browser you want to use:
sudo ln -s /usr/local/lib/blockit.so /usr/lib/example-browser

The target folder is different for each browser. The locations can be found at wyebadblock's Github page.

The server should start automatically when you open your browser. If not, try starting it manually:

adblock-rust-server

Usage

The GUI can be opened by navigating your browser to blockit://settings.

The Zap element button allows the user to remove any element on the webpage with a left mouse click. The Block element button is the same, except that a cosmetic rule will be added to the custom rules file making the removal permanent.

URLs of filter lists you want to use are stored in ~/.config/ars/urls and custom rules in ~/.config/ars/lists/custom. Both files can be opened from the GUI by clicking on the Filter lists and Custom filters buttons, respectively.

The Reload engine button will restart the adblocking engine applying any changes made to the filter lists and custom filters.
The Force update button is similar, but it also updates every filter list to the latest version.

Filter lists are updated automatically based on the ! Expires: field.

Contribute

Feel free to open an issue if you want to report a bug or you have a feature request.

Open Source Agenda is not affiliated with "Blockit" Project. README Source: dudik/blockit
Stars
51
Open Issues
4
Last Commit
3 years ago
Repository
License

Open Source Agenda Badge

Open Source Agenda Rating