hblock/README.md
Héctor Molinero Fernández cc28af5912 Updated docs
2020-10-23 01:13:02 +02:00

53 lines
2.1 KiB
Markdown

<p align="center">
<a href="https://hblock.molinero.dev">
<img src="resources/logo/vectors/logo-a.svg" width="320" height="100">
</a>
</p>
<p align="center">
Improve your security and privacy by blocking ads, tracking and malware domains.
</p>
<p align="center">
<a href="https://github.com/hectorm/hblock/releases">
<img src="https://img.shields.io/github/v/tag/hectorm/hblock?label=version">
</a>
<a href="https://hblock.molinero.dev">
<img src="https://img.shields.io/website/https/hblock.molinero.dev.svg?label=nightly%20builds">
</a>
<a href="./LICENSE.md">
<img src="https://img.shields.io/github/license/hectorm/hblock?label=license">
</a>
</p>
## What is this for?
This POSIX-compliant shell script, designed for Unix-like systems, gets a list of domains that serve ads, tracking scripts and malware from
[multiple sources](./SOURCES.md) and creates a [hosts file](https://en.wikipedia.org/wiki/Hosts_(file)) (alternative formats are also supported) that
prevents your system from connecting to them.
## Installation
hBlock is available in various package managers. Please check the [PACKAGES.md](./PACKAGES.md) file for an up-to-date list.
The latest available version can also be installed manually by running the following command:
```sh
curl -o /tmp/hblock 'https://raw.githubusercontent.com/hectorm/hblock/v2.1.7/hblock' \
&& echo 'e357fc9439d7b79036c7939f976aab9cbd25878c4651e5a757e30ff96452edc2 /tmp/hblock' | shasum -c \
&& sudo mv /tmp/hblock /usr/local/bin/hblock \
&& sudo chown root:root /usr/local/bin/hblock \
&& sudo chmod 755 /usr/local/bin/hblock
```
Additionally, a [systemd timer](resources/systemd/) can be set to regularly update the hosts file for new additions.
## Usage
The default behavior of hBlock can be adjusted with multiple options. Use the `--help` option or check the [USAGE.md](./USAGE.md) file for the full list.
[![asciicast](https://asciinema.org/a/GmZOda836hfjonpy299PnFcJl.svg)](https://asciinema.org/a/GmZOda836hfjonpy299PnFcJl)
## Nightly builds
Nightly builds of the hosts file among other formats can be found [on the hBlock website](https://hblock.molinero.dev).