Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add VLAN Configuration Guide #1048

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

nilsstreedain
Copy link

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.

  • I have read the above and my PR is ready for review. Check this box to confirm

Copy link

netlify bot commented Jun 7, 2024

Deploy Preview for pihole-docs ready!

Name Link
🔨 Latest commit a20bf03
🔍 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.

@nilsstreedain nilsstreedain changed the title Config vlans Add VLAN Configuration Documentation Jun 7, 2024
@nilsstreedain nilsstreedain changed the title Add VLAN Configuration Documentation Add VLAN Configuration Guide Jun 7, 2024
Copy link
Member

@yubiuser yubiuser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution.

docs/guides/misc/vlans.md Show resolved Hide resolved
docs/guides/misc/vlans.md Outdated Show resolved Hide resolved
@yubiuser
Copy link
Member

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

@nilsstreedain nilsstreedain force-pushed the config-vlans branch 5 times, most recently from dfdd68e to 4d9aadc Compare June 11, 2024 07:49
Signed-off-by: Nils Streedain <[email protected]>

Update mkdocs.yml

Signed-off-by: Nils Streedain <[email protected]>

Fix Pi-hole branding reference

Signed-off-by: Nils Streedain <[email protected]>

Update formatting

Signed-off-by: Nils Streedain <[email protected]>

Update vlans.md

Specified the current guide only applies to installations utilizing `dhcpcd`, not newer versions using `NetworkManager`.

Signed-off-by: Nils Streedain <[email protected]>

Update docs/guides/misc/vlans.md

Co-authored-by: yubiuser <[email protected]>
Signed-off-by: Nils Streedain <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants