Extension image labels
Extensions use image labels to provide additional information such as title, description, screenshots, and more.
This information is then displayed as an overview of the extension, so users can choose to install it
You can define
Image labels in the extension's
Here is the list of labels you need to specify when building your extension:
|Yes||Human-readable title of the image (string). This appears in the UI for Docker Desktop.||my-extension|
|Yes||Human-readable description of the software packaged in the image (string)||This extension is cool.|
|Yes||Name of the distributing entity, organization, or individual.||Acme, Inc.|
|Yes||Version of the Docker Extension manager that the extension is compatible with. It must follow semantic versioningopen_in_new.||A specific version like |
|Yes||The extension icon (format: .svg .png .jpg)||https://docs.docker.com/assets/images/engine.svgopen_in_new|
|Yes||A JSON array of image URLs and an alternative text displayed to users (in the order they appear in your metadata) in your extension's details page. Note: The recommended size for screenshots is 2400x1600 pixels.|
|Yes||Additional information in plain text or HTML about the extension to display in the details dialog.|
|Yes||The publisher website URL to display in the details dialog.|
|Yes||Changelog in plain text or HTML containing the change for the current version only.|
|No||Whether the user needs to register to a SaaS platform to use some features of the extension.|
|No||The list of Marketplace categories that your extension belongs to: ||Specified as comma separated values in case of having multiple categories e.g: |
Missing required labels
If any of the previous required labels are missing in the
Dockerfile, Docker Desktop considers the extension invalid and doesn't list it in the Marketplace.
HTML content styling
You can validate that the image labels render as you expect.
When you build and install your unpublished extension, you can preview the extension in the Marketplace Managed tab. You can see how the extension labels render in the list and in the details page of the extension.
Preview extensions already listed in Marketplace
When you install a local image of an extension already published in the Marketplace, for example with the tag
latest, your local image is currently not detected as "unpublished".
You can re-tag your image in order to have a different image name that's not listed as a published extension. Use
docker tag org/published-extension unpublished-extensionand then
docker extension install unpublished-extension.