Side by Side Diff: sitescripts/content_blocker_lists/README.md
Issue 29332452:
Noissue - Add documentation for content_blocker_lists (Closed)
Patch Set: Minor corrections
Created Dec. 10, 2015, 1:08 p.m.
| Left: | ||
| Right: |
Use n/p to move between diff chunks;
N/P to move between comments.
« no previous file with comments
|
« no previous file
|
no next file »
|
no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')
| OLD | NEW |
|---|---|
| (Empty) | |
| 1 # Content blocker lists | |
| 2 | |
| 3 ## Introduction | |
| 4 | |
| 5 The `sitescripts.content_blocker_lists.bin` package contains scripts | |
| 6 used on the server side for producing our content blocker lists. | |
| 7 [Content blocker lists can be used by newer versions of Safari and iOS][1]. | |
| 8 | |
| 9 ## generate_lists.py | |
| 10 | |
| 11 The `generate_list.py` script wraps [abp2blocklist][2] so that we can more | |
| 12 conveniently produce our content blocker lists on our servers. The script | |
| 13 additionally wraps the lists with some metadata [as specified in issue 3176][3]. | |
| 14 | |
| 15 To use add the relevant configuration to your `scritescripts.ini` file. For | |
| 16 example: | |
| 17 | |
| 18 [content_blocker_lists] | |
| 19 abp2blocklist_url=https://hg.adblockplus.org/abp2blocklist | |
| 20 abp2blocklist_path=%(root)s/content_blocker_lists/abp2blocklist | |
| 21 easylist_url=https://easylist-downloads.adblockplus.org/easylist_noadult.txt | |
| 22 exceptionrules_url=https://easylist-downloads.adblockplus.org/exceptionrules .txt | |
| 23 easylist_content_blocker_path=%(root)s/content_blocker_lists/easylist_conten t_blocker.json | |
| 24 easylist_content_blocker_expires=4 days | |
| 25 combined_content_blocker_path=%(root)s/content_blocker_lists/easylist+except ionrules_content_blocker.json | |
| 26 combined_content_blocker_expires=4 days | |
| 27 | |
| 28 Then you can run the script as follows: | |
| 29 | |
| 30 python -m sitescripts.content_blocker_lists.bin.generate_lists | |
| 31 | |
| 32 [1]: https://webkit.org/blog/3476/content-blockers-first-look/ | |
| 33 [2]: https://hg.adblockplus.org/abp2blocklist/ | |
| 34 [3]: https://issues.adblockplus.org/ticket/3176 | |
| OLD | NEW |
« no previous file with comments
|
« no previous file
|
no next file »
|
no next file with comments »
