Blokator

Simple cross-platform and system-wide CLI adblocker

How it works

Blokator is hosts-based. The hosts file is a way to map hostnames to IP addresses, which acts like local DNS server.

Features

• Apply
• Revert
• Create a backup of current hosts file
• Restore backup
• Sync
• Add custom repos
• Delete custom repos
• Access custom repos with TOR
• Apply for Android device (experimental, root required)

Compatibility

Blokator can run basically everywhere. These are the tested platforms: - Linux (just works) - BSDs (just works) - Windows (works, but for normal Windows user it is not user-friendly)

Supported init systems

• SystemD
• Runit
• OpenRC

If you have another init system or networking service, you can restart it manually or even reboot the computer.

Known issues

• Colors don't work in Windows
• OpenRC NetworkManager restart can return exit with status 1 so Blokator thinks that the restart of NetworkManager failed

Usage

After you installed Blokator, you need to sync the hosts files. To sync the hosts files, run Blokator with --sync argument:

blokator --sync

Then you can enable Blokator with --apply argument:

blokator --apply

To add your own hosts file, you can add your repo with --add-repo argument:

blokator --add-repo <URL>

To delete repo you added, you can run Blokator with --del-repo argument:

blokator --del-repo <URL>

To display the help page with all available commands, you can run Blokator with --help argument:

blokator --help

You will find more usage examples in man page

Installation

Manual / Compilation

Before you begin, make sure you have installed these things: - Rust - Cargo

With Cargo

You can install Blokator easily with Cargo package manager: cargo install blokator

or if you want Android support: (not recommended yet)

cargo install blokator --features android

MAKE SURE THAT ~/.cargo/bin IS IN YOUR $PATH

With Git

First, you need to clone the git repo to your local machine:

git clone https://gitlab.com/Tomkoid/blokator.git

Now CD into that directory:

cd blokator

In that directory you can compile Blokator:

cargo build --release

or if you want Android support: (not recommended yet)

cargo build --release --features android

And install it to the system:

sudo cp target/release/blokator /usr/bin/blokator

You're done now!

From package manager

At this moment, Blokator is available only in AUR or tomkoid-repo for Arch Linux.

To download Blokator from AUR it's recommended to use AUR helper to install Blokator.

Checkout tomkoid-repo installation in README.md.