From 5d168b0068dd741c06b7050e5f6b2c426fc92fb6 Mon Sep 17 00:00:00 2001 From: Karl Hudgell Date: Mon, 14 Apr 2025 20:28:10 +0100 Subject: [PATCH] update the docs --- docs/widgets/services/portainer.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/widgets/services/portainer.md b/docs/widgets/services/portainer.md index f18d4eec..1b855d90 100644 --- a/docs/widgets/services/portainer.md +++ b/docs/widgets/services/portainer.md @@ -5,7 +5,10 @@ description: Portainer Widget Configuration Learn more about [Portainer](https://github.com/portainer/portainer). -You'll need to make sure you have the correct environment set for the integration to work properly. 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. In order to generate an API key, please follow the steps outlined here https://docs.portainer.io/api/access. +If you do not include the `env` key, this will work out the combined values of all connected containers on all environments. + +If you want to only show a specific environment, set the value of your environment in the yaml. 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. In order to generate an API key, please follow the steps outlined here https://docs.portainer.io/api/access. + Allowed fields: `["running", "stopped", "total"]`.