Marown/hosts
1
0
Fork 0
mirror of https://github.com/StevenBlack/hosts.git synced 2024-06-28 16:45:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

Refinements to the readme template.

Browse Source 
Signed-off-by: Steven Black <steveb@stevenblack.com>
This commit is contained in:
Steven Black 2015-10-18 20:56:58 -04:00
parent 954173f6f2
commit e7738d82bb
1 changed files with 27 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
readme_template.md
View File

@ -1,6 +1,7 @@
#Amalgamated hosts file
This repo consolidates several reputable `hosts` files and consolidates them into a single hosts file that you can use.
This repo consolidates several reputable `hosts` files and consolidates them into a single
amalgamated file with duplicates removed.
**Currently this hosts file contains @NUM_ENTRIES@ unique entries.**
@ -15,28 +16,35 @@ Currently the `hosts` files from the following locations are amalgamated:
* Peter Lowe at [http://pgl.yoyo.org/adservers/](http://pgl.yoyo.org/adservers/), updated regularly.
* My own small list in raw form [here](https://raw.github.com/StevenBlack/hosts/master/data/StevenBlack/hosts).
You can add any additional sources you'd like under the data/ directory. Provide a copy of the current `hosts` file and a file called
update.info with the URL to the `hosts` file source. This will allow updateHostsFile.py to automatically update your source.
You can add additional sources by placing them in the `data/` directory. Provide a copy of that new
`hosts` file, and place its update url in `update.info`. The `updateHostsFile.py` routine will
automatically refresh the `hosts` file from source each time a new amalgamated file is generated.
## Using updateHostsFile.py
This Python script will generate a unique hosts file based on the sources provided. You can either have the script go out and fetch an updated version over the web (defined by the update.info text file in the source's directory), or it will use the `hosts` file you already have checked into your source's data folder.
This Python script will generate a unique hosts file based on the sources in the `data/` folder.
You can either have the script go out and fetch an updated version over the web (defined by the
update.info text file in the source's directory), or it will use the `hosts` file that's already
there.
Usage
python updateHostsFile.py
**TAKE NOTE** this script is tested with Python version 2.7.10. I hope to have a Python 3 version soon.
**TAKE NOTE** this script is tested with Python version 2.7.10.
## What is a hosts file?
A hosts file, named `hosts` (with no file extension), is a plain-text file used by all operating systems to map hostnames to IP addresses.
A hosts file, named `hosts` (with no file extension), is a plain-text file used by all operating
systems to map hostnames to IP addresses.
In most operating systems, the `hosts` file is preferential to `DNS`. Therefore if a host name is resolved by the `hosts` file, the request never leaves your computer.
In most operating systems, the `hosts` file is preferential to `DNS`. Therefore if a host name is
resolved by the `hosts` file, the request never leaves your computer.
Having a smart `hosts` file goes a long way towards blocking malware, adware, and other irritants.
For example, to nullify requests to some doubleclick.net servers, adding these lines to your hosts file will do it:
For example, to nullify requests to some doubleclick.net servers, adding these lines to your hosts
file will do it:
# block doubleClick's servers
127.0.0.1 ad.ae.doubleclick.net
@ -48,21 +56,24 @@ For example, to nullify requests to some doubleclick.net servers, adding these l
## Why use `0.0.0.0` instead of `127.0.0.1`?
Using `0.0.0.0` is faster because you don't have to wait for a timeout. It also does not interfere with a web server that may be running on the local PC.
Using `0.0.0.0` is faster because you don't have to wait for a timeout. It also does not interfere
with a web server that may be running on the local PC.
## Why not use just `0` instead of `0.0.0.0`?
We tried that. Using `0` doesn't work universally.
## Location of your hosts file
To modify your current `hosts` file, look for it in the following places and modify it with a text editor.
To modify your current `hosts` file, look for it in the following places and modify it with a text
editor.
**Mac OS X, iOS, Android, Linux**: `/etc/hosts` folder.
**Windows**: `%SystemRoot%\system32\drivers\etc\hosts` folder.
## Reloading hosts file
Your operating system will cache DNS lookups. You can either reboot or run the following commands to manually flush your DNS cache once the new hosts file is in place.
Your operating system will cache DNS lookups. You can either reboot or run the following commands to
manually flush your DNS cache once the new hosts file is in place.
### Mac OS X
Open a Terminal and run:
@ -74,9 +85,11 @@ Open a Command Prompt:
**Windows XP**: Start -> Run -> `cmd`
**Windows Vista, 7**: Start Button -> type `cmd` -> right-click Command Prompt -> "Run as Administrator"
**Windows Vista, 7**: Start Button -> type `cmd` -> right-click Command Prompt ->
"Run as Administrator"
**Windows 8**: Start -> Swipe Up -> All Apps -> Windows System -> right-click Command Prompt -> "Run as Administrator"
**Windows 8**: Start -> Swipe Up -> All Apps -> Windows System -> right-click Command Prompt ->
"Run as Administrator"
and run: