扩展图像标签
扩展程序使用图像标签来提供附加信息,例如标题、描述、屏幕截图等。
然后,此信息将显示为扩展的概述,以便用户可以选择安装它。


您可以
在扩展程序的Dockerfile
.
重要的
如果中缺少任何必需的
Dockerfile
标签,Docker Desktop 会认为该扩展无效并且不会在 Marketplace 中列出它。
以下是您在构建扩展时可以或需要指定的标签列表:
标签 | 必需的 | 描述 | 例子 |
---|---|---|---|
org.opencontainers.image.title | 是的 | 人类可读的图像标题(字符串)。这出现在 Docker Desktop 的 UI 中。 | 我的扩展 |
org.opencontainers.image.description | 是的 | 图像中打包的软件的人类可读描述(字符串) | 这个扩展很酷。 |
org.opencontainers.image.vendor | 是的 | 发布单位、组织或个人的名称。 | 阿克米公司 |
com.docker.desktop.extension.api.version | 是的 | 扩展兼容的 Docker 扩展管理器的版本。它必须遵循 语义版本控制。 | 特定版本,如0.1.0 or、约束表达式:>= 0.1.0 , >= 1.4.7, < 2.0 。对于您的第一个扩展,您可以使用docker extension version 了解 SDK API 版本并指定>= <SDK_API_VERSION> . |
com.docker.desktop.extension.icon | 是的 | 扩展图标(格式:.svg .png .jpg) | https://docker.github.net.cn/assets/images/engine.svg |
com.docker.extension.screenshots | 是的 | 在扩展程序详细信息页面中向用户显示的图像 URL 和替代文本的 JSON 数组(按照它们在元数据中出现的顺序)。注意:建议的屏幕截图尺寸为 2400x1600 像素。 | [{"alt":"alternative text for image 1", "url":"https://foo.bar/image1.png"}, {"alt":"alternative text for image2", "url":"https://foo.bar/image2.jpg"}] |
com.docker.extension.detailed-description | 是的 | 有关要在详细信息对话框中显示的扩展的纯文本或 HTML 格式的附加信息。 | My detailed description 或者<h1>My detailed description</h1> |
com.docker.extension.publisher-url | 是的 | 要在详细信息对话框中显示的发布者网站 URL。 | https://foo.bar |
com.docker.extension.additional-urls | 不 | 在扩展程序的详细信息页面中向用户显示的标题和附加 URL 的 JSON 数组(按照它们在元数据中出现的顺序)。 Docker 建议您显示以下链接(如果适用):文档、支持、服务条款和隐私政策链接。 | [{"title":"Documentation","url":"https://foo.bar/docs"}, {"title":"Support","url":"https://foo.bar/support"}, {"title":"Terms of Service","url":"https://foo.bar/tos"}, {"title":"Privacy policy","url":"https://foo.bar/privacy-policy"}] |
com.docker.extension.changelog | 是的 | 纯文本或 HTML 格式的变更日志仅包含当前版本的更改。 | Extension changelog 或者<p>Extension changelog<ul> <li>New feature A</li> <li>Bug fix on feature B</li></ul></p> |
com.docker.extension.account-info | 不 | 用户是否需要注册到 SaaS 平台才能使用扩展的某些功能。 | required 如果确实如此,则将其留空。 |
com.docker.extension.categories | 不 | 您的扩展程序所属的市场类别列表:ci-cd , container-orchestration , cloud-deployment , cloud-development , , database , kubernetes , networking , security , testing-tools , utility-tools 。volumes 如果您不指定此标签,用户在按类别过滤时将无法在扩展市场中找到您的扩展。 2022 年 9 月 22 日之前发布到 Marketplace 的扩展已由 Docker 自动分类。 | 如果有多个类别,则指定为逗号分隔值,例如:kubernetes,security 或单个值,例如kubernetes 。 |
提示
Docker Desktop 将 CSS 样式应用于提供的 HTML 内容。您可以确保它 在 Marketplace 中正确呈现。建议您遵循 造型指南。
在 Marketplace 中预览扩展
您可以验证图像标签是否按预期呈现。
创建并安装未发布的扩展程序时,您可以在 Marketplace 的“托管”选项卡中预览该扩展程序。您可以查看扩展程序标签如何在列表和扩展程序的详细信息页面中呈现。
预览已在 Marketplace 中列出的扩展
当您安装已在 Marketplace 中发布的扩展程序的本地映像(例如带有标签)时
latest
,您的本地映像不会被检测为“未发布”。您可以重新标记图像,以获得未列为已发布扩展的不同图像名称。使用
docker tag org/published-extension unpublished-extension
然后docker extension install unpublished-extension
。

