Pi-hole/pi-hole
Pi-hole/pi-hole
1
0
Fork 0
mirror of https://github.com/pi-hole/pi-hole.git synced 2024-11-15 02:42:58 +00:00
Code Issues Projects Releases Packages Wiki Activity
pi-hole/README.md
WaLLy3K 10c048d84a Use "Web Interface" verbiage throughout document 
* Also implement other reviewed suggestions
2017-09-30 13:21:29 +10:00

19 KiB
Raw Blame History


Network-wide ad blocking via your own Linux hardware

Core & Command Line Interface

Summary

The Pi-hole blocks ads via a DNS sinkhole, so all your devices are protected without the need to install client-side software.

  • Easy-to-install: our versatile installer walks you through the process, and takes less than ten minutes
  • Resolute: ads are blocked in non-browser locations such as ad-laden mobile apps and smart TVs
  • Fast: speeds up the feel of everyday browsing by caching DNS queries, saving bandwidth
  • Lightweight: runs smoothly and requires minimal resources
  • Robust: a command line interface for those preferring CLI, and/or wanting to automate tasks
  • Informative: a beautiful and secure Web Interface dashboard to control your Pi-hole
  • Versatile: can optionally function as a DHCP server, ensuring each device will not need further intervention
  • Scalable: capable of handling hundreds of millions of queries when installed on powerful hardware
  • Modern: blocks ads over both IPv4 and IPv6
  • Free: open source software which helps ensure you are the sole person in control of your privacy

One-Step Automated Install

  1. Install a supported operating system
  2. Run the following command

curl -sSL https://install.pi-hole.net | bash

Alternative Install Methods

Piping to bash can be dangerous, so we understand the importance of giving people the option to review our code! Our installer is found here, if you wish to read it before running.

You can install Pi-hole via one of the two alternative methods:

Clone our repository and run the automated installer from your device

git clone --depth 1 https://github.com/pi-hole/pi-hole.git Pi-hole
cd Pi-hole/automated\ install/
bash basic-install.sh

Manually download and execute the install file

wget -O basic-install.sh https://install.pi-hole.net
bash basic-install.sh

Post-install: Make your network take advantage of Pi-hole

Once the installer has been run, you will need to configure your router to have DHCP clients use the Pi-hole as their DNS server so that any device that connects to your network will have ads blocked without any further intervention.

If your router does not support setting the DNS server, you can use Pi-hole's built in DHCP server; just be sure to disable DHCP on your router first (if it has that feature available).

As a last resort, you can always manually set each device to use Pi-hole as their DNS server.

Pi-hole is free, but powered by your support

There are many reoccuring costs involved with maintaining free, open source and privacy respecting software; expenses which our volunteers pitch in to cover out-of-pocket. This is just one example of how strongly we feel about our software, as well as the importance of keeping it maintained.

Make no mistake: your support is absolutely vital to help keep us innovating!

Donations

Sending a donation using our links below is extremely helpful in offset a portion of our monthly costs:

Alternative support

If you'd rather not donate (which is okay!), there are other ways you can help support us:

Contributing via GitHub

We welcome everyone to contribute to issue reports, suggest new features and create pull requests.

If you have something to add - anything from a typo through to a whole new feature, we're happy to check it out! Just make sure to fill out our template when submitting your request; the questions that it asks will help the volunteers quickly understand what you're aiming to achieve.

You'll find that the install script and the debug script have an abundance of comments, which will help you better understand how Pi-hole works. They're also a valuable resource to those who want to learn how to write scripts or code a program! We encourage anyone who likes to tinker to read through it, and submit a pull request for us to review.

Presentations about Pi-hole

Word-of-mouth continues to help our project grow immensely, and we'd like to help those who are going to be presenting Pi-hole at a conference, meetup or even a school project. If you'd like some free swag to hand out to your audience, get in touch with us.

Getting in touch with us

Features

The Web Interface Dashboard

This optional open source dashboard allows you to view stats, change settings, and configure your Pi-hole.

Pi-hole Dashboard

