forked from docker/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocker_plugin_install.yaml
More file actions
48 lines (42 loc) · 1.65 KB
/
Copy pathdocker_plugin_install.yaml
File metadata and controls
48 lines (42 loc) · 1.65 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
command: docker plugin install
short: Install a plugin
long: |-
Installs and enables a plugin. Docker looks first for the plugin on your Docker
host. If the plugin does not exist locally, then the plugin is pulled from
the registry. Note that the minimum required registry version to distribute
plugins is 2.3.0
usage: docker plugin install [OPTIONS] PLUGIN [KEY=VALUE...]
pname: docker plugin
plink: docker_plugin.yaml
options:
- option: alias
description: Local name for plugin
- option: disable
default_value: "false"
description: Do not enable the plugin on install
- option: disable-content-trust
default_value: "true"
description: Skip image verification
- option: grant-all-permissions
default_value: "false"
description: Grant all permissions necessary to run the plugin
examples: |-
The following example installs `vieus/sshfs` plugin and [sets](plugin_set.md) its
`DEBUG` environment variable to `1`. To install, `pull` the plugin from Docker
Hub and prompt the user to accept the list of privileges that the plugin needs,
set the plugin's parameters and enable the plugin.
```bash
$ docker plugin install vieux/sshfs DEBUG=1
Plugin "vieux/sshfs" is requesting the following privileges:
- network: [host]
- device: [/dev/fuse]
- capabilities: [CAP_SYS_ADMIN]
Do you grant the above permissions? [y/N] y
vieux/sshfs
```
After the plugin is installed, it appears in the list of plugins:
```bash
$ docker plugin ls
ID NAME TAG DESCRIPTION ENABLED
69553ca1d123 vieux/sshfs latest sshFS plugin for Docker true
```