|
| 1 | +--- |
| 2 | +description: How to configure Settings Management for Docker Desktop using the Docker Admin Console |
| 3 | +keywords: admin, controls, rootless, enhanced container isolation |
| 4 | +title: Configure Settings Management with the Admin Console |
| 5 | +linkTitle: Configure with the Admin Console |
| 6 | +weight: 20 |
| 7 | +params: |
| 8 | + sidebar: |
| 9 | + badge: |
| 10 | + color: violet |
| 11 | + text: EA |
| 12 | +--- |
| 13 | + |
| 14 | +{{% restricted title="Early Access" %}} |
| 15 | +Settings Management in the Docker Admin Console is an [early access](/release-lifecycle#early-access-ea) feature and is available to Docker Business customers only. |
| 16 | +{{% /restricted %}} |
| 17 | + |
| 18 | +This page contains information for administrators on how to configure Settings Management with the Docker Admin Console to specify and lock configuration parameters to create a standardized Docker Desktop environment across your Docker company or organization. |
| 19 | + |
| 20 | +## Prerequisites |
| 21 | + |
| 22 | +- [Download and install Docker Desktop 4.36.0 or later](/manuals/desktop/release-notes.md). |
| 23 | +- Make sure you have [verified your domain](/manuals/security/for-admins/single-sign-on/configure.md#step-one-add-and-verify-your-domain) |
| 24 | +- [Enforce sign-in](/manuals/security/for-admins/enforce-sign-in/_index.md). This is |
| 25 | +because the Settings Management feature requires a Docker Business |
| 26 | +subscription and therefore your Docker Desktop users must authenticate to your |
| 27 | +organifdzation for configurations to take effect. |
| 28 | + |
| 29 | +## Create a settings policy |
| 30 | + |
| 31 | +1. Within the [Docker Admin Console](https://admin.docker.com/) navigate to the company or organization you want to define a settings policy for. |
| 32 | +2. Under the **Security and access** section, select **Desktop Settings Management**. |
| 33 | +3. In the top-right corner, select **Create a settings policy**. |
| 34 | +4. Give your settings policy a name and an optional description. |
| 35 | + |
| 36 | + > [!TIP] |
| 37 | + > |
| 38 | + > If you have already configured Settings Management with an `admin-settings.json` file for an organization, you can upload it using the **Upload existing settings** button which then automatically populates the form for you. |
| 39 | + > |
| 40 | + > Settings policies deployed via the Docker Admin Console take precedence over manually deployed `admin-settings.json` files. |
| 41 | +
|
| 42 | +5. Assign the setting policy to all your users within the company or organization, or specific users. |
| 43 | + |
| 44 | + > [!NOTE] |
| 45 | + > |
| 46 | + > If a settings policy is assigned to all users, it sets the policy as the global default policy. You can only have one global settings policy at a time. |
| 47 | + > If a user already has a user-specific settings policy assigned, the user-specific policy takes precedence over a global policy. |
| 48 | +
|
| 49 | + > [!TIP] |
| 50 | + > |
| 51 | + > Before setting a global settings policy, it is recommended that you first test it as a user-specific policy to make sure you're happy with the changes before proceeding. |
| 52 | +
|
| 53 | +6. Configure the settings for the policy. Go through each setting and select your chosen setting state. You can choose |
| 54 | + - **User-defined**. Your developers are able to control and change this setting. |
| 55 | + - **Always enabled**. This means the setting is turned on and your users won't be able to edit this setting from Docker Desktop or the CLI. |
| 56 | + - **Enabled**. The setting is turned on and users can edit this setting from Docker Desktop or the CLI. |
| 57 | + - **Always disabled**. This means the setting is turned off and your users won't be able to edit this setting from Docker Desktop or the CLI. |
| 58 | + - **Disabled**. The setting is turned off and users can edit this setting from Docker Desktop or the CLI. |
| 59 | +7. Select **Create** |
| 60 | + |
| 61 | +For the settings policy to take effect: |
| 62 | +- On a new install, users need to launch Docker Desktop and authenticate to their organization. |
| 63 | +- On an existing install, users need to quit Docker Desktop through the Docker menu, and then re-launch Docker Desktop. If they are already signed in, they don't need to sign in again for the changes to take effect. |
| 64 | + |
| 65 | + > [!IMPORTANT] |
| 66 | + > |
| 67 | + > Selecting **Restart** from the Docker menu isn't enough as it only restarts some components of Docker Desktop. |
| 68 | +
|
| 69 | +To avoid disrupting your users' workflows, Docker doesn't automatically require that users re-launch once a change has been made. |
| 70 | + |
| 71 | +> [!NOTE] |
| 72 | +> |
| 73 | +> Settings are synced to Docker Desktop and the CLI when a user is signed in and starts Docker Desktop, and then every 60 minutes. |
| 74 | +If your settings policy needs to be rolled back, either delete the policy or edit the policy to set individual settings to **User-defined**. |
| 75 | + |
| 76 | +## Settings policy actions |
| 77 | + |
| 78 | +From the **Actions** menu on the **Desktop Settings Management** page in the Docker Admin Console, you can: |
| 79 | +- Edit or delete an existing settings policy. |
| 80 | +- Export a settings policy as an `admin-settings.json` file. |
| 81 | +- Promote a policy that is applied to a select group of users, to be the new global default policy for all users. |
0 commit comments