Add environment-level troubleshooting guide for API authentication#1337
Open
goodnessnwajichukwu wants to merge 1 commit intopi-hole:masterfrom
Open
Add environment-level troubleshooting guide for API authentication#1337goodnessnwajichukwu wants to merge 1 commit intopi-hole:masterfrom
goodnessnwajichukwu wants to merge 1 commit intopi-hole:masterfrom
Conversation
This guide helps developers troubleshoot API authentication issues that are not caused by Pi-hole itself but by environment-level factors. It covers common causes such as: - Port conflicts - Reverse proxy interference - Local DNS overrides - Container networking issues - Firewall blocking The goal is to reduce unnecessary debugging, improve developer experience, and prevent support tickets caused by setup issues rather than the Pi-hole API. Signed-off-by: Goodness Nwajichukwu <goodnessnwajichukwu@gmail.com>
✅ Deploy Preview for pihole-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
PromoFaux
reviewed
Feb 7, 2026
| ### Common Causes | ||
|
|
||
| | Issue | Description | What to Verify | | ||
| |------|-------------|----------------| |
Member
There was a problem hiding this comment.
The linter is complaining about how the table was formatted.
The | and the other characters should be separated by a space
- |------|-------------|----------------|
+ | ------ | ------------- | ---------------- |
Member
|
Thanks, useful info but it is not actually linked anywhere... it should probably go under the Pi-hole API section of the menu (see
Lines 132 to 135 in 99f0b2e |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

This guide helps developers troubleshoot API authentication issues that are not caused by Pi-hole itself but by environment-level factors. It covers common causes such as:
The goal is to reduce unnecessary debugging, improve developer experience, and prevent support tickets caused by setup issues rather than the Pi-hole API.
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
What does this PR aim to accomplish?:
How does this PR accomplish the above?:
Link documentation PRs if any are needed to support this PR:
By submitting this pull request, I confirm the following:
git rebase)