Engdocs 633 (#14534)

* Created new extensions user manual
This commit is contained in:
Allie Sadler 2022-04-25 14:35:36 +01:00 committed by GitHub
parent 532eafb1c8
commit 28a3987c9f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 79 additions and 0 deletions

View File

@ -1188,6 +1188,8 @@ manuals:
title: Dashboard
- path: /desktop/dev-environments/
title: Dev Environments (Preview)
- path: /desktop/extensions/
title: Extensions (Preview)
- path: /desktop/multi-arch/
title: Multi-arch support
- path: /desktop/kubernetes/

77
desktop/extensions.md Normal file
View File

@ -0,0 +1,77 @@
---
description: Extensions
keywords: Docker Extensions, Docker Desktop, Linux, Mac, Windows
title: Docker Extensions
toc_min: 1
toc_max: 2
---
Docker Extensions lets you use third-party tools within Docker Desktop to extend its functionality. There is no limit to the number of extensions you can install.
Docker Community members and partners can use our [SDK](https://docker-desktop-extensions.netlify.app/){:target="_blank" rel="noopener" class="_"} to create new extensions.
> **Preview**
>
> The Docker Extensions feature is currently offered as a Preview. We recommend that you do not use Extensions in production environments.
![extenstions](images/extensions-image.PNG){:width="750px"}
## Prerequisites
Docker Extensions is available as part of Docker Desktop 4.8.0 or a later release. Download and install Docker Desktop 4.8.0 or later:
* [Mac](mac/release-notes/index.md)
* [Windows](windows/release-notes/index.md)
* [Linux](linux/index.md)
## Add an extension
>**Note**
>
> For some extensions, a separate account needs to be created before use.
To add Docker Extensions:
1. Open Docker Desktop.
2. From the Dashboard, select **Add Extensions** in the menu bar.
The Extensions Marketplace opens.
2. Browse the available extensions.
3. Click **Install**.<br>
From here, you can click **Open** to access the extension or install additional extensions. The extension also appears in the menu bar.
## Enable or disable extensions available in the Marketplace
Docker Extensions are switched on by default. To change your settings:
1. Navigate to **Settings**, or **Preferences** if you're a Mac user.
2. Select the **Extensions** tab.
3. Next to **Enable Docker Extensions**, select or clear the checkbox to set your desired state.
4. In the bottom-right corner, click **Apply & Restart**.
## Enable or disable extensions not available in the Marketplace
You can install Docker Extensions through the Marketplace or through the Extensions SDK tools. You can choose to only allow published extensions (that have been published in the Extensions Marketplace).
1. Navigate to **Settings**, or **Preferences** if you're a Mac user.
2. Select the **Extensions** tab.
3. Next to **Allow only extensions distributed through the Docker Marketplace**, select or clear the checkbox to set your desired state.
4. In the bottom-right corner, click **Apply & Restart**.
## Update an extension
You can update Docker Extensions outside of Docker Desktop releases. To update an extension to the latest version:
1. Navigate to Docker Dashboard, and from the menu bar select the ellipsis to the right of **Extensions**.
2. Click **Manage Extensions**.
If an extension has a new version available, it displays an **Update** button.
3. Click **Update**.
## Uninstall an extension
You can uninstall an extension at any time.
> **Note**
>
> Any data used by the extension that is stored in a volume must be manually deleted.
1. From the menu bar, select the ellipsis to the right of **Extensions**.
2. Click **Manage Extensions**. This displays a list of extensions you've installed.
3. Click **Uninstall**.

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB