Skip to content

Commit b51bafe

Browse files
committed
add installation details
Signed-off-by: Yves Brissaud <[email protected]>
1 parent 9ef74c5 commit b51bafe

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

+31
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,34 @@
2424
```
2525

2626
See the [Docker RunX reference](/docs/reference/runx.md) for more information.
27+
28+
## CLI Plugin Installation
29+
30+
### Manual Installation
31+
32+
To install it manually:
33+
34+
- Download the `docker-runx` binary corresponding to your platform from the [latest](https://github.com/eunomie/docker-runx/releases/latest) or [other](https://github.com/eunomie/docker-runx/releases) releases.
35+
- Rename it as
36+
- `docker-runx` on _Linux_ and _macOS_
37+
- `docker-runx.exe` on _Windows_
38+
- Copy the binary to the `runx` directory (you might need to create it)
39+
- `$HOME/.docker/runx` on _Linux_ and _macOS_
40+
- `%USERPROFILE%\.docker\runx` on _Windows_
41+
- Make it executable on _Linux_ and _macOS_
42+
- `chmod +x $HOME/.docker/runx/docker-runx`
43+
- Authorize the binary to be executable on _macOS_
44+
- `xattr -d com.apple.quarantine $HOME/.docker/runx/docker-runx`
45+
- Add the `runx` directory to your `.docker/config.json` as a plugin directory
46+
- `$HOME/.docker/config.json` on _Linux_ and _macOS_
47+
- `%USERPROFILE%\.docker\config.json` on _Windows_
48+
- Add the `cliPluginsExtraDirs` property to the `config.json` file
49+
```
50+
{
51+
...
52+
"cliPluginsExtraDirs": [
53+
"<full path to the .docker/runx folder>"
54+
],
55+
...
56+
}
57+
```

0 commit comments

Comments
 (0)