Skip to content

Commit

Permalink
release blocklist
Browse files Browse the repository at this point in the history
  • Loading branch information
blocklist committed Oct 9, 2024
0 parents commit 8f48aab
Show file tree
Hide file tree
Showing 37 changed files with 129,236 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

custom: ['https://ph00lt0.github.io/blocklist/#donations']
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/broken-website-or-app.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Broken website or app
about: Report a broken website or app caused by this blocklist
title: ''
labels: ''
assignees: ''

---

**Tool used (pick one)**:
- [ ] uBlock Origin
- [ ] Adguard for iOS
- [ ] Adguard for Android
- [ ] Adguard Browser add-on/extension
- [ ] Brave Ad Block
- [ ] PiHole
- [ ] Adguard Home

[comment]: <> (Change one of the boxes to - [x] to "select" it.)


**What service are you trying to use?'**


**What does not work?**


**Which rule you believe is causing this?**
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.DS_Store
.idea
domains-to-insert.txt
blocklist/*
__pycache__/*
*/__pycache__/*
28 changes: 28 additions & 0 deletions .gitlab/issue_templates/broken-website-or-app.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Broken website or app
about: Report a broken website or app caused by this blocklist
title: ''
labels: ''
assignees: ''

---

**Tool used (pick one)**:
- [ ] uBlock Origin
- [ ] Adguard for iOS
- [ ] Adguard for Android
- [ ] Adguard Browser add-on/extension
- [ ] Brave Ad Block
- [ ] PiHole
- [ ] Adguard Home

[comment]: <> (Change one of the boxes to - [x] to "select" it.)


**What service are you trying to use?'**


**What does not work?**


**Which rule you believe is causing this?**
100 changes: 100 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
# Getting started

## Use both repositories

```zsh
git clone git@gitlab.com:ph00lt0/blocklists.git
cd blocklists
git remote add github git@github.com:ph00lt0/blocklists.git
```

## Init project

```zsh
python3 -m venv blocklist
source blocklist/bin/activate
pip install -r requirements.txt
# add simple command to open project and venv by just typing block
echo "$(pwd)" > ~/.blocklist
echo "alias block='cd \$(cat ~/.blocklist) && source \$(cat ~/.blocklist)/blocklist/bin/activate'" >> ~/.zshrc
echo "alias block='cd \$(cat ~/.blocklist) && source \$(cat ~/.blocklist)/blocklist/bin/activate'" >> ~/.bashrc
echo "python cleanup.py" > .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit
```

## Insert

```zsh
block
python insert.py
```

Insert supports, domains and filepaths.

If you enter a domain name, https:// or http and trailing / are automatically being removed if included.
So https://annoyingtrackers.com/ becomes: annoyingtrackers.com

Hit enter, and the domain will be added to the list.

## Badlist

```zsh
block
python badlist.py
```

Badlist supports filepaths and domains.

## Made a mistake?

Make your changes in blocklist.txt and commit.

## Remove a URL parameter (legacy)

```zsh
./insert-filter-remove-parameter.sh
```

OR

```zsh
insert-filter-remove-parameter-domain.sh
```
Carefully choose whether to remove a parameter from only a single domain or globally. A clear tracker can be removed from all websites, but a UID may be required for some websites to operate. Generic UID names should not be removed globally.

Depending on the script enter the domain name and the parameter to remove. The script will do the rest.

## Remove element by class or id (legacy)

```zsh

./insert-filter-remove-element.sh
```

- Enter the domain
- Enter the identifier, following given instructions

Hit enter, and the rule will be added to the blocklist. Note that this won't be in the pihole blocklist and work for DNS only filters

## Add filter to remove a class from element (legacy)

```zsh
./insert-filter-remove-class.sh
```

Do you want to remove a class from an element? For example a class making the body disappear to show a cookie banner?

- Enter the domain name, the class, and the element to remove it from

Hit enter, and the class removal rule will be added
Note that all rules are set to stay active, so that they will continue to work on page refreshes as well as with async content.

## Add filter to remove hidden overflow (legacy)

```zsh
./insert-filter-remove-overflow-hidden.sh
```

- Enter the domain name

Hit enter, and the hidden overflow will be removed from the body
Loading

0 comments on commit 8f48aab

Please sign in to comment.