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

Merge pull request #20223 from dvdksn/scout-install-updates 

scout: improve scout install
This commit is contained in:
David Karlsson 2024-06-24 23:41:04 +02:00 committed by GitHub
parent 381cc03650 0f4ae14d28
commit 069a0810ef
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 101 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

105
content/scout/install.md
View File

@ -10,6 +10,8 @@ If you run Docker Engine without Docker Desktop,
Docker Scout doesn't come pre-installed,
but you can install it as a standalone binary.
## Installation script
To install the latest version of the plugin, run the following commands:
```console
@ -23,8 +25,103 @@ $ sh install-scout.sh
> locally. Before installing, make yourself familiar with potential risks and
> limitations of the convenience script.
If you want to install the plugin manually, you can find full instructions
and links to download in the [scout-cli repository](https://github.com/docker/scout-cli).
## Manual installation
The Docker Scout CLI plugin is also available as [a container image](https://hub.docker.com/r/docker/scout-cli)
and as [a GitHub action](https://github.com/docker/scout-action).
{{< tabs >}}
{{< tab name="Linux" >}}
1. Download the latest release from the [releases page](https://github.com/docker/scout-cli/releases).
2. Create a subdirectory under `$HOME/.docker` called `scout`.
```console
$ mkdir -p $HOME/.docker/scout
```
3. Extract the archive and move the `docker-scout` binary to the `$HOME/.docker/scout` directory.
4. Make the binary executable: `chmod +x $HOME/.docker/scout/docker-scout`.
5. Add the `scout` subdirectory to your `.docker/config.json` as a plugin directory:
```json
{
"cliPluginExtraDirs": [
"$HOME/.docker/scout"
]
}
```
{{< /tab >}}
{{< tab name="macOS" >}}
1. Download the latest release from the [releases page](https://github.com/docker/scout-cli/releases).
2. Create a subdirectory under `$HOME/.docker` called `scout`.
```console
$ mkdir -p $HOME/.docker/scout
```
3. Extract the archive and move the `docker-scout` binary to the `$HOME/.docker/scout` directory.
4. Make the binary executable:
```console
$ chmod +x $HOME/.docker/scout/docker-scout`
```
5. Authorize the binary to be executable on macOS:
```console
xattr -d com.apple.quarantine $HOME/.docker/scout/docker-scout`.
```
6. Add the `scout` subdirectory to your `.docker/config.json` as a plugin directory:
```json
{
"cliPluginExtraDirs": [
"$HOME/.docker/scout"
]
}
```
{{< /tab >}}
{{< tab name="Windows" >}}
1. Download the latest release from the [releases page](https://github.com/docker/scout-cli/releases).
2. Create a subdirectory under `%USERPROFILE%/.docker` called `scout`.
```console
% mkdir %USERPROFILE%\.docker\scout
```
3. Extract the archive and move the `docker-scout.exe` binary to the `%USERPROFILE%\.docker\scout` directory.
4. Add the `scout` subdirectory to your `.docker\config.json` as a plugin directory:
```json
{
"cliPluginExtraDirs": [
"C:\Users\MobyWhale\.docker\scout"
]
}
```
{{< /tab >}}
{{< /tabs >}}
## Container image
The Docker Scout CLI plugin is also available as a [container image](https://hub.docker.com/r/docker/scout-cli).
Use the `docker/scout-cli` to run `docker scout` commands without installing the CLI plugin on your host.
```console
$ docker run -it \
-e DOCKER_SCOUT_HUB_USER=<your Docker Hub user name> \
-e DOCKER_SCOUT_HUB_PASSWORD=<your Docker Hub PAT> \
docker/scout-cli <command>
```
## GitHub Action
The Docker Scout CLI plugin is also available as a [GitHub action](https://github.com/docker/scout-action).
You can use it in your GitHub workflows to automatically analyze images and evaluate policy compliance with each push.
Docker Scout also integrates with many more CI/CD tools, such as Jenkins, GitLab, and Azure DevOps.
Learn more about the [integrations](./integrations/_index.md) available for Docker Scout.