mirror of
https://github.com/pi-hole/docs.git
synced 2025-12-20 03:08:45 +00:00
@@ -1,4 +1,22 @@
|
||||
# Welcome to Pi-hole Documentation
|
||||
<p align="center">
|
||||
<a href="https://pi-hole.net"><img src="https://pi-hole.github.io/graphics/Vortex/Vortex_with_text.png" width="150" height="255" alt="Pi-hole"></a><br/>
|
||||
<b>Network-wide ad blocking via your own Linux hardware</b><br/>
|
||||
</p>
|
||||
|
||||
The Pi-hole is a [DNS sinkhole](https://en.wikipedia.org/wiki/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](https://www.youtube.com/watch?v=vKWjx1AQYgs)
|
||||
- **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](main/prerequesites.md)
|
||||
- **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](https://discourse.pi-hole.net/t/how-do-i-use-pi-holes-built-in-dhcp-server-and-why-would-i-want-to/3026), ensuring *all* your devices are protected automatically
|
||||
- **Scalable**: [capable of handling hundreds of millions of queries](https://pi-hole.net/2017/05/24/how-much-traffic-can-pi-hole-handle/) 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
|
||||
|
||||
-----
|
||||
|
||||
## Get Support
|
||||
|
||||
|
||||
@@ -1,21 +1,23 @@
|
||||
# One-Step Automated Install
|
||||
## One-Step Automated Install
|
||||
Those who want to get started quickly and conveniently, may install Pi-hole using the following command:
|
||||
|
||||
```BASH
|
||||
curl -sSL https://install.pi-hole.net | bash
|
||||
```
|
||||
|
||||
# Alternative Install Methods
|
||||
[Piping to `bash` is controversial](https://pi-hole.net/2016/07/25/curling-and-piping-to-bash), as it prevents you from [reading code that is about to run](https://github.com/pi-hole/pi-hole/blob/master/automated%20install/basic-install.sh) on your system. Therefore, we provide these alternative installation methods which allow code review before installation:
|
||||
!!! info
|
||||
[Piping to `bash` is a controversial topic](https://pi-hole.net/2016/07/25/curling-and-piping-to-bash), as it prevents you from [reading code that is about to run](https://github.com/pi-hole/pi-hole/blob/master/automated%20install/basic-install.sh) on your system.
|
||||
|
||||
If you would prefer to review the code before installation, we provide these alternative installation methods.
|
||||
|
||||
#### Method 1: Clone our repository and run
|
||||
#### Alternative 1: Clone our repository and run
|
||||
```BASH
|
||||
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
|
||||
#### Alternative 2: Manually download the installer and run
|
||||
```BASH
|
||||
wget -O basic-install.sh https://install.pi-hole.net
|
||||
sudo bash basic-install.sh
|
||||
|
||||
@@ -18,7 +18,7 @@ markdown_extensions:
|
||||
- pymdownx.extra
|
||||
- footnotes
|
||||
pages:
|
||||
- 'Support': 'index.md'
|
||||
- 'Overview & Support': 'index.md'
|
||||
- 'Getting Started':
|
||||
- 'Prerequisites': 'main/prerequesites.md'
|
||||
- 'Installation': 'main/basic-install.md'
|
||||
|
||||
Reference in New Issue
Block a user