Skip to content

Allow specification of the exact API URL via new option --api #463

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

Open
wants to merge 6 commits into
base: development
Choose a base branch
from

Conversation

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

Allows SERVER to be the full API path, eliminating the need for the extra DNS lookup.
This also allows multiple APIs on the same server (like https://pi.hole/pihole1/api and https://pi.hole/pihole2/api).
PADD will still work even if the DNS record doesn't work.

This fixes my original problem I specified on discourse

How does this PR accomplish the above?:

Check if SERVER starts with https:// or http:// and sets chaos_api_list to SERVER.

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

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.

I'm thinking we probably should add a new option/flag like --api where users can specify the api URL. I'm not sure mixing the URL with the server domain/IP is desirable. And we should make it clear that this is an advanced feature most users probably never need.

@darkexplosiveqwx
Copy link
Author

This is a good Idea and will also avoid potential issues with the functionality I introduced in #450, since it assumes SERVER is an IP.

@darkexplosiveqwx darkexplosiveqwx changed the title Allow specification of the exact API URL via SERVER Allow specification of the exact API URL via new option --api Apr 28, 2025
@yubiuser yubiuser force-pushed the server-full-path branch from 1769658 to 13d5dea Compare May 11, 2025 08:44
@yubiuser yubiuser requested a review from a team as a code owner May 11, 2025 08:44
Signed-off-by: darkexplosiveqwx <[email protected]>
@darkexplosiveqwx darkexplosiveqwx requested a review from yubiuser May 11, 2025 13:33
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