language
update
keyboard_arrow_up
language

Description

A plugin that allows connection to a portainer.io server, which is a Docker container management solution that can itself be easily installed in a container. Using this plugin, you can retrieve all Docker instances configured on portainer.io as well as all their containers in Jeedom.

The plugin also features a health page and a dedicated dashboard that displays an overview of all containers and allows you to perform all basic actions, similar to the “Containers” page on portainer.io.

Supported Versions

Component Version
Debian Bullseye(11) & Bookworm(12)
Jeedom >= 4.2

Installation

To use the plugin, you must download, install, and activate it just like any other Jeedom plugin. You must already have a portainer.io server; the various options for setting one up are very well documented on their website.

Plugin configuration

In the plugin configuration, you’ll need to enter the Portainer URL in the format http://PORTAINER_SERVER:9000, along with a username and password.

You can also choose whether or not to enable the panel, as well as the parent object that will be used when creating Jeedom devices: if a device with the same name does not yet exist under that object, the new Portainer device will have that object as its parent; otherwise, it will be set to “None.” You can also choose between two modes for automatic synchronization:

  • either create new containers that do not yet exist in Jeedom or update existing containers
  • or simply update the existing containers

Tip

The Synchronize action available on the devices page to force a manual synchronization will always create any missing containers. The option above applies only to automatic synchronization

Equipment

Once a user has been configured, the plugin will attempt to connect to portainer.io every minute to synchronize. All devices that the plugin has access to will be automatically created in Jeedom; it is not possible to create a device manually. You can perform a manual synchronization using the button on the devices page.

There are two options for importing stdout and stderr logs into Jeedom. If the corresponding options are enabled on the device, the logs will be read each time the device synchronizes and will be accessible in the Jeedom logs interface.

Available commands

EndPoint

On EndPoint-type devices (Docker instances, Portainer agents, etc.), the following info commands are available:

  • Status is 1 or 0, depending on whether the device is powered on and reachable or not
  • Number of CPUs indicates the number of CPUs in the machine
  • Memory displays the total memory of the machine in bytes
  • Number of containers turned on and Number of containers turned off
  • Number of healthy containers and Number of unhealthy containers
  • Number of volumes
  • Number of images
  • Number of services
  • Number of stacks
  • Public URL

Container

On Container-type devices, the following info commands are available:

  • Status Possible values are: created, running, paused, restarting, removing, exited, dead
  • Health status Possible values are: none, starting, healthy, unhealthy
  • Running info/binary
  • Paused info/binary
  • Restarting info/binary
  • Dead info/binary
  • OOMKilled info/binary
  • IP address of the container
  • MAC address of the container
  • Gateway network gateway
  • Last Startup: the date of the last startup
  • Last stop: the last time the lights were turned off

and action commands:

  • Get Started
  • Stop
  • Restart
  • Pause
  • Resume
  • Kill

Change log

View the changelog

Support

If you’re having a problem, start by reading the latest threads related to the plugin on community.

If you still can’t find an answer to your question, feel free to create a new thread—and don’t forget to include the plugin tag (plugin-portainer).

At a minimum, you must provide:

  • a screenshot of the Jeedom Health page
  • a screenshot of the plugin’s settings page
  • All available plugin logs at the INFO level, pasted into a Preformatted Text (use the </> button on the community), no files!
  • Depending on the situation, a screenshot of the error encountered, a screenshot of the problematic configuration…