pfSense Widget only works when credentials exposed

[jewstan83]

Description

I got Homepage setup in Portainer. I then went back and moved all sensitive information into env variables. Upon doing this, pfSense widget stopped working. I've found that it only works if I put the API Authentication token info directly into services.yaml. I've tried using variables for username/password and Authorization and neither works. I can only get it to work if putting the credentials directly into the yaml file.

homepage version

v0.8.13

Installation method

Docker

Configuration

- pfSense:
        href: {{HOMEPAGE_VAR_PFIP}}
        description: Firewall / Route / Public
        icon: pfsense.png
        siteMonitor: {{HOMEPAGE_VAR_PFIP}}
        widget:
            type: pfsense
            url: {{HOMEPAGE_VAR_PFIP}}
            #username: {{HOMEPAGE_VAR_PFU}}
            #password: {{HOMEPAGE_VAR_PFP}}
            headers:
                Authorization: {{HOMEPAGE_VAR_PFID HOMEPAGE_VAR_PFTH}}
            wan: vtnet0
            fields: ["load", "memory", "wanStatus"]

Container Logs

[2024-05-23T02:02:59.534Z] error: Error calling http://10.15.20.110:2802/api/v1/status/system...

[2024-05-23T02:02:59.534Z] error: [

500,

Error: connect ETIMEDOUT 10.15.20.110:2802

  at TCPConnectWrap.afterConnect [as oncomplete] (node:net:1555:16) {

errno: -110,

code: 'ETIMEDOUT',

syscall: 'connect',

address: '10.15.20.110',

port: 2802

}

]

Browser Logs

{"error":{"message":"HTTP Error","url":"http://10.15.20.110:2802/api/v1/status/system","resultData":{"type":"Buffer","data":[123,34,115,116,97,116,117,115,34,58,34,117,110,97,117,116,104,111,114,105,122,101,100,34,44,34,99,111,100,101,34,58,52,48,49,44,34,114,101,116,117,114,110,34,58,51,44,34,109,101,115,115,97,103,101,34,58,34,65,117,116,104,101,110,116,105,99,97,116,105,111,110,32,102,97,105,108,101,100,34,44,34,100,97,116,97,34,58,91,93,125,10]}}}

Troubleshooting

Enter username/password in services.yaml = works
-- remove username/password
Enter id/token in services.yaml = works
-- remove id/token
Enter username/password as env variable = no work
-- remove username/password env variable
Enter id/token as env variable = no work

Create new user with same steps and results as above.

Tried {{pfid pfth}} & {{pfid}} {{pfth}} - neither works, separate vars throws error in Homepage (invalid indentation) - single var with both included throws API error.

[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, it seems that the issue is related to the use of environment variables within the services.yaml configuration for the pfSense widget in Homepage. The error message from the browser logs indicates an "unauthorized" error, which suggests that the authentication details are not being correctly passed to the pfSense API.

To troubleshoot this issue, please ensure the following:

1. Verify that the environment variables are correctly named and prefixed with HOMEPAGE_VAR_ as per the documentation. For example, if you are using PFID and PFTH as your environment variable names, they should be named HOMEPAGE_VAR_PFID and HOMEPAGE_VAR_PFTH in your .env file.

2. Ensure that the .env file is correctly placed in the directory where the docker-compose.yml file is located and that it is correctly referenced in the docker-compose.yml file.

3. Check that the environment variables are correctly formatted in the services.yaml file. The correct syntax for referencing an environment variable is {{HOMEPAGE_VAR_NAME}}. If you are combining two variables into one, make sure they are concatenated correctly. For example, if you want to combine PFID and PFTH into a single Authorization header, you might need to use a syntax like {{HOMEPAGE_VAR_PFID}} {{HOMEPAGE_VAR_PFTH}} (with a space in between if that's how the token is expected to be formatted).

4. If you are using Docker Compose, you can use the docker-compose config command to check if the environment variables are being correctly substituted in the configuration.

5. Ensure that the Homepage container has been restarted after making changes to the .env file or the services.yaml file to apply the new configuration.

6. If the issue persists, you may want to check the Homepage container logs for any additional error messages that could provide more insight into the problem.

If you have followed these steps and the issue is still not resolved, please provide the exact error message you are seeing, and any additional logs or configuration files that could help diagnose the problem.

This comment was generated by Glime.

[shamoon]

My guess is 5 above but its actually not entirely accurate, containers need to be re-created (with compose its down then up, or removing a container), not just restarted when you change env variables.

But in general, all of the env substitution works the same, regardless of the widget type etc

[github-actions[bot]]

This discussion has been automatically closed due to inactivity. 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.