docs.pi-hole.net Open in urlscan Pro
2a05:d014:58f:6202::64  Public Scan

Form analysis
2 forms found in the DOM

<form class="md-header__option" data-md-component="palette">
  <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette"
    id="__palette_0">
  <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path
        d="M12 2a7 7 0 0 1 7 7c0 2.38-1.19 4.47-3 5.74V17a1 1 0 0 1-1 1H9a1 1 0 0 1-1-1v-2.26C6.19 13.47 5 11.38 5 9a7 7 0 0 1 7-7M9 21v-1h6v1a1 1 0 0 1-1 1h-4a1 1 0 0 1-1-1m3-17a5 5 0 0 0-5 5c0 2.05 1.23 3.81 3 4.58V16h4v-2.42c1.77-.77 3-2.53 3-4.58a5 5 0 0 0-5-5Z">
      </path>
    </svg>
  </label>
  <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
  <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden="">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path d="M12 2a7 7 0 0 0-7 7c0 2.38 1.19 4.47 3 5.74V17a1 1 0 0 0 1 1h6a1 1 0 0 0 1-1v-2.26c1.81-1.27 3-3.36 3-5.74a7 7 0 0 0-7-7M9 21a1 1 0 0 0 1 1h4a1 1 0 0 0 1-1v-1H9v1Z"></path>
    </svg>
  </label>
</form>

Name: search —

<form class="md-search__form" name="search">
  <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required="">
  <label class="md-search__icon md-icon" for="__search">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"></path>
    </svg>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"></path>
    </svg>
  </label>
  <nav class="md-search__options" aria-label="Search">
    <a href="https://docs.pi-hole.net/?q=" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard="" data-clipboard-text="javascript:void(0)" data-md-component="search-share" tabindex="-1">

            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7 0-.24-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91 1.61 0 2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08Z"></path></svg>
          </a>
    <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
        <path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"></path>
      </svg>
    </button>
  </nav>
  <div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>

Text Content

Skip to content

Pi-hole documentation
Overview of Pi-hole

Type to start searching
GitHub
 * v5.18.2
 * 46.8k
 * 2.6k

Pi-hole documentation
GitHub
 * v5.18.2
 * 46.8k
 * 2.6k

 * Overview Overview
   Table of contents
    * Pi-hole is free, but powered by your support
       * Donations
       * Alternative support
       * Contributing via GitHub

 * About Pi-hole
   About Pi-hole
    * Contact Us
    * Pi-hole Origins
    * On the Web

 * Getting Started
   Getting Started
    * Prerequisites
    * Installation
    * Post-Install
    * Updating
    * Uninstalling

 * Pi-hole Core
   Pi-hole Core
    * The  pihole  command

 * Databases
   Databases
    * Overview
    * Query database
    * Domain database
      Domain database
       * Overview
       * Group management
       * Database recovery

 * FTLDNS
   FTLDNS
    * Overview
    * Configuration
    * Interfaces
    * DNS resolver
    * DNS cache
    * Blocking mode
    * Privacy levels
    * dnsmasq warnings
    * Advanced
      Advanced
       * Install from source
       * Telnet API
       * Signals
       * Cache dump
       * Packet dump
       * Debugging
         Debugging
          * gdb
          * valgrind
      
       * In-depth manual

 * Group management
   Group management
    * Overview
    * Examples

 * RegEx blocking
   RegEx blocking
    * Overview
    * Testing
    * Tutorial
    * Pi-hole extensions
    * Approximate matching

 * Docker
   Docker
    * DHCP

 * Contributing
   Contributing
    * Contributing on GitHub
    * Developer Certificate of Origin (DCO)
    * How to sign-off commits
    * How to fork and rebase

 * Guides
   Guides
    * DNS
      DNS
       * unbound
       * cloudflared (DoH)
       * Upstream DNS Providers
   
    * VPN
      VPN
       * WireGuard
         WireGuard
          * Overview
          * Concept
          * Install server
          * Add client(s)
          * Optional extra features
            Optional extra features
             * Make local devices accessible
             * Tunnel all Internet traffic
         
          * Troubleshooting
      
       * OpenVPN
         OpenVPN
          * Overview
          * Installation
          * Setup OpenVPN Server
          * Firewall Configuration
          * Connecting clients
            Connecting clients
             * General
             * Android
         
          * Optional: Only route DNS via VPN
          * Optional: Dual operation: LAN & VPN at the same time
          * Optional: Full and DNS-only
          * Optional: Dynamic DNS
          * Troubleshooting
   
    * Misc
      Misc
       * Benchmarking
       * Tor & Pi-hole
         Tor & Pi-hole
          * Overview
          * Basic Setup
          * Using Tor
          * Performance and other issues
          * Using DNSSEC
      
       * Whitelist and Blacklist editing
   
    * Web server
      Web server
       * NGINX
       * Caddy
       * Traefik v1 (not in Docker)
       * Traefik v2 (with Docker)

 * Router setup
   Router setup
    * ASUS router
    * Fritz!Box (EN)
    * Fritz!Box (DE)
    * Nokia G-240W-B
    * TP-Link
    * Ubiquiti USG

 * FAQ
 * Community Projects

Table of contents
 * Pi-hole is free, but powered by your support
    * Donations
    * Alternative support
    * Contributing via GitHub


OVERVIEW


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

--------------------------------------------------------------------------------


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:

 * Donate via PayPal or Stripe
 * Bitcoin, Bitcoin Cash, Ethereum, Litecoin


ALTERNATIVE SUPPORT¶

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

 * Patreon Become a patron for rewards
 * Digital Ocean new account credits with our affiliate link
 * Stickermule earn a $10 credit after your first purchase
 * Amazon affiliate link
 * Spreading the word about our software, and how you have benefited from it


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.

December 3, 2022
Back to top
Copyright Pi-hole. Licensed under CC BY-SA 4.0
This site is powered by Netlify