Changeset ba21d0e in adblock2privoxy


Ignore:
Timestamp:
Apr 11, 2014 11:32:30 PM (6 years ago)
Author:
zubr <a@…>
Branches:
master
Children:
f5a4c35
Parents:
25054f4
Message:

Docs formatting

Files:
2 edited

Legend:

Unmodified
Added
Removed
  • README

    rf180591 rba21d0e  
    1 Adblock2Privoxy 
    2 Convert adblock config files to privoxy format 
     1= Adblock2Privoxy = 
    32 
    4 Introduction 
     3''Convert adblock config files to privoxy format'' 
    54 
    6 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. 
     5== Introduction == 
     6!AdBlock Plus browser plugin has great block lists provided by big community, 
     7but it is client software and cannot work on a server as a proxy. 
    78 
    8 Privoxy proxy has good potential to block ads at server side, but it experiences acute shortage of updated block lists. 
     9Privoxy proxy has good potential to block ads at server side,  
     10but it experiences acute shortage of updated block lists. 
    911 
    10 This software converts adblock lists to privoxy config files format. 
     12This software converts adblock lists to privoxy config files format.    
    1113 
    1214Almost all adblock features are supported including 
    13  
    14 - block/unblock requests (on privoxy) 
    15     all syntax features are supported except for regex templates matching host name 
    16 - hide/unhide page elements (via CSS) 
    17     all syntax features are supported 
    18 - all block request options except for outdated ones: 
    19     Supported: script, image, stylesheet, object, xmlhttprequest, object-subrequest, subdocument,document, elemhide, other, popup, third-party, domain=..., match-case, donottrack 
    20     Unsupported: collapse, background, xbl, ping and dtd 
    21      
    22 Tested with privoxy version 3.0.21.  
     15* block/unblock requests (on privoxy) 
     16  * all syntax features are supported except for regex templates matching host name 
     17* hide/unhide page elements (via CSS) 
     18  * all syntax features are supported 
     19* all block request options except for outdated ones: 
     20  * Supported: script, image, stylesheet, object, xmlhttprequest, object-subrequest, subdocument,document, elemhide, other, popup, third-party, domain=..., match-case, donottrack 
     21  * Unsupported: collapse, background, xbl, ping and dtd 
     22   
     23Tested with privoxy version 3.0.21. 
    2324Element blocking feature requires a webserver to serve CSS files. See Nginx and Apache config examples provided. 
    2425 
    25 Usage: adblock2privoxy [OPTION...] [URL...] 
     26== Usage == 
     27{{{ 
     28adblock2privoxy [OPTION...] [URL...] 
    2629  -v       --version          show version number 
    2730  -p PATH  --privoxyDir=PATH  privoxy config output path (required) 
     
    2932  -t PATH  --taskFile=PATH    path to task file containing urls to process 
    3033  -f       --forced           run even if no sources are expired 
     34}}}   
     35Example 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 }}} 
    3136 
    32 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 
    33 Example of subsequent runs: adblock2privoxy -p /etc/privoxy -w /var/www/privoxy -t my_ab2b.task 
     37Example of subsequent runs: {{{ adblock2privoxy -p /etc/privoxy -w /var/www/privoxy -t my_ab2b.task }}} 
    3438 
    3539The app generates following files 
    36         privoxyDir:  
    37                 ab2p.system.action 
    38                 ab2p.action 
    39                 ab2p.system.filter 
    40                 ab2p.filter 
    41         webDir:  
    42                 ab2p.common.css 
    43                 ab2p.css 
    44                 [lot of directories for first level domain names]  
    45         taskFile: 
    46             special file containing execution details. It can be reused to update privoxy config from same sources.  
     40        * privoxyDir:  
     41                * ab2p.system.action 
     42                * ab2p.action 
     43                * ab2p.system.filter 
     44                * ab2p.filter 
     45        * webDir:  
     46                * ab2p.common.css 
     47                * ab2p.css 
     48                * [lot of directories for first level domain names]  
     49        * taskFile: 
     50                * special file containing execution details. It can be reused to update privoxy config from same sources.  
    4751 
    48 How to apply results 
     52== How to apply results == 
    4953 
    50541) Install privoxy. Optionally setup it as transparent proxy 
    5155 
    52562) Change privoxy config file: Add following lines 
    53  
     57{{{ 
    5458actionsfile ab2p.system.action 
    5559actionsfile ab2p.action 
    5660filterfile ab2p.system.filter 
    5761filterfile ab2p.filter 
     62}}} 
    58633) Install nginx or apache webserver 
    5964 
    6065Nginx config example: 
    61  
     66{{{      
    6267server { 
    6368        listen 80; 
     
    7984        }  
    8085} 
     86}}} 
     87 
    8188Apache config example: 
    82  
     89{{{ 
    8390<VirtualHost *:80> 
    8491        #ab2p css domain name (optional) 
     
    99106        RewriteRule (^.*/+)[^/]+/+ab2p.css$ $1ab2p.css [N] 
    100107</VirtualHost> 
    101 4) Download adblock config files. Some download locations 
    102 EasyList: ​https://easylist.adblockplus.org/en/ 
    103 Russian AD list: ​https://code.google.com/p/ruadlist/ 
     108}}} 
     1094) Find out files to use. Some download locations 
     110* !EasyList: https://easylist.adblockplus.org/en/ 
     111* Russian AD list: https://code.google.com/p/ruadlist/ 
    104112 
    105 5) Run adblock2privoxy providing privoxy dir, web dir and adblock input files 
     1135) Run adblock2privoxy providing privoxy dir, web dir and adblock input file urls 
    106114 
    1071156) Restart privoxy and apache to load updated configs 
  • adblock2privoxy.cabal

    r25054f4 rba21d0e  
    1616synopsis:       Convert adblock config files to privoxy format 
    1717description:     
    18                      AdBlock Plus browser plugin has great block list files provided by big community, 
    19                      but it is client software and cannot work on a server as proxy. 
    20                      . 
    21                      Privoxy proxy has good potential to block ads at server side,  
    22                      but it experiences acute shortage of updated block lists. 
    23                      . 
    24                      This software converts adblock lists to privoxy config files format.    
    25                      . 
    26                      Almost all adblock features are supported including 
    27                      - block/unblock requests (on privoxy) 
     18                       [AdBlock Plus] browser plugin has great block list files provided by big community, 
     19                       but it is client software and cannot work on a server as proxy. 
     20                       . 
     21                       [Privoxy] proxy has good potential to block ads at server side, 
     22                       but it experiences acute shortage of updated block lists. 
     23                       . 
     24                       This software converts adblock lists to privoxy config files format. 
     25                       . 
     26                       Almost all adblock features are supported including 
     27                       . 
     28                       * block/unblock requests (on privoxy) 
     29                       . 
    2830                       all syntax features are supported except for regex templates matching host name 
    29                      - hide/unhide page elements (via CSS) 
     31                       . 
     32                       * hide/unhide page elements (via CSS) 
     33                       . 
    3034                       all syntax features are supported 
    31                      - all block request options except for outdated ones: 
    32                        Supported: script, image, stylesheet, object, xmlhttprequest, object-subrequest, subdocument,  
    33                                   document, elemhide, other, popup, third-party, domain=..., match-case, donottrack 
     35                       . 
     36                       * all block request options except for outdated ones: 
     37                       . 
     38                       Supported: script, image, stylesheet, object, xmlhttprequest, object-subrequest, subdocument, 
     39                       document, elemhide, other, popup, third-party, domain=..., match-case, donottrack 
     40                       . 
    3441                       Unsupported: collapse, background, xbl, ping and dtd 
    3542homepage:       https://projects.zubr.me/wiki/adblock2privoxy 
Note: See TracChangeset for help on using the changeset viewer.