pi-hole/docs

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.

Documentation & User Guides

This repo is the source for the official Pi-hole documentation.

How to contribute

To add a new link on the navigation panel you need to edit the mkdocs.yml file in the root of the repo. There is a guide for building the navbar on the mkdocs wiki

To add a new document or guide.

• Navigate to the directory where it will be hosted. E.g. guides are in docs/guides
• Create the file using a URL friendly filename. E.g. docs/guides/url-friendly.md
• Edit your document using Markdown, there are loads of resources available for the correct syntax.

Testing your changes

When working on this repo, it is advised that you review your changes locally before committing them. The mkdocs serve command can be used to live preview your changes (as you type) on your local machine.

Please make sure you fork the repo and change the clone URL in the example below for your fork:

• Linux Mint / Ubuntu 20.04 LTS / 23.10 and later:

  • Preparations (only required once):

  git clone https://github.com/YOUR-USERNAME/docs
  cd docs
  sudo apt install python3-pip python3-venv
  python3 -m venv .venv
  source .venv/bin/activate
  pip3 install -r requirements.txt
  

  • Enter the virtual environment (if exited):

  source .venv/bin/activate
  

  • Running the docs server:

  mkdocs serve --dev-addr 0.0.0.0:8000
  

• Fedora Linux instructions (tested on Fedora Linux 28):

  • Preparations (only required once):

  git clone https://github.com/YOUR-USERNAME/docs
  cd docs
  pip install --user -r requirements.txt
  

  • Running the docs server:

  mkdocs serve --dev-addr 0.0.0.0:8000
  

• Docker instructions:

  • One-shot run:

  docker run -v `pwd`:/opt/app/ -w /opt/app/ -p 8000:8000 -it nikolaik/python-nodejs:python3.7-nodejs16 \
    sh -c "pip install --user -r requirements.txt && \
    /root/.local/bin/mkdocs build && \
    npm ci && \
    npm test && \
    /root/.local/bin/mkdocs serve --dev-addr 0.0.0.0:8000"
  

After these commands, the current branch is accessible through your favorite browser at http://localhost:8000