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
A black hole for Internet advertisements
4271 commits 8 branches 109 tags 27 MiB
Shell 83.8%
Python 12.4%
Roff 2.5%
Dockerfile 1.3%
Find a file
DL6ER 1632632668
Merge pull request #3259 from pi-hole/update_devel 
Update development from release/v5.0
2020-04-08 12:28:29 +02:00
.github Assorted typo fixes. (#3126) 2020-03-08 16:53:14 -07:00
.idea Finished space conversion 2018-07-05 23:47:55 -07:00
advanced Merge branch 'release/v5.0' into development 2020-04-08 12:02:53 +02:00
automated install Merge branch 'release/v5.0' into development 2020-04-08 12:02:53 +02:00
block hulu ads ATV Hulu domain add 2016-02-02 12:20:30 -05:00
manpages Add missing hyphens. 2019-08-22 13:57:01 +02:00
test Assorted typo fixes. (#3126) 2020-03-08 16:53:14 -07:00
.editorconfig Finished space conversion 2018-07-05 23:47:55 -07:00
.gitattributes linux style line endings enforced 2017-02-20 21:12:04 +00:00
.gitignore Assorted typo fixes. (#3126) 2020-03-08 16:53:14 -07:00
.stickler.yml Lets try the correct name for csslint 2018-04-15 23:46:52 +01:00
.travis.yml use py3 instead py2 (#3153) 2020-03-02 23:30:44 -08:00
autotest setupVar tests passing for debian & centos 2016-10-10 23:14:39 -05:00
CONTRIBUTING.md Remove dead link from CONTRIBUTING.md 2018-03-25 21:59:35 -07:00
gravity.sh Merge branch 'release/v5.0' into development 2020-04-08 12:02:53 +02:00
LICENSE Update LICENSE of the project to EUPL v1.2 2017-06-03 15:06:00 +02:00
pihole Assorted typo fixes. (#3126) 2020-03-08 16:53:14 -07:00
README.md docs: fix typo 2019-11-29 13:46:05 +13:00
requirements.txt Pin Python package versions to the versions in the last successful build 2019-03-13 20:14:21 -07:00
setup.py Tox! 2018-07-11 23:24:28 -05:00
tox.ini use py3 instead py2 (#3153) 2020-03-02 23:30:44 -08:00

README.md

Pi-hole
Network-wide ad blocking via your own Linux hardware

The Pi-hole® is a DNS sinkhole that protects your devices from unwanted content, without installing any client-side software.

  • Easy-to-install: our versatile installer walks you through the process, and takes less than ten minutes
  • Resolute: content is blocked in non-browser locations, such as ad-laden mobile apps and smart TVs
  • Responsive: seamlessly speeds up the feel of everyday browsing by caching DNS queries
  • Lightweight: runs smoothly with minimal hardware and software requirements
  • Robust: a command line interface that is quality assured for interoperability
  • Insightful: a beautiful responsive Web Interface dashboard to view and control your Pi-hole
  • Versatile: can optionally function as a DHCP server, ensuring all your devices are protected automatically
  • Scalable: capable of handling hundreds of millions of queries when installed on server-grade 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

Codacy Badge Build Status BountySource

One-Step Automated Install

Those who want to get started quickly and conveniently may install Pi-hole using the following command:

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

Alternative Install Methods

Piping to bash is controversial, as it prevents you from reading code that is about to run on your system. Therefore, we provide these alternative installation methods which allow code review before installation:

Method 1: Clone our repository and run

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

Method 2: Manually download the installer and run

wget -O basic-install.sh https://install.pi-hole.net
sudo 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 Pi-hole as their DNS server which ensures that all devices connecting to your network will have content 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 reoccurring costs involved with maintaining free, open source, and privacy-respecting software; expenses which our volunteer developers 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 offsetting a portion of our monthly expenses:

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 so we are helping make this easier for people.

If you are going to be presenting Pi-hole at a conference, meetup or even a school project, get in touch with us so we can hook you up with free swag to hand out to your audience!

Getting in touch with us

While we are primarily reachable on our Discourse User Forum, we can also be found on a variety of social media outlets. Please be sure to check the FAQ's before starting a new discussion, as we do not have the spare time to reply to every request for assistance.

Breakdown of Features

The Command Line Interface

The pihole command has all the functionality necessary to be able to fully administer the Pi-hole, without the need of the Web Interface. It's fast, user-friendly, and auditable by anyone with an understanding of bash.

Pi-hole Blacklist Demo

Some notable features include:

You can read our Core Feature Breakdown, as well as read up on example usage for more information.

The Web Interface Dashboard

This optional dashboard allows you to view stats, change settings, and configure your Pi-hole. It's the power of the Command Line Interface, with none of the learning curve!

Pi-hole Dashboard

Some notable features include:

  • Mobile friendly interface
  • Password protection
  • Detailed graphs and doughnut charts
  • Top lists of domains and clients
  • A filterable and sortable query log
  • Long Term Statistics to view data over user-defined time ranges
  • The ability to easily manage and configure Pi-hole features
  • ... and all the main features of the Command Line Interface!

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)

Faster-than-light Engine

FTLDNS is a lightweight, purpose-built daemon used to provide statistics needed for the Web Interface, and its API can be easily integrated into your own projects. As the name implies, FTLDNS does this all very quickly!

Some of the statistics you can integrate include:

  • Total number of domains being blocked
  • Total number of DNS queries today
  • Total number of ads blocked today
  • Percentage of ads blocked
  • Unique domains
  • Queries forwarded (to your chosen upstream DNS server)
  • Queries cached
  • Unique clients

The API can be accessed via telnet, the Web (admin/api.php) and Command Line (pihole -c -j). You can out find more details over here.

The Origin Of Pi-hole

Pi-hole being an advertising-aware DNS/Web server, makes use of the following technologies:

  • dnsmasq - a lightweight DNS and DHCP server
  • curl - A command line tool for transferring data with URL syntax
  • lighttpd - web server designed and optimized for high performance
  • php - a popular general-purpose web scripting language
  • AdminLTE Dashboard - premium admin control panel based on Bootstrap 3.x

While quite outdated at this point, this original blog post about Pi-hole goes into great detail about how Pi-hole was originally set up 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.

Coverage

Pi-hole Projects