Portainer API Error

[sleeplessKomodo]

Hello! Homepage has been amazing to use so far, but I've run into this small issue with an API error for the portainer widget. The error is,

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

I am using docker on a local machine on my home network.

and my services.yaml is as follows,

- Server Management:
    - Portainer:
        icon: https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/portainer.png
        href: https://192.xxx.x.xx:9443
        description: Making Docker and Kubernetes management easy.
        server: docker
        container: portainer
        widget:
          type: portainer
          url: http://192.xxx.x.xx:9443
          key: ptr_*******************************************=

I am new to servers, containerization and networking in general, so I'm not sure if this is a configuration error, or something else. Any hints in the right direction are welcomed!

[Nonoss117]

Hello,

May be env value is missing in your widget parameters.

You can check the wiki, here: https://gethomepage.dev/v0.7.3/widgets/services/portainer/

[sleeplessKomodo]

See, this is what confused me, because my environment URL is /var/run/docker.sock, not a number. I tried entering either a value of 1 or 2 just to check, and the error persists.

[shamoon]

From the docs he referenced above:

From the Environments section inside of Portainer, click the one you'd like to connect to and observe the ID at the end of the URL (should be), something like #!/endpoints/1, here 1 is the value to set as the env value.

[shamoon]

And if not working, see https://gethomepage.dev/v0.7.3/more/troubleshooting/#service-widget-errors there's in fact an example for portainer

[Nonoss117]

Verify also the url in the widget config. I think it should begin with https, and not http

[sleeplessKomodo]

[sleeplessKomodo]

And if not working, see https://gethomepage.dev/v0.7.3/more/troubleshooting/#service-widget-errors there's in fact an example for portainer

so I've verified that the homepage installation can connect to the IP address with

docker exec homepage ping 192.xxx.x.xx:9443, which pings successfully. so it seems homepage can talk to portainer.

[shamoon]

env is just the number in the url of your browser when using portainer

great that ping works, there’s a second half to the troubleshooting guide you should go through

[sleeplessKomodo]

Wow I feel dumb. Didn't realize it was the url of the browser, and not the url of the environment in portainer. So my url is https://192.xxx.x.xx:9443/#!/endpoints/2, so I changed the 'env' variable in services.yaml to '2'. The API error remains the same, so I'm a little lost.

I'll take a look at that guide.

[sleeplessKomodo]

That curl command spits out a bunch of stuff in a very unfriendly format, so I'm not sure what to make of it, or what I'm looking for.

