diff --git a/README b/README --- a/README +++ b/README @@ -1,64 +1,69 @@ -Adblock2Privoxy -Convert adblock config files to privoxy format += Adblock2Privoxy = -Introduction +''Convert adblock config files to privoxy format'' -AdBlock Plus browser plugin has great block lists provided by big community, but it is client software and cannot work on a server as a proxy. +== Introduction == +!AdBlock Plus browser plugin has great block lists provided by big community, +but it is client software and cannot work on a server as a proxy. -Privoxy proxy has good potential to block ads at server side, but it experiences acute shortage of updated block lists. +Privoxy proxy has good potential to block ads at server side, +but it experiences acute shortage of updated block lists. -This software converts adblock lists to privoxy config files format. +This software converts adblock lists to privoxy config files format. Almost all adblock features are supported including - -- block/unblock requests (on privoxy) - all syntax features are supported except for regex templates matching host name -- hide/unhide page elements (via CSS) - all syntax features are supported -- all block request options except for outdated ones: - Supported: script, image, stylesheet, object, xmlhttprequest, object-subrequest, subdocument,document, elemhide, other, popup, third-party, domain=..., match-case, donottrack - Unsupported: collapse, background, xbl, ping and dtd - -Tested with privoxy version 3.0.21. +* block/unblock requests (on privoxy) + * all syntax features are supported except for regex templates matching host name +* hide/unhide page elements (via CSS) + * all syntax features are supported +* all block request options except for outdated ones: + * Supported: script, image, stylesheet, object, xmlhttprequest, object-subrequest, subdocument,document, elemhide, other, popup, third-party, domain=..., match-case, donottrack + * Unsupported: collapse, background, xbl, ping and dtd + +Tested with privoxy version 3.0.21. Element blocking feature requires a webserver to serve CSS files. See Nginx and Apache config examples provided. -Usage: adblock2privoxy [OPTION...] [URL...] +== Usage == +{{{ +adblock2privoxy [OPTION...] [URL...] -v --version show version number -p PATH --privoxyDir=PATH privoxy config output path (required) -w PATH --webDir=PATH css files output path (optional, privoxyDir is used by default) -t PATH --taskFile=PATH path to task file containing urls to process -f --forced run even if no sources are expired +}}} +Example of first run: {{{ adblock2privoxy -p /etc/privoxy -w /var/www/privoxy -t my_ab2b.task https://easylist-downloads.adblockplus.org/easylist.txt https://easylist-downloads.adblockplus.org/advblock.txt my_custom.txt }}} -Example of first run: adblock2privoxy -p /etc/privoxy -w /var/www/privoxy -t my_ab2b.task https://easylist-downloads.adblockplus.org/easylist.txt https://easylist-downloads.adblockplus.org/advblock.txt my_custom.txt -Example of subsequent runs: adblock2privoxy -p /etc/privoxy -w /var/www/privoxy -t my_ab2b.task +Example of subsequent runs: {{{ adblock2privoxy -p /etc/privoxy -w /var/www/privoxy -t my_ab2b.task }}} The app generates following files - privoxyDir: - ab2p.system.action - ab2p.action - ab2p.system.filter - ab2p.filter - webDir: - ab2p.common.css - ab2p.css - [lot of directories for first level domain names] - taskFile: - special file containing execution details. It can be reused to update privoxy config from same sources. + * privoxyDir: + * ab2p.system.action + * ab2p.action + * ab2p.system.filter + * ab2p.filter + * webDir: + * ab2p.common.css + * ab2p.css + * [lot of directories for first level domain names] + * taskFile: + * special file containing execution details. It can be reused to update privoxy config from same sources. -How to apply results +== How to apply results == 1) Install privoxy. Optionally setup it as transparent proxy 2) Change privoxy config file: Add following lines - +{{{ actionsfile ab2p.system.action actionsfile ab2p.action filterfile ab2p.system.filter filterfile ab2p.filter +}}} 3) Install nginx or apache webserver Nginx config example: - +{{{ server { listen 80; #ab2p css domain name (optional) @@ -78,8 +83,10 @@ try_files $uri $1ab2p.css; } } -Apache config example: +}}} +Apache config example: +{{{ #ab2p css domain name (optional) ServerName www.example.com @@ -98,11 +105,12 @@ RewriteCond %{DOCUMENT_ROOT}/%{REQUEST_FILENAME} !-f RewriteRule (^.*/+)[^/]+/+ab2p.css$ $1ab2p.css [N] -4) Download adblock config files. Some download locations -EasyList: ​https://easylist.adblockplus.org/en/ -Russian AD list: ​https://code.google.com/p/ruadlist/ +}}} +4) Find out files to use. Some download locations +* !EasyList: https://easylist.adblockplus.org/en/ +* Russian AD list: https://code.google.com/p/ruadlist/ -5) Run adblock2privoxy providing privoxy dir, web dir and adblock input files +5) Run adblock2privoxy providing privoxy dir, web dir and adblock input file urls 6) Restart privoxy and apache to load updated configs diff --git a/adblock2privoxy.cabal b/adblock2privoxy.cabal --- a/adblock2privoxy.cabal +++ b/adblock2privoxy.cabal @@ -1,5 +1,5 @@ name: adblock2privoxy -version: 1.2.1 +version: 1.2.2 cabal-version: >= 1.6 build-type: Make author: Alexey Zubritsky @@ -15,22 +15,29 @@ stability: stable synopsis: Convert adblock config files to privoxy format description: - AdBlock Plus browser plugin has great block list files provided by big community, - but it is client software and cannot work on a server as proxy. - . - Privoxy proxy has good potential to block ads at server side, - but it experiences acute shortage of updated block lists. - . - This software converts adblock lists to privoxy config files format. - . - Almost all adblock features are supported including - - block/unblock requests (on privoxy) + [AdBlock Plus] browser plugin has great block list files provided by big community, + but it is client software and cannot work on a server as proxy. + . + [Privoxy] proxy has good potential to block ads at server side, + but it experiences acute shortage of updated block lists. + . + This software converts adblock lists to privoxy config files format. + . + Almost all adblock features are supported including + . + * block/unblock requests (on privoxy) + . all syntax features are supported except for regex templates matching host name - - hide/unhide page elements (via CSS) + . + * hide/unhide page elements (via CSS) + . all syntax features are supported - - all block request options except for outdated ones: - Supported: script, image, stylesheet, object, xmlhttprequest, object-subrequest, subdocument, - document, elemhide, other, popup, third-party, domain=..., match-case, donottrack + . + * all block request options except for outdated ones: + . + Supported: script, image, stylesheet, object, xmlhttprequest, object-subrequest, subdocument, + document, elemhide, other, popup, third-party, domain=..., match-case, donottrack + . Unsupported: collapse, background, xbl, ping and dtd homepage: https://projects.zubr.me/wiki/adblock2privoxy category: Web @@ -72,4 +79,4 @@ source-repository this type: git location: ​http://projects.zubr.me/adblock2privoxy.git - tag: 1.2.1 + tag: 1.2.2 diff --git a/changelog b/changelog --- a/changelog +++ b/changelog @@ -1,4 +1,4 @@ -1.2.1 +1.2.2 * Documentation 1.1.0