Docker Desktop extension metadata

Docker Desktop extension metadata configuration file. Documentation: https://docs.docker.com/extensions/extensions-sdk/architecture/metadata/

Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/docker-desktop-extension-metadata/latest.json
Source https://www.schemastore.org/docker-extension-metadata.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Docker Desktop extension.

Properties

icon string

The icon for the extension. Will be displayed on the sidebar, in the extension list and on Docker Hub.

ui object

UI configuration for your extension.

1 nested properties
dashboard-tab object

Dashboard tab UI configuration.

3 nested properties
title string required

The name of your extension, that will be displayed in the dashboard.

src string required

The HTML entrypoint for the extension tab.

root string

The root folder (in your extension's image) where your UI code is stored.

vm object

Backend configuration for your extension.

2 nested properties
image string

The image to use for your extension. A default compose file will be generated for your extension. If you want to use the same image that packages your extension, use ${DESKTOP_PLUGIN_IMAGE}.

composefile string

A path to your Docker compose file for your backend container.

host object

Host configuration for your extension.

1 nested properties
binaries object[]

An array of binaries that Docker Desktop will copy from the extension image onto the host machine. These binaries can be invoked by your extension using the JavaScript API in your frontend. Docker Desktop automatically handles transfer of binaries for you. For more information, see https://docs.docker.com/extensions/extensions-sdk/guides/invoke-host-binaries/

Definitions

binariesOnVMHost object[]