search

pi-hole / docs

The official Pi-hole documentation
https://docs.pi-hole.net/
Creative Commons Attribution Share Alike 4.0 International
196 stars 203 forks source link

Add VLAN Configuration Guide #1048

Open nilsstreedain opened 3 months ago

nilsstreedain commented 3 months ago

Thank you for your contribution to the Pi-hole Community!

Please read the comments below to help us consider your Pull Request.

We are all volunteers and completing the process outlined will help us review your commits quicker.

Please make sure you

  1. Base your code and PRs against the repositories developmental branch.
  2. Sign Off all commits as we enforce the DCO for all contributions
  3. Sign all your commits as they must have verified signatures
  4. File a pull request for any change that requires changes to our documentation at our documentation repo

What does this PR aim to accomplish?: This PR aims to lay out configuration steps for setting up VLANs for Pi-hole. Targeting users with more advanced networking configurations, this guide goes over adding additional network interfaces to the raspberry pi and then enabling those interfaces in Pi-hole.

Though VLAN configurations are supported by Pi-hole (adding VLANs adds additional network interfaces which Pi-hole can see), they are not documented anywhere. These configurations allow a single Pi-hole instance to serve multiple networks routed on the same interface, rather than maintaining a dedicated device for each individual network.

Related Issue: #1040

How does this PR accomplish the above?: The documentation guides through the process configuring Pi-hole to work with VLANs on Debian-based systems, specifically Raspberry Pis, but any Debian machine should be compatible. It includes step-by-step instructions, configuration file examples, and necessary commands. The guide will help users set up network interfaces, configure VLANs, and adjust Pi-hole settings for operation across multiple VLANs.

Link documentation PRs if any are needed to support this PR: N/A

By submitting this pull request, I confirm the following:

  1. I have read and understood the contributors guide, as well as this entire template. I understand which branch to base my commits and Pull Requests against.
  2. I have commented my proposed changes within the code and I have tested my changes.
  3. I am willing to help maintain this change if there are issues with it later.
  4. It is compatible with the EUPL 1.2 license
  5. I have squashed any insignificant commits. (git rebase)
  6. I have checked that another pull request for this purpose does not exist.
  7. I have considered, and confirmed that this submission will be valuable to others.
  8. I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
  9. I give this submission freely, and claim no ownership to its content.
netlify[bot] commented 3 months ago

Deploy Preview for pihole-docs ready!

Name Link
Latest commit a20bf03a28de00eb0e9a7813118ef0b1849001ac
Latest deploy log https://app.netlify.com/sites/pihole-docs/deploys/666801945e2a840008ce9e59
Deploy Preview https://deploy-preview-1048--pihole-docs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

yubiuser commented 2 months ago

Ok, this is good to go. Please rebase on latest master (branch is out-of-date) and squash all the commits down