rhosts/README.md

1.8 KiB

rhosts

This reroutes urls to 0.0.0.0 and ::1 in order to block them from being reached. This is useful for blocking different types of content.

How to Install

Linux

Build Dependencies:

  • make
  • golang

Linux/Systemd:

make install

Build for Windows on Linux:

make build-win

Windows

Build Dependencies:

Windows:

cd src
go build .

Building has not been tested on Windows; however, it will fail because the version.go file is generated using the Makefile

How to use

Configuring

Open the config file:

Linux: /etc/rhosts/rhosts.cfg
Windows: \ProgramData\rhosts\rhosts.cfg

There are 3 types of entries: download, site, and whitelist. Downloads are downloaded and stripped of comments and bad entries if possible before being added to a list of sites. Whitelisted urls are removed from the list of sites. From there all the urls are added to the hosts file for both IPv4 and IPv6. You can also add comments by prepending with a '#'.

Example:

# This is a static entry
site=www.site.xyz
# This is a download entry
download=w3.site.xyz/location/to/config.txt
# This is a whitelist entry
whitelist=www.site.xyz

Running

Easiest thing is to just run the command rhosts

If enabling as a service with systemd:

systemctl enable rhosts.service

You can also run it using Systemd:

systemctl start rhosts.service

Flags

  • --version

Displays version information

  • -d

Runs in daemon mode, refreshing every 24hrs (1440 minutes**

  • -t

Changes the daemon refresh time

  • --removetimestamp

Removes the timestamp on the log so it doesn't interfere with other log systems such as Systemd