|
8 years ago | |
---|---|---|
.. | ||
README.md | 8 years ago | |
simple-adblock.conf | 8 years ago | |
simple-adblock.init | 8 years ago |
A simple DNSMASQ-based AdBlocking service for OpenWrt/LEDE Project. Loosely based on bole5's idea with major performance improvements, added features and Web UI (as a separate package); inspired by @dibdot's innovation.
If you want a more robust AdBlocking, supporting free memory detection and complex block lists, check out @dibdot's adblock.
This service requires the following packages to be installed on your router: dnsmasq
or dnsmasq-full
and either wget
and libopenssl
(for OpenWrt CC 15.05.1) or uclient-fetch
and libustream-mbedtls
(for OpenWrt DD trunk and all LEDE Project release and snapshot builds). Additionally installation of coreutils-sort
is highly recommended as it speeds up blocklist processing.
To satisfy the requirements for connect to your router via ssh and run the following commands:
opkg update; opkg install wget libopenssl coreutils-sort dnsmasq
opkg update; opkg install uclient-fetch libustream-mbedtls coreutils-sort dnsmasq
For IPv6 support additionally install ip6tables-mod-nat
and kmod-ipt-nat6
packages from Web UI or run the following in the command line:
opkg update; opkg install ip6tables-mod-nat kmod-ipt-nat6
The coreutils-sort
is an optional, but recommended package as it speeds up sorting and removing duplicates from the merged list dramatically. If opkg complains that it can't install coreutils-sort
because /usr/bin/sort is already provided by busybox, you can run opkg --force-overwrite install coreutils-sort
.
If you are running a development (trunk/snapshot) build of OpenWrt/LEDE Project on your router and your build is outdated (meaning that packages of the same revision/commit hash are no longer available and when you try to satisfy the requirements you get errors), please flash either current LEDE release image or current development/snapshot image.
Install simple-adblock
and luci-app-simple-adblock
packages from Web UI or run the following in the command line:
opkg update; opkg install simple-adblock luci-app-simple-adblock
If simple-adblock
and luci-app-simple-adblock
packages are not found in the official feed/repo for your version of OpenWrt/LEDE Project, you will need to add a custom repo to your router first.
If your router is not set up with the access to repository containing these packages you will need to add custom repository to your router by connecting to your router via ssh and running the following commands:
opkg update; opkg install wget libopenssl
echo -e -n 'untrusted comment: public key 7ffc7517c4cc0c56\nRWR//HUXxMwMVnx7fESOKO7x8XoW4/dRidJPjt91hAAU2L59mYvHy0Fa\n' > /tmp/stangri-repo.pub && opkg-key add /tmp/stangri-repo.pub
! grep -q 'stangri_repo' /etc/opkg/customfeeds.conf && echo 'src/gz stangri_repo https://raw.githubusercontent.com/stangri/openwrt-repo/master' >> /etc/opkg/customfeeds.conf
opkg update
opkg update; opkg install uclient-fetch libustream-mbedtls
echo -e -n 'untrusted comment: public key 7ffc7517c4cc0c56\nRWR//HUXxMwMVnx7fESOKO7x8XoW4/dRidJPjt91hAAU2L59mYvHy0Fa\n' > /tmp/stangri-repo.pub && opkg-key add /tmp/stangri-repo.pub
! grep -q 'stangri_repo' /etc/opkg/customfeeds.conf && echo 'src/gz stangri_repo https://raw.githubusercontent.com/stangri/openwrt-repo/master' >> /etc/opkg/customfeeds.conf
opkg update
Default configuration has service disabled (use Web UI to enable/start service or run uci set simple-adblock.config.enabled=1
) and selected ad/malware lists suitable for routers with 64Mb RAM. The configuration file has lists in descending order starting with biggest ones, comment out or delete the lists you don't want or your router can't handle.
You can use Web UI (found in Services/Simple AdBlock) to add/remove/edit links to:
Please note that these lists have to include either http://
or https://
prefix. Some of the top block lists (both hosts files and domains lists) suitable for routers with at least 8MB RAM are used in the default simple-adblock installation.
You can also use Web UI to add individual domains to be blocked or whitelisted.
If you want to use CLI to customize simple-adblock config, you can probably figure out how to do it by looking at the contents of /etc/config/simple-adblock
or output of the uci show simple-adblock
command.
This service downloads (and processes in the background, removing comments and other useless data) lists of hosts and domains to be blocked, combines those lists into one big block list, removes duplicates and sorts it and then removes your whitelisted domains from the block list before converting to to dnsmasq-compatible file and restarting dnsmasq. The result of the process is that dnsmasq returns "domain not found" for the blocked domains.
If you specify google.com
as a domain to be whitelisted, you will have access to google.com
, www.google.com
, analytics.google.com
, but not fake domains like email-google.com
or drive.google.com.verify.signin.normandeassociation.com
for example. If you only want to allow www.google.com
while blocking all other google.com
subdomains, just specify www.google.com
as domain to be whitelisted.
In general, whatever domain is specified to be whitelisted; it, along with with its subdomains will be whitelisted, but not any fake domains containing it.
Please head to OpenWrt Forum or LEDE Project Forum for discussion of this package.
1.5.6:
1.5.5:
1.5.3:
1.5.1:
1.5.0:
1.0.0: