Pi-hole core v5.0
|2 months ago|
|.github||5 months ago|
|.idea||2 years ago|
|advanced||2 months ago|
|automated install||2 months ago|
|block hulu ads||4 years ago|
|manpages||2 months ago|
|test||2 months ago|
|.editorconfig||2 years ago|
|.gitattributes||3 years ago|
|.gitignore||2 years ago|
|.stickler.yml||2 years ago|
|.travis.yml||2 years ago|
|CONTRIBUTING.md||2 years ago|
|LICENSE||3 years ago|
|README.md||7 months ago|
|autotest||3 years ago|
|gravity.sh||2 months ago|
|pihole||3 months ago|
|requirements.txt||1 year ago|
|setup.py||2 years ago|
|tox.ini||2 years ago|
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
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:
git clone --depth 1 https://github.com/pi-hole/pi-hole.git Pi-hole cd "Pi-hole/automated install/" sudo bash basic-install.sh
wget -O basic-install.sh https://install.pi-hole.net sudo bash basic-install.sh
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.
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!
Sending a donation using our links below is extremely helpful in offsetting a portion of our monthly expenses:
If you’d rather not donate (which is okay!), there are other ways you can help support us:
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.
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!
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.
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
Some notable features include:
sshor your TFT LCD screen
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!
Some notable features include:
There are several ways to access the dashboard:
http://pi.hole/admin/(when using Pi-hole as your DNS server)
http://pi.hole/(when using Pi-hole as your DNS server)
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:
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
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.