https://github.com/soulteary/hosts-blackhole

BEST hosts list processing helper for ad-blocking/blocker programs: AdGuard, AdAway, blocky, grimd...
https://github.com/soulteary/hosts-blackhole

ad-blocker adaway adaway-blocklist adguard adguard-blocklist blocky grimd

Last synced: 10 months ago
JSON representation

BEST hosts list processing helper for ad-blocking/blocker programs: AdGuard, AdAway, blocky, grimd...

• Host: GitHub
• URL: https://github.com/soulteary/hosts-blackhole
• Owner: soulteary
• License: apache-2.0
• Created: 2022-05-30T12:41:13.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-06-01T20:31:18.000Z (about 3 years ago)
• Last Synced: 2025-04-28T16:55:30.573Z (about 1 year ago)
• Topics: ad-blocker, adaway, adaway-blocklist, adguard, adguard-blocklist, blocky, grimd
• Language: HTML
• Homepage:
• Size: 129 KB
• Stars: 3
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# Hosts Blackhole

[![Security Scan](https://github.com/soulteary/hosts-blackhole/actions/workflows/scan.yml/badge.svg)](https://github.com/soulteary/hosts-blackhole/actions/workflows/scan.yml) [![Release](https://github.com/soulteary/hosts-blackhole/actions/workflows/release.yaml/badge.svg)](https://github.com/soulteary/hosts-blackhole/actions/workflows/release.yaml) ![](https://img.shields.io/badge/AdAway-hosts-brightgreen) ![](https://img.shields.io/badge/AdGuard-domains-brightgreen) ![](https://img.shields.io/badge/StevenBlack-hosts-brightgreen) ![](https://img.shields.io/badge/NoTrack-blocklists-brightgreen)

[![License: Apache v2](https://img.shields.io/badge/LICENSE-Apache%20v2-blue)](/LICENSE.md)



BEST hosts list processing helper for ad-blocking/blocker programs: AdGuard, AdAway, blocky, grimd...

## Data sources Supported

Currently supported data sources:

ProjectFiles

StevenBlack/hosts

File

quidsup/notrack-blocklists

File1 / File2

AdAway/adaway.github.io

File1 / File2

AdguardTeam/AdGuardSDNSFilter

File

Hosts Count:

```bash

 - AdAway default blocklist  =        7038   

 - AdGuard DNS filter        =       45842   

 - StevenBlack/hosts         =      143542   

 - NoTrack Tracker Blocklist =       14698   

 - NoTrack Malware Blocklist =         305  

```

## Docker

You can download images from dockerhub, get up and running quickly:

```bash

docker run --rm -it -p 8345:8345 \

    -v `pwd`/data:/data \

    -v `pwd`/cache:/cache \

    soulteary/hosts-blackhole

```

## CLI && ENV

CLI parameters:

```bash

  --debug      enable debug mode

  --port int   web port (default 8345)

```

usage: `./hbh --port=8345 --debug=false`

Env variables:

```bash

HBH_DEBUG=true

HBH_PORT=1024

```

usage: `HBH_DEBUG=true HBH_PORT=1024 ./hbh`

## APIs && Pages

API:

- `/data/hosts.txt` Get data file which contains all domains.

- `/ping` Health check

- `/purge` Attempt to reanalyze the data file and generate a cache file

Pages:

- `/` Homepage

- `/list` View available data sources

- `/data` Data source index page

- `/stats` System stats

## Screenshot

![](./screenshot/home.png)

![](./screenshot/list.png)