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 CHAOS TXT api.ftl records #1793

Merged
merged 2 commits into from
Nov 30, 2023
Merged

Add CHAOS TXT api.ftl records #1793

merged 2 commits into from
Nov 30, 2023

Conversation

DL6ER
Copy link
Member

@DL6ER DL6ER commented Nov 30, 2023

What does this implement/fix?

Add CHAOS TXT records to dynamically get the available API ports:

  • domain.api.ftl will use the configured web domain, e.g. "https://pi.hole:443/api"
  • local.api.ftl will use the hard-coded string localhost instead of the domain, e.g., "https://localhost:443/api"
  • api.ftl is an alias/shortcut for domain.api.ftl

Redirected ports and duplicates (e.g. defined for IPv4 and IPv6) are skipped. We include the port also when standard ports are used (i.e., 80 for http and 443 for https) as this simplifies the code. There is also nothing bad about being explicit.

There is no round-robin implemented here - this record will always return the ports in their order of being defined in webserver.port

Example:

$ sudo pihole-FTL --config webserver.port "80,81r,[::]:80r,443s,[::]:443s,445s"
80,81r,[::]:80r,443s,[::]:443s,445s
$ dig CHAOS TXT local.api.ftl +short
"http://localhost:80/api/" "https://localhost:443/api/" "https://localhost:445/api/"

$ dig CHAOS TXT domain.api.ftl +short
"http://pi.hole:80/api/" "https://pi.hole:443/api/" "https://pi.hole:445/api/"

$ dig CHAOS TXT api.ftl +short
"http://pi.hole:80/api/" "https://pi.hole:443/api/" "https://pi.hole:445/api/"

Related issue or feature (if applicable): N/A

Pull request in docs with documentation (if applicable): 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.
  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)

Checklist:

  • The code change is tested and works locally.
  • I based my code and PRs against the repositories developmental branch.
  • I signed off all commits. Pi-hole enforces the DCO for all contributions
  • I signed all my commits. Pi-hole requires signatures to verify authorship
  • I have read the above and my PR is ready for review.

- domain.api.ftl will use the configured web domain, e.g. "https://pi.hole:443/api"
- local.api.ftl will use the hard-coded string "localhost" instead, e.g., "https://localhost:443/api"
- api.ftl is an alias for domain.api.ftl

Signed-off-by: DL6ER <[email protected]>
@DL6ER DL6ER requested a review from a team November 30, 2023 12:03
@DL6ER DL6ER merged commit 884213d into development-v6 Nov 30, 2023
17 checks passed
@DL6ER DL6ER deleted the new/txt_api branch November 30, 2023 20:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants