OpenWRT widget API error

[david-christ]

Description

I followed the homepage instructions on setting up OpenWRT, but I am seeing an API error, details in the fields below.

I tried the following:

• Using the homepage and root user
• With and without interfaceName, using wan and lan
• https and http (router allows both, no redirect to HTTPS)

I found this thread, but it doesn't seem to be the same issue.

homepage version

v0.8.13 (986a181, May 6, 2024)

Installation method

Docker

Configuration

- Services:
    - MyRouter:
        icon: si-openwrt-#00B5E2
        href: http://192.168.1.1
        description: My Router
        siteMonitor: http://192.168.1.1
        widget:
            type: openwrt
            url: http://192.168.1.1
            username: homepage
            password: "XXX"
            # interfaceName: lan

### Container Logs

In the docker logs I can only find

error: undefined

### Browser Logs

UI widget shows

API Error: JSON.parse: unexpected character at line 1 column 1 of the JSON data

Network traffic shows

GET /api/services/proxy?type=openwrt&group=Services&service=Abijah&endpoint=undefined

500
Internal Server Error

### Troubleshooting

I went through the tests, except I don't know the exact URL to `curl` 

[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 and the context from the sources, it seems like there might be a configuration issue with the OpenWRT widget setup in your services.yaml file. Here are a few steps you can take to troubleshoot the issue:

1. Ensure Correct URL: Make sure that the url in your services.yaml file points to the correct IP address of your OpenWRT router. In your configuration, you have http://192.168.42.1, but your router's link is http://192.168.1.1. These should match unless your OpenWRT router is on a different subnet or has been configured with a different IP address.

2. Remove Trailing Slashes: As per the documentation, ensure that the URL does not end with a trailing slash or any other API path. Each widget will handle the path on its own.

3. Check OpenWRT ACL and User: Verify that you have correctly set up the ACL and user in OpenWRT as per the instructions in the documentation. This includes creating a homepage.json file in /usr/share/rpcd/acl.d/ and adding a user with a hashed password in /etc/config/rpcd.

4. Use curl to Test API: To find the exact URL to use with curl, you can refer to the OpenWRT documentation or the source code of the widget. However, based on the standard OpenWRT Ubus RPC, a common endpoint to test might be something like http://192.168.1.1/ubus, but this can vary depending on your OpenWRT configuration.

5. Check Docker Networking: Ensure that the Docker container where homepage is running can communicate with the OpenWRT router. You can test this by executing a ping from within the container to the router's IP address.

6. Review Browser and Container Logs: The error message API Error: JSON.parse: unexpected character at line 1 column 1 of the JSON data suggests that the endpoint might be returning something other than JSON data. Check the network response in the browser's developer tools to see what the actual response from the server is.

7. Check for Typos: Double-check your services.yaml for any typos, especially in the username, password, and url fields.

If after these steps the issue persists, you may want to reach out for support using the 'Ask AI' button on the documentation pages, open a GitHub discussion, or check out the #ai-support channel on Discord for more personalized assistance.

This comment was generated by Glime.

[david-christ]

1. That was a mere typo, they are actually consistent in my file 👍
2. There are no trailing slashes 👍
3. I did follow the plugin instructions to set up the router 👍
4. I do get a 404 for /ubus, where can I find the correct URLs? ❓
5. ping is working 👍
6. If the browser gets a 404, might there be a wrong path in the OpenWRT plugin? The 404 response has an empty HTML body, which would parse wrongly of course. ❓
7. Double-checked 👍

[LiranV]

Same issue here
Running OpenWrt 23.05.0 and Homepage 0.8.13

[ZoftTy]

Try installing uhttpd-mod-ubus

opkg update
opkg install uhttpd-mod-ubus

Access to ubus over HTTP

[LiranV]

I've "solved" this by using https:// because by default OpenWRT will do a redirect from HTTP to HTTPS, but the widget doesn't follow that.

After that I've encountered another issue but I've already created a PR for that #3576

[quartzar]

I just went to make a new discussion thread but then realised this one is still open. I'm experiencing exactly the same issue. Using https:// and installing uhttpd-mod-ubus has not fixed the problem for me.

The docs say to set up an ACL for the homepage user, and then set up a new user. I have done both of these steps, opting for a crypt(5) password. I am using the actual password in the service widget password configuration, for avoidance of doubt.

However, I cannot seem to get it to work. All I see in homepage is the error:

API Error: JSON.parse: unexpected character at line 1 column 1 of the JSON data

The docker logs show nothing useful, unfortunately. I've verified that the homepage user can actually login by creating a user session for them on the router. See below:

root@GL-AX1800:~# ubus call session login '{"username": "homepage", "password": "*******"}'
{
        "ubus_rpc_session": "1bf7b7333bc8750a34f84226e7c65d22",
        "timeout": 300,
        "expires": 299,
        "acls": {
                "access-group": {
                        "homepage": [
                                "read"
                        ]
                },
                "ubus": {
                        "network.device": [
                                "status"
                        ],
                        "network.interface.lan": [
                                "status"
                        ],
                        "network.interface.wan": [
                                "status"
                        ],
                        "system": [
                                "info"
                        ]
                }
        },
        "data": {
                "username": "homepage"
        }
}

I had noticed on a previous bug report that had the same error I am getting that installing uhttpd-mod-ubus helped fix the problem, but I've done that too. I've also ensured I've reloaded the rpcd config with /etc/init.d/rpcd reload.

Any help would be greatly appreciated. I've opened this as a discussion rather than a bug report incase there is something I've missed.

Below I am attaching all relevant configuration files I can think of:

On my OpenWRT Router:

/usr/share/rpcd/acl.d/homepage.json:

{
        "homepage": {
                "description": "Homepage widget",
                "read": {
                        "ubus": {
                                "network.interface.wan": ["status"],
                                "network.interface.lan": ["status"],
                                "network.device": ["status"],
                                "system": ["info"]
                        }
                }
        }
}

/etc/config/rpcd:

config rpcd
        option socket /var/run/ubus/ubus.sock
        option timeout 30
config login
        option username 'root'
        option password '$p$root'
        list read '*'
        list write '*'
config login
        option username 'homepage'
        option password '$1$<redacted>'
        list read homepage

In the LXC I am running homepage from:

services.yaml:

- Networking:
  - Router:
      icon: si-wikiquote
      href: http://192.168.0.1/
      ping: 192.168.0.1
      widget:
        type: openwrt
        url: https://192.168.0.1 # I have tried http and https here, neither work
        username: homepage
        password: *******

[quartzar]

I have an idea of what the problem is after trying some queries...

I have a GL-iNet AX1800 router. It has Nginx preinstalled, but no ubus location configured.
Does anyone have a suggestion of how exactly to configure Nginx to allow me to query ubus?

For reference, here is a query I used for the API:

❯ curl -k -X POST -H "Content-Type: application/json" -d '{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "call",
  "params": [
    "00000000000000000000000000000000",
    "session",
    "login",
    {
      "username": "homepage",
      "password": "<redacted>"
    }
  ]
}' http://192.168.0.1/ubus
{"jsonrpc":"2.0","id":null,"error":{"code":-32603,"message":"Internal error"}}% 

[4r1-60ld]

Also struggeling with this like @quartzar.
Any help would be greatly appriciated.

OpenWrt 23.05.3, r23809-234f1a2efa and Homepage v0.9.13 (a06964d, Nov 24, 2024)

Thank you.

[FFricke]

Same here with Homepage v0.9.13 and OpenWrt 23.05.5 on a GL-MT6000

[github-actions[bot]]

This discussion has been automatically closed due to inactivity. See our contributing guidelines for more details.

[quartzar]

This is still an issue and should not be closed.

[shamoon]

Everything above would suggest the issue is a setup one, not a homepage one. Given the lack of involvement in the year this has been open, I think suffice to say it’s not a widespread issue. Perhaps asking in an openwrt forum would be more helpful

[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.