Pi-Hole Widget is not working: "API Error: The string did not match the expected pattern."

[d33pjs]

Description

My Pi-Hole Widget on Homepage is not working and I can't figure out why.

It's available (only) via two reverse proxies. But it doens't look like a Problem with them.

My Configuration is attached.

Also Safari returns:

in console.

Any idea what could be wrong?

PS. Your AI-Bot-Channel on https://gethomepage.dev/latest/more/troubleshooting/ doesn't seem to work anymore.

homepage version

v0.8.12 (12ec1cf, Apr 17, 2024)

Installation method

Docker

Configuration

(services)
    - PiHole Berkelium:
        widget:
          type: pihole
          url: https://name:9999/
          version: 6
          key: token_via_ansible
        href: https://anothername/admin
        icon: pi-hole.svg

---
(docker-compose.yml)
  pihole:
    container_name: pihole
    image: pihole/pihole:latest
    ports:
      - 53:53/tcp
      - 53:53/udp
      - 80:80/tcp
    environment:
      TZ: 'Europe/Berlin'
      VIRTUAL_HOST: name
      CORS_HOSTS: name, anothername
    volumes:
      - "/etc/timezone:/etc/timezone:ro"
      - "/etc/localtime:/etc/localtime:ro"      
      - /pihole/etc-pihole:/etc/pihole
      - /pihole/etc-dnsmasq.d:/etc/dnsmasq.d
    restart: unless-stopped

Container Logs

The Proxy next to Pi-Hole writes:

<ip> - - [18/Apr/2024:11:58:20 +0000] "POST /api/auth HTTP/1.1" 404 341 "-" "-" "ip"

or

<ip> - - [18/Apr/2024:12:44:57 +0000] "POST //api/auth HTTP/1.1" 404 341 "-" "-" "-"

So, yeah, it's a 404.

Homepage on the other Hand throw some (not very helpfull) errors on every access:

[2024-04-18T12:38:51.061Z] error: undefined
[2024-04-18T12:39:13.018Z] error: undefined
[2024-04-18T12:39:23.106Z] error: undefined

Browser Logs

No response

Troubleshooting

I tried "https://name:9999" (without / at the end), "https://anothername/" (lets encrypt cert), "https://anothername" (again, without / at the end) and both DNS Names like: "https://name:9999/admin". But none of them are working inside Homepage. API via curl is indeed working.

[glime-ai[bot]]

Thanks for posting a discussion about homepage here on GitHub. Homepage now uses a fancy new AI tool thanks to our friends at Glime, so the answer below is the AI bot's attempt to answer your question. If you feel it's sufficient you can mark the answer and close this post, otherwise feel free to leave it open of course!

Thanks for using Homepage! ❤️

---

Based on the information provided, there are several potential issues that could be causing the Pi-Hole widget on Homepage not to work. Here are some troubleshooting steps to consider:

1. Ensure URL Formatting: As per the troubleshooting guide, ensure that the URL in the widget configuration does not end with a slash / or other API path unless otherwise noted. Each widget handles the path on its own, and including a trailing slash can result in an error.

2. Check Network Accessibility: Verify that the Homepage installation can connect to the Pi-Hole service. Since you are using Docker, you can ping the Pi-Hole service from within the Homepage container using the following command:

   docker exec homepage ping SERVICEIPORDOMAIN
   

   If the Homepage container cannot reach the Pi-Hole service, you'll need to address the network connectivity issue.

3. CORS Configuration: The browser logs suggest there might be a CORS issue. Ensure that the CORS configuration on your Pi-Hole allows requests from the domains used by Homepage. You've mentioned setting CORS_HOSTS in your Docker configuration, so make sure that the Homepage domain is included.

4. API Key: Double-check that the API key (key: token_via_ansible) is correct and has the necessary permissions. You can test the API key using curl from your local machine or from within the Homepage container.

5. Proxy Configuration: The container logs from the proxy indicate a 404 error when trying to POST to /api/auth. This suggests that the proxy might not be routing the requests correctly to the Pi-Hole API. Review your reverse proxy configuration to ensure that it's correctly passing requests to the Pi-Hole container.

6. Homepage Logs: The Homepage logs are showing error: undefined, which is not very helpful. You can try setting the LOG_LEVEL to debug to get more detailed logs that might help identify the issue. Add the following environment variable to your Homepage service in the docker-compose.yml file:

   environment:
     - LOG_LEVEL=debug

7. AI Bot Channel: You mentioned that the AI Bot Channel on the troubleshooting page is not working. You can try reaching out for support through other channels mentioned in the documentation, such as GitHub discussions or the #ai-support channel on Discord.

If none of these steps resolve the issue, consider opening a discussion on the Homepage GitHub repository or reaching out to the community for further assistance.

This comment was generated by Glime.

[d33pjs]

• the trailling slash was just one of a few tries and didn't change anything
• network connection works (tested on multiple different hosts, also inside the homepage container)
• CORS was configured (as you can see in docker compose file), also tried a lot of more combinations here (didn't change anything)
• API key is triple checked
• proxy configuration is working on every other endpoint - /api/auth is not documented at pi-hole (only https://dns/admin/api.php?summaryRaw&auth=, see https://discourse.pi-hole.net/t/how-to-use-the-api/61004) - so I can't exactly test the homepage url.
• setting LOG_LEVEL to debug in homepage doesn't help, it still throws "error: undefined"

[shamoon]

You specified version 6, which has a completely different api structure, and also it hasn’t been officially been released yet. I assume you don’t really mean that.

[d33pjs]

Thank you. I really meant that, but removing the version option just fixed the problem as you said ;-).

[github-actions[bot]]

This discussion has been automatically closed because it was marked as answered. See our contributing guidelines for more details.

[github-actions[bot]]

This discussion has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion for related concerns. See our contributing guidelines for more details.