`
$ curl -L -k -H 'X-Api-Key:ptr_*******************************************=' 'https://192.xxx.x.xx:9443/api/endpoints/2/docker/containers/json'

[{"Command":"docker-entrypoint.sh postgres","Created":1697130417,"HostConfig":{"NetworkMode":"planka_default"},"Id":"dca2a570498b8b991953a543c760e1cbdafad8f17cb07bcdb6ee4abd365dfc25","Image":"postgres:14-alpine","ImageID":"sha256:27ff2001e9ced4659202d57b9cea834ae83d26be6ed40e974c80ee4204a61cf2","Labels":{"com.docker.compose.config-hash":"c76453ca28170cb5b3bfc3556cf1eb0a3460df6160bd528a2118c0209874edfc","com.docker.compose.container-number":"1","com.docker.compose.depends_on":"","com.docker.compose.image":"sha256:27ff2001e9ced4659202d57b9cea834ae83d26be6ed40e974c80ee4204a61cf2","com.docker.compose.oneoff":"False","com.docker.compose.project":"planka","com.docker.compose.project.config_files":"/data/compose/12/v1/docker-compose.yml","com.docker.compose.project.working_dir":"/data/compose/12/v1","com.docker.compose.service":"postgres","com.docker.compose.version":"2.20.2"},"Mounts":[{"Destination":"/var/lib/postgresql/data","Driver":"local","Mode":"z","Name":"planka_db-data","Propagation":"","RW":true,"Source":"/var/lib/docker/volumes/planka_db-data/_data","Type":"volume"}],"Names":["/planka-postgres-1"],"NetworkSettings":{"Networks":{"planka_default":{"Aliases":null,"DriverOpts":null,"EndpointID":"b03104902aaee5b561c9556491678795582bda188bf7d6bf80c93a7ab2c00716","Gateway":"172.27.0.1","GlobalIPv6Address":"","GlobalIPv6PrefixLen":0,"IPAMConfig":null,"IPAddress":"172.27.0.2","IPPrefixLen":16,"IPv6Gateway":"","Links":null,"MacAddress":"02:42:ac:1b:00:02","NetworkID":"439cd1deeea53f6e6ef5f2a157fdd4f9256a1b5b3e309d01f283dc4bb1fdd1be"}}},"Portainer":{"ResourceControl":{"Id":14,"ResourceId":"2_planka","SubResourceIds":[],"Type":6,"UserAccesses":[],"TeamAccesses":[],"Public":false,"AdministratorsOnly":true,"System":false}},"Ports":[{"PrivatePort":5432,"Type":"tcp"}],"State":"running","Status":"Up About an hour"},{"Command":"docker-entrypoint.sh postgres","Created":1697130259,"HostConfig":{"NetworkMode":"bridge"},"Id":"c5c9fa179eec666aedcdd0731948aba87623a116fd9e0b6edfb3d8f9c7b5a631","Image":"postgres:latest","ImageID":"sha256:f7d9a0d4223bcd1329bcd9d09d68d84acced94479e1c1e81d4b3a361f92e8003","Labels":{},"Mounts":[{"Destination":"/var/lib/postgresql/data","Driver":"local","Mode":"z","Name":"fc614fa4ee9132fea5c51b7615450342a6be53cc00f777dc7cfe5970571be967","Propagation":"","RW":true,"Source":"/var/lib/docker/volumes/fc614fa4ee9132fea5c51b7615450342a6be53cc00f777dc7cfe5970571be967/_data","Type":"volume"}],"Names":["/postgresSQL"],"NetworkSettings":{"Networks":{"bridge":{"Aliases":null,"DriverOpts":null,"EndpointID":"","Gateway":"","GlobalIPv6Address":"","GlobalIPv6PrefixLen":0,"IPAMConfig":null,"IPAddress":"","IPPrefixLen":0,"IPv6Gateway":"","Links":null,"MacAddress":"","NetworkID":"9c2cf189859dcb3343232f724b0594097be792feb1262449a46c0f83cca890cd"}}},"Portainer":{"ResourceControl":{"Id":18,"ResourceId":"c5c9fa179eec666aedcdd0731948aba87623a116fd9e0b6edfb3d8f9c7b5a631","SubResourceIds":[],"Type":1,"UserAccesses":[],"TeamAccesses":[],"Public":false,"AdministratorsOnly":true,"System":false}},"Ports":[],"State":"restarting","Status":"Restarting (1) 47 seconds ago"},{"Command":"docker-entrypoint.sh node server.js","Created":1696617590,"HostConfig":{"NetworkMode":"homepage_default"},"Id":"8dc7e4f573e328dc43831added4f34ed3c3188d1d43b29243eb1e86ba9398968","Image":"ghcr.io/gethomepage/homepage:latest","ImageID":"sha256:08fdb9f99125c9390efc9a033c282085d1586f44740b12319ad90e91b9be6078","Labels":{"com.docker.compose.config-hash":"82fbbc9099d9df18a305d7b4b67115e3a6590e5b0e77d56a6dd49456725c876f","com.docker.compose.container-number":"1","com.docker.compose.oneoff":"False","com.docker.compose.project":"homepage","com.docker.compose.project.config_files":"docker-compose.yml","com.docker.compose.project.working_dir":"/home/kurt/docker-images/homepage","com.docker.compose.service":"homepage","com.docker.compose.version":"1.29.2","org.opencontainers.image.created":"2023-09-20T03:31:34.436Z","org.opencontainers.image.description":"A highly customizable homepage (or startpage / application dashboard) with Docker and service API integrations.","org.opencontainers.image.documentation":"https://github.com/benphelps/homepage/wiki","org.opencontainers.image.licenses":"GPL-3.0","org.opencontainers.image.revision":"d4a39299c56e945acd1eece9483380b93eefbcc1","org.opencontainers.image.source":"https://github.com/benphelps/homepage","org.opencontainers.image.title":"homepage","org.opencontainers.image.url":"https://github.com/benphelps/homepage","org.opencontainers.image.version":"v0.6.35"},"Mounts":[{"Destination":"/app/config","Mode":"","Propagation":"rprivate","RW":true,"Source":"/home/kurt/docker-images/homepage/config","Type":"bind"},{"Destination":"/var/run/docker.sock","Mode":"","Propagation":"rprivate","RW":true,"Source":"/var/run/docker.sock","Type":"bind"}],"Names":["/homepage"],"NetworkSettings":{"Networks":{"homepage_default":{"Aliases":null,"DriverOpts":null,"EndpointID":"f733b634369fb30d57cc5e3076a5e78386624b057810a22753a33f2b10dbd3d9","Gateway":"172.20.0.1","GlobalIPv6Address":"","GlobalIPv6PrefixLen":0,"IPAMConfig":{},"IPAddress":"172.20.0.2","IPPrefixLen":16,"IPv6Gateway":"","Links":null,"MacAddress":"02:42:ac:14:00:02","NetworkID":"43270c9130c2fc606be1350b10db9ac8627bb91cc0db8cd1a1db51b135fc0f62"}}},"Portainer":{"ResourceControl":{"Id":16,"ResourceId":"8dc7e4f573e328dc43831added4f34ed3c3188d1d43b29243eb1e86ba9398968","SubResourceIds":[],"Type":1,"UserAccesses":[],"TeamAccesses":[],"Public":false,"AdministratorsOnly":true,"System":false}},"Ports":[{"IP":"0.0.0.0","PrivatePort":3000,"PublicPort":3000,"Type":"tcp"},{"IP":"::","PrivatePort":3000,"PublicPort":3000,"Type":"tcp"}],"State":"running","Status":"Up About an hour (healthy)"},{"Command":"docker-entrypoint.sh bash -c 'for i in seq 1 30; do\n ./start.sh \u0026\u0026\n s=$? \u0026\u0026 break || s=$?;\n echo "Tried $i times. Waiting 5 seconds...";\n sleep 5;\n done; (exit $s)'","Created":1696605243,"HostConfig":{"NetworkMode":"planka_default"},"Id":"a044277c01e068bfc995c07a2e57c5334f2819918014ff96b11597a420366809","Image":"ghcr.io/plankanban/planka:latest","ImageID":"sha256:26b21f99c822fc5b74479fc3a62fbab35c18fc70d6d8f7b12b2a65c93700689a","Labels":{"com.docker.compose.config-hash":"4725bdebe7e175c0603d3ba14a09b874afff60d1a20edc7e3ee1da97899be1a3","com.docker.compose.container-number":"1","com.docker.compose.depends_on":"postgres:service_started:false","com.docker.compose.image":"sha256:26b21f99c822fc5b74479fc3a62fbab35c18fc70d6d8f7b12b2a65c93700689a","com.docker.compose.oneoff":"False","com.docker.compose.project":"planka","com.docker.compose.project.config_files":"/data/compose/12/v1/docker-compose.yml","com.docker.compose.project.working_dir":"/data/compose/12/v1","com.docker.compose.service":"planka","com.docker.compose.version":"2.20.2"},"Mounts":[{"Destination":"/app/public/user-avatars","Driver":"local","Mode":"z","Name":"planka_user-avatars","Propagation":"","RW":true,"Source":"/var/lib/docker/volumes/planka_user-avatars/_data","Type":"volume"},{"Destination":"/app/private/attachments","Driver":"local","Mode":"z","Name":"planka_attachments","Propagation":"","RW":true,"Source":"/var/lib/docker/volumes/planka_attachments/_data","Type":"volume"},{"Destination":"/app/public/project-background-images","Driver":"local","Mode":"z","Name":"planka_project-background-images","Propagation":"","RW":true,"Source":"/var/lib/docker/volumes/planka_project-background-images/_data","Type":"volume"}],"Names":["/planka-planka-1"],"NetworkSettings":{"Networks":{"planka_default":{"Aliases":null,"DriverOpts":null,"EndpointID":"74dc4920682d51c8abf74fa3e2efc392034fe08577ce876fc952ef555182f5ce","Gateway":"172.27.0.1","GlobalIPv6Address":"","GlobalIPv6PrefixLen":0,"IPAMConfig":{},"IPAddress":"172.27.0.3","IPPrefixLen":16,"IPv6Gateway":"","Links":null,"MacAddress":"02:42:ac:1b:00:03","NetworkID":"439cd1deeea53f6e6ef5f2a157fdd4f9256a1b5b3e309d01f283dc4bb1fdd1be"}}},"Portainer":{"ResourceControl":{"Id":15,"ResourceId":"a044277c01e068bfc995c07a2e57c5334f2819918014ff96b11597a420366809","SubResourceIds":[],"Type":1,"UserAccesses":[],"TeamAccesses":[],"Public":false,"AdministratorsOnly":true,"System":false}},"Ports":[{"IP":"0.0.0.0","PrivatePort":1337,"PublicPort":3002,"Type":"tcp"},{"IP":"::","PrivatePort":1337,"PublicPort":3002,"Type":"tcp"}],"State":"running","Status":"Up About an hour"},{"Command":"/usr/bin/tini -g -- node app.js","Created":1696601107,"HostConfig":{"NetworkMode":"actual_default"},"Id":"a4619229867a5bb0b7625a16446e8701296d9b0c503b7e71a2163e55e8754ab3","Image":"actualbudget/actual-server:latest","ImageID":"sha256:e880133e396b5d3be19393836c1e21a91e216d815443c1309560604a006b3a40","Labels":{"com.docker.compose.config-hash":"53cda4a1551b717cf577d9b6a1be193ba9389dd367af990c679bfed697887bfb","com.docker.compose.container-number":"1","com.docker.compose.oneoff":"False","com.docker.compose.project":"actual","com.docker.compose.project.config_files":"docker-compose.yml","com.docker.compose.project.working_dir":"/home/kurt/docker-images/actual","com.docker.compose.service":"actual_server","com.docker.compose.version":"1.29.2"},"Mounts":[{"Destination":"/data","Mode":"rw","Propagation":"rprivate","RW":true,"Source":"/home/kurt/docker-images/actual/actual-data","Type":"bind"}],"Names":["/actual_actual_server_1"],"NetworkSettings":{"Networks":{"actual_default":{"Aliases":null,"DriverOpts":null,"EndpointID":"96fb431094b999159bc2cd4129e4b4aaa7aa9a027cd8b6a8b1845d1ae3b5897c","Gateway":"172.19.0.1","GlobalIPv6Address":"","GlobalIPv6PrefixLen":0,"IPAMConfig":null,"IPAddress":"172.19.0.2","IPPrefixLen":16,"IPv6Gateway":"","Links":null,"MacAddress":"02:42:ac:13:00:02","NetworkID":"0f850ea205bdc1831ce3abe30e3537063d61eee4a75fd599485e2293dffe1606"}}},"Ports":[{"IP":"0.0.0.0","PrivatePort":5006,"PublicPort":5006,"Type":"tcp"},{"IP":"::","PrivatePort":5006,"PublicPort":5006,"Type":"tcp"}],"State":"running","Status":"Up About an hour"},{"Command":"/app/navidrome","Created":1696541131,"HostConfig":{"NetworkMode":"navidrome_default"},"Id":"e1d769bb549032292b96ef592cec614e95e267f4ecc05ef059979640da8a904d","Image":"deluan/navidrome:latest","ImageID":"sha256:589cdcd5bc909d464e63ba9c6206266ae8479a25824f0a870c992e17b8434d5e","Labels":{"com.docker.compose.config-hash":"14bf6b12ade1486a2861df34c1032cf2b3c9bf3be0ec8d820328347cad82aaaf","com.docker.compose.container-number":"1","com.docker.compose.depends_on":"","com.docker.compose.image":"sha256:589cdcd5bc909d464e63ba9c6206266ae8479a25824f0a870c992e17b8434d5e","com.docker.compose.oneoff":"False","com.docker.compose.project":"navidrome","com.docker.compose.project.config_files":"/data/compose/8/33653de71b722322e2ade75bba32a7a6822b8b33/Template/Stack/navidrome.yml","com.docker.compose.project.environment_file":"/data/compose/8/33653de71b722322e2ade75bba32a7a6822b8b33/stack.env","com.docker.compose.project.working_dir":"/data/compose/8/33653de71b722322e2ade75bba32a7a6822b8b33/Template/Stack","com.docker.compose.service":"navidrome","com.docker.compose.version":"2.20.2","maintainer":"deluan@navidrome.org"},"Mounts":[{"Destination":"/data","Mode":"","Propagation":"rprivate","RW":true,"Source":"/portainer/Files/AppData/Config/navidrome","Type":"bind"},{"Destination":"/music","Mode":"ro","Pro . . . . .
`

[shamoon]

That curl looks good now. That was from inside the homepage container? If so, then double check the services.yaml now, https and env: 2 but that should be correct, so re-create your container and check the logs

[sleeplessKomodo]

If so, then double check the services.yaml now, https and env: 2 but that should be correct, so re-create your container and check the logs

Nice! It's working now, thanks for the help! I might have kept changing the https back to http, my bad, but as you said, setting both https in the url field and the env variable did the trick. It took the re-creation of the container to actually see the change.

[sleeplessKomodo]

Verify also the url in the widget config. I think it should begin with https, and not http

Thanks, I changed that just in case. No noticeable difference, but it was worth a shot.

[shamoon]

Awesome

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