docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #14118 from usha-mandya/registry-json-update 

Update the registry json file creation section
This commit is contained in:
jerae-duffin 2022-01-14 12:55:50 -06:00 committed by GitHub
parent 0c9de81c4e 470de11815
commit 4b292bec93
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 57 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
docker-hub/image-access-management.md
View File

@ -2,7 +2,6 @@
description: Image Access Management description: Image Access Management
keywords: image, access, management keywords: image, access, management
title: Image Access Management title: Image Access Management
toc_max: 2
--- ---
Image Access Management is a new feature that is a part of the Docker Business subscription. This feature allows Organization owners to control which types of images (Docker Official Images, Docker Verified Publisher Images, Community images) their developers can pull from Docker Hub. Image Access Management is a new feature that is a part of the Docker Business subscription. This feature allows Organization owners to control which types of images (Docker Official Images, Docker Verified Publisher Images, Community images) their developers can pull from Docker Hub.
@ -39,70 +38,85 @@ To configure Image Access Management permissions, perform the following steps:
4. Select the category restrictions for your images by clicking **Allowed**. 4. Select the category restrictions for your images by clicking **Allowed**.
5. Once the restrictions are applied, your members can view the Org permissions page in a read-only format. 5. Once the restrictions are applied, your members can view the Org permissions page in a read-only format.
To ensure that each org member uses images in a safe and secure environment, you can perform the following steps below to enforce sign-in under your organization. ### Enforce authentication
1. Download Docker Desktop 4.0 or a later release. To ensure that each org member uses images in a safe and secure environment, you
can perform the following steps below to enforce sign-in under your
organization. To do this:
- [Download and install for Windows](/desktop/windows/install/) 1. Download the latest version of Docker Desktop, and then
- [Download and install for Mac](/desktop/mac/install/) 2. Create a `registry.json` file.
> **Note** Download Docker Desktop 4.0 or a later release.
>
> There currently is no Docker Desktop for Linux. Linux users will have the same restrictions as Mac and Windows users while logged in, but there is currently no way to require them to log in.
2. Create a registry.json file on Windows or Mac. - [Download and install for Windows](/desktop/windows/install/)
- [Download and install for Mac](/desktop/mac/install/)
For **Windows**: > **Note**
>
> There is currently no Docker Desktop for Linux. Linux users will have the same
> restrictions as Mac and Windows users while logged in. However, there is
> currently no way to enforce Linux users to log in.
Create a file `C:\ProgramData\DockerDesktop\registry.json` with file permissions that ensure that the developer using Docker Desktop cannot remove or edit the file (i.e., only the system administrator can write to the file). The file must be JSON and contain one or more organization names in the `allowedOrgs` key. #### Create a registry json file
To create your registry.json file: After you've successfully installed Docker Desktop, create a `registry.json` file on Windows or Mac.
1. Open Windows Powershell and select Run as Administrator. **On Windows**
2. Type the following command: `cd /ProgramData/DockerDesktop/`
3. In Notepad, type `registry.json` and enter one or more organization names in the `allowedOrgs` key and click Save.
Example: Create a file `C:\ProgramData\DockerDesktop\registry.json` with file permissions that ensure that the developer using Docker Desktop cannot remove or edit the file (i.e., only the system administrator can write to the file). The file must be JSON and contain one or more organization names in the `allowedOrgs` key.
```json To create your `registry.json` file on Windows:
{
"allowedOrgs": ["mycompany"]
}
```
4. Navigate to Powershell and type ```start .```
Congratulations, you have just created the registry.json file. 1. Open Windows Powershell and select Run as Administrator.
2. Type the following command: `cd /ProgramData/DockerDesktop/`
3. In Notepad, type `registry.json` and enter one or more organization names in the `allowedOrgs` key and click Save.
For **macOS**: For example:
Create a file `/Library/Application Support/com.docker.docker/registry.json` with file permissions that ensure that the developer using Docker Desktop cannot remove or edit the file (i.e., only the system administrator can write to the file). The file must be JSON and contain one or more organization names in the `allowedOrgs` key. The user must sign in and be a member of at least one of the organizations before using Docker Desktop. ```json
{
"allowedOrgs": ["mycompany"]
}
```
To create your registry.json file: 4. Navigate to Powershell and type ```start .```
1. Navigate to VS Code or any text editor of your choice.
2. Enter one or more organization names in the `allowedOrgs` key and save it in your Documents.
Example: Congratulations! You have just created the registry.json file.
```json **On macOS**:
{
"allowedOrgs": ["mycompany"]
}
```
3. Open a new terminal and type the following command: Create a file `/Library/Application Support/com.docker.docker/registry.json` with file permissions that ensure that the developer using Docker Desktop cannot remove or edit the file (i.e., only the system administrator can write to the file). The file must be JSON and contain one or more organization names in the `allowedOrgs` key. The user must sign in and be a member of at least one of the organizations before using Docker Desktop.
`sudo mkdir -p /Library/Application\ Support/com.docker.docker` To create your `registry.json` file on macOS:
Note: if prompted, type your password associated with your local computer. 1. Navigate to VS Code or any text editor of your choice.
2. Enter one or more organization names in the `allowedOrgs` key and save it in your Documents.
4. Type the following command: For example:
`Documents/registry.json /Library/Application\ Support/com.docker.docker/registry.json` ```json
{
"allowedOrgs": ["mycompany"]
}
```
Congratulations, you have just created the registry.json file. 3. Open a new terminal and type the following command:
3. To confirm that the restrictions are successful, have each org member pull an image onto their local computer after signing into Docker Desktop. If they are unable to sign in, they will receive an error message. `sudo mkdir -p /Library/Application\ Support/com.docker.docker`
For example, if you enable Image Access Management, your members can pull an Organization Image, Docker Official Image, or Verified Publisher Image onto their local machine. If you disable the restrictions, your members can pull any image, including Community Images. Note: if prompted, type your password associated with your local computer.
![Image Access Management](images/image-access-management-error.png){:width="700px"} 4. Type the following command:
`sudo cp Documents/registry.json /Library/Application\ Support/com.docker.docker/registry.json`
Congratulations! You have just created the `registry.json` file.
### Verify the restrictions
To confirm that the restrictions are successful, have each org member pull an image onto their local computer after signing into Docker Desktop. If they are unable to sign in, they will receive an error message.
For example, if you enable Image Access Management, your members can pull an Organization Image, Docker Official Image, or Verified Publisher Image onto their local machine. If you disable the restrictions, your members can pull any image, including Community Images.
![Image Access Management](images/image-access-management-error.png){:width="700px"}