There are several ways to access the dashboard:

  1. http://<IP_ADDPRESS_OF_YOUR_PI_HOLE>/admin/
  2. http:/pi.hole/admin/ (when using Pi-hole as your DNS server)
  3. http://pi.hole/ (when using Pi-hole as your DNS server)

The Faster-Than-Light Engine

The FTL API can be accessed via the Web, Command Line and telnet.

The Web (admin/api.php) and Command Line (pihole -c -j) will return json formatted output:

{
   "domains_being_blocked":111175,
   "dns_queries_today":15669,
   "ads_blocked_today":1752,
   "ads_percentage_today":11.181314,
   "unique_domains":1178,
   "queries_forwarded":9177,
   "queries_cached":4740,
   "unique_clients":18
}

More details on the API can be found here and telnet on the repo itself.

The Query Log

If enabled, the query log will show all of the DNS queries requested by clients using Pi-hole as their DNS server. Standard domains will show in green, and blocked (Pi-holed) domains will show in red. You can also whitelist or blacklist domains from within this section.

The query log and graphs are what have helped people discover all sorts of unexpected traffic traversing their networks.

Long-term Statistics

Using our FTL API, Pi-hole will store all the DNS queries in a database for later retrieval and analysis. You can view this data as a graph, individual queries, top clients/advertisers, or even query the database yourself for your own applications.

Whitelisting and Blacklisting

Domains can be whitelisted or blacklisted using either the dashboard, or via the pihole command.

Additional Blocklists

Pi-hole's stock block lists cover over 100,000 known ad-serving domains, which helps ensure you encounter minimal false positives. You can expand the blocking power of your Pi-hole by adding additional lists such as the ones found at The Big Blocklist Collection.

Enable and Disable Pi-hole

There are times where you may want to disable the blocking functionality, and turn it back on again. You can toggle this via the dashboard or command line.

Tools

Update Ad Lists

This runs gravity which checks your source list for updates, and downloads if changes are found.

Query Ad Lists

You can find out what blocklist a specific domain was found on. This is useful for troubleshooting websites that may not work properly due to a blocked domain.

tailing Log Files

You can watch the log files in real time to help debug any issues, or just see what's happening on your network.

Pi-hole Debugger

If you are having trouble with your Pi-hole, this is the place to go. You can run the debugger and it will attempt to diagnose any issues, and then link to an FAQ with instructions on rectifying the problem.

If run via the command line, you will see coloured text, which makes it easy to identify any problems.

After the debugger has finished, you have the option to upload it to our secure server for 48 hours. All you need to do is provide one of our developers the unique token generated by the debugger via one of the various ways of getting in touch with us.

You should be able to resolve most issues using the provided FAQ links, but we're always happy to help out if you'd like assistance!

Web Interface Settings

The settings page lets you control and configure your Pi-hole. You can do things like:

  • view networking information
  • flush logs or disable the logging of queries
  • enable Pi-hole's built-in DHCP server
  • manage block lists
  • exclude domains from the graphs and enable privacy options
  • configure upstream DNS servers
  • restart Pi-hole's services
  • back up some of Pi-hole's important files
  • and more!

Built-in DHCP Server

Pi-hole ships with a built-in DHCP server. This allows you to let your network devices use Pi-hole as their DNS server if your router does not let you adjust the DHCP options.

One nice feature of using Pi-hole's DHCP server if you can set hostnames and DHCP reservations so you'll see hostnames in the query log instead of IP addresses. You can still do this without using Pi-hole's DHCP server; it just takes a little more work. If you do plan to use Pi-hole's DHCP server, be sure to disable DHCP on your router first.

Real-time Statistics

Using chronometer2, you can view real-time stats via ssh or on an LCD screen such as the 2.8" LCD screen from Adafruit.

Simply run pihole -c for some detailed information.

Image courtesy of /u/super_nicktendo22

Technical Details

To summarize into a short sentence, the Pi-hole is an advertising-aware DNS/Web server. While quite outdated at this point, this original blog post about Pi-hole goes into great detail about how it was setup and how it works. Syntactically, it's no longer accurate, but the same basic principles and logic still apply to Pi-hole's current state.

Pi-hole Projects

Coverage