Skip to content

Add environment-level troubleshooting guide for API authentication#1337

Open
goodnessnwajichukwu wants to merge 1 commit intopi-hole:masterfrom
goodnessnwajichukwu:master
Open

Add environment-level troubleshooting guide for API authentication#1337
goodnessnwajichukwu wants to merge 1 commit intopi-hole:masterfrom
goodnessnwajichukwu:master

Conversation

@goodnessnwajichukwu
Copy link

@goodnessnwajichukwu goodnessnwajichukwu commented Feb 6, 2026

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.

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?:

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:

  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

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>
@goodnessnwajichukwu goodnessnwajichukwu requested a review from a team as a code owner February 6, 2026 16:58
@netlify
Copy link

netlify bot commented Feb 6, 2026

Deploy Preview for pihole-docs ready!

Name Link
🔨 Latest commit 5e85f3b
🔍 Latest deploy log https://app.netlify.com/projects/pihole-docs/deploys/69861d9eb0c196000898c9d3
😎 Deploy Preview https://deploy-preview-1337--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 project configuration.

### Common Causes

| Issue | Description | What to Verify |
|------|-------------|----------------|
Copy link
Member

Choose a reason for hiding this comment

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

The linter is complaining about how the table was formatted.

The | and the other characters should be separated by a space

- |------|-------------|----------------|
+ | ------ | ------------- | ---------------- | 

@PromoFaux
Copy link
Member

PromoFaux commented Feb 7, 2026

Thanks, useful info but it is not actually linked anywhere... it should probably go under the Pi-hole API section of the menu (see mkdocs.yml file).

image

docs/mkdocs.yml

Lines 132 to 135 in 99f0b2e

- 'Pi-hole API':
- 'Pi-hole API': api/index.md
- 'Authentication': api/auth.md
- 'TLS/SSL': api/tls.md

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