Skip to content

scout: fix manual cli bin install steps #21673

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

Merged
merged 1 commit into from
Dec 19, 2024
Merged

scout: fix manual cli bin install steps #21673

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
25 changes: 20 additions & 5 deletions content/manuals/scout/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,16 @@ $ sh install-scout.sh
```json
{
"cliPluginsExtraDirs": [
"$HOME/.docker/scout"
"/home/<USER>/.docker/scout"
]
}
```

Substitute `<USER>` with your username on the system.

> [!NOTE]
> The path for `cliPluginsExtraDirs` must be an absolute path.

{{< /tab >}}
{{< tab name="macOS" >}}

Expand All @@ -65,25 +70,30 @@ $ sh install-scout.sh
4. Make the binary executable:

```console
$ chmod +x $HOME/.docker/scout/docker-scout`
$ 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`.
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
{
"cliPluginsExtraDirs": [
"$HOME/.docker/scout"
"/Users/<USER>/.docker/scout"
]
}
```

Substitute `<USER>` with your username on the system.

> [!NOTE]
> The path for `cliPluginsExtraDirs` must be an absolute path.

{{< /tab >}}
{{< tab name="Windows" >}}

Expand All @@ -100,11 +110,16 @@ $ sh install-scout.sh
```json
{
"cliPluginsExtraDirs": [
"C:\Users\MobyWhale\.docker\scout"
"C:\Users\<USER>\.docker\scout"
]
}
```

Substitute `<USER>` with your username on the system.

> [!NOTE]
> The path for `cliPluginsExtraDirs` must be an absolute path.

{{< /tab >}}
{{< /tabs >}}

Expand Down