OpenWRT widget - API error when specifying any interfaceName

[husq-nz]

Description

OpenWRT widget works fine without any interfaceName: specified, however as soon as one is added, the status switches to API error.

v0.8.8, deployed via LCX on Proxmox 8.1

OpenWRT is deployed as x86 on an Intel N5105 based router.

homepage version

0.8.8

Installation method

Other (please describe above)

Configuration

- OpenWRT:
        href: http://x.x.x.x
        icon: openwrt.png
        widget:
          type: openwrt
          url: http://x.x.x.x
          username: xxxxxxxx
          password: xxxxxxxx
          interfaceName: eth1

Container Logs

No response

Browser Logs

No response

Troubleshooting

Have tried with the "friendly" name of the interface (wan, Wan, WAN) and the interface name (eth1). Have also tried with other interfaces. No joy.

Removing the interfaceName: line reverts to default (not-interface-specific) config, which works fine.

[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 context provided, it seems that the issue you're experiencing with the OpenWRT widget displaying an API error when the interfaceName is specified could be related to a few potential causes:

1. Incorrect Interface Name: Ensure that the interfaceName you are specifying is correct and exists on your OpenWRT device. You mentioned trying with both the friendly name and the actual interface name, but it's important to verify that the name used matches exactly with what's configured on your OpenWRT device.

2. ACL Configuration: The OpenWRT widget requires specific ACL permissions to be set up on your OpenWRT device. Make sure that the ACL named homepage.json in /usr/share/rpcd/acl.d/ includes the necessary permissions for the interface you are trying to monitor. If the interface is not included in the ACL, the widget will not be able to retrieve the information and may result in an API error.

3. YAML Syntax: Ensure that the YAML configuration is correctly formatted. YAML is sensitive to indentation and formatting, so any misalignment or incorrect syntax can cause issues.

4. Network Issues: Verify that there are no network issues preventing the Homepage instance from communicating with the OpenWRT device.

5. OpenWRT Version: Check if the OpenWRT version you are using is compatible with the widget and that there are no known issues with the specific version.

6. Homepage Version: You mentioned using Homepage version 0.8.8. Ensure that there are no bugs or issues in this version related to the interfaceName configuration by checking the Homepage repository for issues or updates.

Since you've mentioned that removing the interfaceName line reverts to a working default configuration, it's likely that the issue is with the ACL configuration or the interface name itself. Double-check the ACL permissions and the interface name for accuracy.

If the issue persists after verifying these points, consider reaching out to the Homepage community for support or checking if there are any open issues in the GitHub repository that match your problem.

This comment was generated by Glime.

[shamoon]

I have no way to check, if the above doesn’t resolve it let me know we can ask the widget author

[husq-nz]

Content of rpc.d:

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 '$p$homepage'
        list read homepage
        list write '*'

Content of homepage.json:

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

[shamoon]

Thanks

"error": {
"code": -32002,
"message": "Access denied"
}

I'd say it seems like an access issue but you mentioned that doesnt work as root too?

Again I dont have an actual device to test so Im just googling it but that looks correct: https://openwrt.org/docs/techref/ubus with maybe the possibility that you need to include the interface (call network.device status '{ "name": "eth0" }') but my guess would be if you dont include the name it just returns all of them, thats what the homepage code looks like its expecting too.

homepage/src/widgets/openwrt/proxy.js

Lines 54 to 59 in 000d06a

	const [, contentType, data] = await sendJsonRpcRequest(url, RPC_METHOD, [authToken, ...PARAMS.device]);
	if (isUnauthorized(data)) {
	return [401, contentType, data];
	}
	const response = JSON.parse(data.toString())[1];
	const networkInterface = response[interfaceName];

@DanGRT any thoughts?

[husq-nz]

Yep - tried with root and got the same result. I will post something to the OpenWRT forums today as well, as it does seem a bit odd that even the root user is unable to retrieve that information.

I also tried specifying the interface as you suggested - same result with both accounts too.

Edit: Thread in OpenWRT forum: https://forum.openwrt.org/t/ubus-call-for-network-device-returning-access-denied/189485

[husq-nz]

@chain710 @shamoon @DanGRT

OpenWRT forum has solved this one for us! I will create a PR to update the docs, but basically the changes required are:

rpc.d - remove list write '*':

config login
        option username 'homepage'
        option password '$p$homepage'
        list read homepage

homepage.json - missing comma at the end of "network.device": ["status"]

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

I have tested and confirmed this resolves the issue for me.

[DanGRT]

Really sorry for missing this @russkinz, but glad you found a solution and thank you for updating the docs

[husq-nz]

Not a problem at all, gave me a chance to flex some muscles I'd forgotten I had and help out the project at the same time :) Thank you for this excellent widget!

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