A sett or set is a badger's den which usually consists of a network of tunnels and numerous entrances. Setts incorporate larger chambers used for sleeping or rearing young.
This script is designed to raise young Privacy Badgers by teaching them
about the trackers on popular sites. Every day,
crawler.py visits thousands of the top sites from the Tranco List with the latest version of Privacy Badger, and saves its findings in
See the following EFF.org blog post for more information: Giving Privacy Badger a Jump Start.
Prerequisites: have docker installed. Make sure your user is part of the
dockergroup so that you can build and run docker images without
sudo. You can add yourself to the group with
$ sudo usermod -aG docker $USER
Clone the repository
$ git clone https://github.com/efforg/badger-sett
Run a scan
This will run a scan with the latest version of Privacy Badger's master branch and won't commit the results.
To run the script with a different branch of privacy badger, set the
$ PB_BRANCH=my-feature-branch ./runscan.sh
You can also pass arguments to
crawler.py, the python script that does the actual crawl. Any arguments passed to
runscan.shwill be forwarded to
crawler.py. To control the number of sites that the crawler visits, use the
--num-sitesargument (the default is 2000). For example:
$ ./runscan.sh --num-sites 10
To exclude any sites with a given top level domain from the scan, pass in the
--excludeargument followed by the TLD suffix you want to exclude. For example, if you wanted to exclude all sites with a .gov TLD:
$ ./runscan.sh --exclude .gov
To exclude multiple TLDs from a scan, pass in each TLD separated by a comma, with no space between. For example, if you wanted to exclude all sites with .org and .net TLDs:
$ ./runscan.sh --exclude .org,.net
You can load another extension to run in parallel to Privacy Badger during a scan. Use the
--load-extensionflag and pass along the filepath for the
.xpifile that you want to load. For example:
$ ./runscan.sh --load-extension parallel-extensions/ublock.crx
Monitor the scan
To have the scan print verbose output about which sites it's visiting, use the
If you don't use that argument, all output will still be logged to
docker-out/log.txt, beginning after the script outputs "Running scan in Docker..."
To set up the script to run periodically and automatically update the repository with its results:
Create a new ssh key with
ssh-keygen. Give it a name unique to the repository.
$ ssh-keygen Generating public/private rsa key pair. Enter file in which to save the key (/home/USER/.ssh/id_rsa): /home/USER/.ssh/id_rsa_badger_sett
Add the new key as a deploy key with R/W access to the repo on Github. https://developer.github.com/v3/guides/managing-deploy-keys/
Add a SSH host alias for Github that uses the new key pair. Create or open
~/.ssh/configand add the following:
Host github-badger-sett HostName github.com User git IdentityFile /home/USER/.ssh/id_rsa_badger_sett
Configure git to connect to the remote over SSH. Edit
[remote "origin"] url = ssh://git@github-badger-sett:/efforg/badger-sett
This will have
gitconnect to the remote using the new SSH keys by default.
Create a cron job to call
runscan.shonce a day. Set the environment variable
RUN_BY_CRON=1to turn off TTY forwarding to
docker run(which would break the script in cron), and set
GIT_PUSH=1to have the script automatically commit and push
results.jsonwhen the scan finishes. Here's an example
0 0 * * * RUN_BY_CRON=1 GIT_PUSH=1 /home/USER/badger-sett/runscan.sh
If everything has been set up correctly, the script should push a new version of
results.jsonafter each crawl. Soon, whenever you
makea new version of Privacy Badger, it will pull the latest version of the crawler's data and ship it with the new version of the extension.