DockerInstall

Overview

This node allows interaction with Docker environments by performing operations on Docker resources such as containers, images, volumes, and networks. Specifically, the List operation for the Image resource retrieves a list of Docker images based on optional filtering criteria.

Common scenarios where this node is useful include:

• Automating Docker image management workflows.
• Retrieving available Docker images to make decisions in CI/CD pipelines.
• Monitoring Docker images in an environment programmatically.

For example, you can use this node to list all Docker images currently available on a Docker host, optionally filtered by specific options like dangling images or labels.

Properties

Output

The output is a JSON array where each element represents a Docker image object returned by the Docker API. Each image object contains details such as image ID, repository tags, creation time, size, and other metadata as provided by Docker.

The node does not output binary data.

Example output structure (simplified):

[
  {
    "Id": "sha256:abc123...",
    "RepoTags": ["my-image:latest"],
    "Created": 1610000000,
    "Size": 123456789,
    ...
  },
  ...
]

Dependencies

• Requires access to a Docker environment via Docker API.
• Needs credentials that provide connection details and authentication to the Docker daemon (e.g., socket path, host, port, TLS settings).
• The node uses the dockerode library internally to communicate with Docker.

Troubleshooting

• No credentials got returned!
  This error occurs if the node cannot find or access the required Docker credentials. Ensure that the Docker credentials are properly configured in n8n and linked to the node.

• Invalid JSON in Options property
  Since the Options property expects a JSON object, providing invalid JSON will cause errors. Validate the JSON syntax before running the node.

• Docker connection errors
  If the node cannot connect to the Docker daemon, verify that the Docker service is running and accessible from the machine where n8n runs. Also, check that the credentials have correct connection parameters.

Links and References

• Docker Remote API - Images
• dockerode GitHub Repository