Skip to content

Document how to use extension private marketplace with settings managed via admin console #23982

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
gtardif wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Document how to use extension private marketplace with settings managed via admin console #23982

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion content/manuals/extensions/private-marketplace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,18 @@ This creates 2 files:
- `admin-settings.json`, which activates the private marketplace feature once it’s applied to Docker Desktop on your developers’ machines.
- `extensions.txt`, which determines which extensions to list in your private marketplace.

> [!IMPORTANT]
>
> If your org is using [settings management](/manuals/enterprise/security/hardened-desktop/settings-management/_index.md) via [Admin console](manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console/_index.md), you will not need the admins-settings.json file. Just delete the generated file and keep only `extensions.txt` at this stage.

## Step two: Set the behaviour

The generated `admin-settings.json` file includes various settings you can modify.

> [!IMPORTANT]
>
> If your org is managing settings via [Admin console](manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console/_index.md), you will define the same settings in the admin console instead of admins-settings.json.

Each setting has a `value` that you can set, including a `locked` field that lets you lock the setting and make it unchangeable by your developers.

- `extensionsEnabled` enables Docker Extensions.
Expand Down Expand Up @@ -174,6 +182,10 @@ It's recommended that you try the private marketplace on your Docker Desktop ins
2. Quit and re-open Docker Desktop.
3. Sign in with a Docker account.

> [!IMPORTANT]
>
> > If your org is managing settings via [Admin console](manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console/_index.md), with Docker Desktop version lower than 4.59 you will need to manually delete `admin-settings.json` that has been created in the target folder by the `apply` command before step 2.

When you select the **Extensions** tab, you should see the private marketplace listing only the extensions you have allowed in `extensions.txt`.

![Extensions Private Marketplace](/assets/images/extensions-private-marketplace.webp)
Expand All @@ -183,7 +195,7 @@ When you select the **Extensions** tab, you should see the private marketplace l
Once you’ve confirmed that the private marketplace configuration works, the final step is to distribute the files to the developers’ machines with the MDM software your organization uses. For example, [Jamf](https://www.jamf.com/).

The files to distribute are:
* `admin-settings.json`
* `admin-settings.json` (except if your org is managing settings via [Admin console](manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console/_index.md))
* the entire `extension-marketplace` folder and its subfolders

These files must be placed on developer's machines. Depending on your operating system, the target location is (as mentioned above):
Expand Down