DockerCLI/docs/reference/commandline/plugin_install.md

# plugin install

<!---MARKER_GEN_START-->
Install a plugin

### Options

| Name                      | Type     | Default | Description                                       |
|:--------------------------|:---------|:--------|:--------------------------------------------------|
| `--alias`                 | `string` |         | Local name for plugin                             |
| `--disable`               | `bool`   |         | Do not enable the plugin on install               |
| `--disable-content-trust` | `bool`   | `true`  | Skip image verification                           |
| `--grant-all-permissions` | `bool`   |         | Grant all permissions necessary to run the plugin |


<!---MARKER_GEN_END-->

## Description

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.

## 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.

```console
$ 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:

```console
$ docker plugin ls

ID             NAME                  DESCRIPTION                ENABLED
69553ca1d123   vieux/sshfs:latest    sshFS plugin for Docker    true
```

## Related commands

* [plugin create](plugin_create.md)
* [plugin disable](plugin_disable.md)
* [plugin enable](plugin_enable.md)
* [plugin inspect](plugin_inspect.md)
* [plugin ls](plugin_ls.md)
* [plugin push](plugin_push.md)
* [plugin rm](plugin_rm.md)
* [plugin set](plugin_set.md)
* [plugin upgrade](plugin_upgrade.md)
move plugins out of experimental Signed-off-by: Victor Vieux <vieux@docker.com> 2016-11-09 20:49:09 -05:00			`# plugin install`
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2016-06-09 17:57:15 -04:00
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2023-01-06 13:04:05 -05:00			`<!---MARKER_GEN_START-->`
Updates on cli reference documentation - Update ps with `--last` flag - Update commands with current output - Make sure hugo does not detect the wrong language - Update usage for `tag` command to be more coherent with the other ones Signed-off-by: Vincent Demeester <vincent@sbr.pm> 2016-07-07 14:43:18 -04:00			`Install a plugin`
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2016-06-09 17:57:15 -04:00
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2023-01-06 13:04:05 -05:00			`### Options`

			`\| Name \| Type \| Default \| Description \|`
			`\|:--------------------------\|:---------\|:--------\|:--------------------------------------------------\|`
			\| `--alias` \| `string` \| \| Local name for plugin \|
chore: regenerate docs Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> 2024-07-03 02:29:57 -04:00			\| `--disable` \| `bool` \| \| Do not enable the plugin on install \|
docs: regenerate markdown Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2024-02-21 03:51:39 -05:00			\| `--disable-content-trust` \| `bool` \| `true` \| Skip image verification \|
chore: regenerate docs Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> 2024-07-03 02:29:57 -04:00			\| `--grant-all-permissions` \| `bool` \| \| Grant all permissions necessary to run the plugin \|
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2023-01-06 13:04:05 -05:00

			`<!---MARKER_GEN_END-->`
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2016-06-09 17:57:15 -04:00
Standardized formatting of CLI reference commands Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <misty@docker.com> 2017-02-07 18:42:48 -05:00			`## Description`

docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2016-06-09 17:57:15 -04:00			`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`
Update plugin install docs with registry specifics. Signed-off-by: Anusha Ragunathan <anusha@docker.com> 2016-09-14 13:18:09 -04:00			`the registry. Note that the minimum required registry version to distribute`
update typos and style in docs Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> Signed-off-by: Craig Osterhout <craig.osterhout@docker.com> 2023-12-13 18:06:16 -05:00			`plugins is 2.3.0.`
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2016-06-09 17:57:15 -04:00
Standardized formatting of CLI reference commands Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <misty@docker.com> 2017-02-07 18:42:48 -05:00			`## Examples`
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2016-06-09 17:57:15 -04:00
Standardized formatting of CLI reference commands Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <misty@docker.com> 2017-02-07 18:42:48 -05:00			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.`
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2016-06-09 17:57:15 -04:00
docs: use "console" code-hint for shell examples This replaces the use of bash where suitable, to allow easier copy/pasting of shell examples without copying the prompt or process output. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2021-08-21 08:54:14 -04:00			```console
replace no-remove by sample-volume-plugin in docs Signed-off-by: Victor Vieux <vieux@docker.com> 2016-12-14 03:35:34 -05:00			`$ docker plugin install vieux/sshfs DEBUG=1`
docs: update reference docs for plugins the output/response slightly changed in 340964db1c8f161a2ad156023eb47dcc93bf804b, and `:latest` is no longer required for various actions. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2016-07-20 17:37:55 -04:00
replace no-remove by sample-volume-plugin in docs Signed-off-by: Victor Vieux <vieux@docker.com> 2016-12-14 03:35:34 -05:00			`Plugin "vieux/sshfs" is requesting the following privileges:`
docs: update reference docs for plugins the output/response slightly changed in 340964db1c8f161a2ad156023eb47dcc93bf804b, and `:latest` is no longer required for various actions. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2016-07-20 17:37:55 -04:00			`- network: [host]`
replace no-remove by sample-volume-plugin in docs Signed-off-by: Victor Vieux <vieux@docker.com> 2016-12-14 03:35:34 -05:00			`- device: [/dev/fuse]`
			`- capabilities: [CAP_SYS_ADMIN]`
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2016-06-09 17:57:15 -04:00			`Do you grant the above permissions? [y/N] y`
replace no-remove by sample-volume-plugin in docs Signed-off-by: Victor Vieux <vieux@docker.com> 2016-12-14 03:35:34 -05:00			`vieux/sshfs`
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2016-06-09 17:57:15 -04:00			```

			`After the plugin is installed, it appears in the list of plugins:`

docs: use "console" code-hint for shell examples This replaces the use of bash where suitable, to allow easier copy/pasting of shell examples without copying the prompt or process output. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2021-08-21 08:54:14 -04:00			```console
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2016-06-09 17:57:15 -04:00			`$ docker plugin ls`
docs: update reference docs for plugins the output/response slightly changed in 340964db1c8f161a2ad156023eb47dcc93bf804b, and `:latest` is no longer required for various actions. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2016-07-20 17:37:55 -04:00
docs: fix example output for docker plugin ls The output format was changed to combine tag and name in a single column, but this change was never reflected in the docs. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2020-06-18 10:37:36 -04:00			`ID NAME DESCRIPTION ENABLED`
			`69553ca1d123 vieux/sshfs:latest sshFS plugin for Docker true`
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2016-06-09 17:57:15 -04:00			```

Standardized formatting of CLI reference commands Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <misty@docker.com> 2017-02-07 18:42:48 -05:00			`## Related commands`
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2016-06-09 17:57:15 -04:00
Add plugin create functionality. Signed-off-by: Anusha Ragunathan <anusha@docker.com> 2016-10-04 15:01:19 -04:00			`* [plugin create](plugin_create.md)`
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2016-06-09 17:57:15 -04:00			`* [plugin disable](plugin_disable.md)`
Add docs for plugin push Signed-off-by: Anusha Ragunathan <anusha@docker.com> 2016-11-14 11:38:06 -05:00			`* [plugin enable](plugin_enable.md)`
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2016-06-09 17:57:15 -04:00			`* [plugin inspect](plugin_inspect.md)`
Add docs for plugin push Signed-off-by: Anusha Ragunathan <anusha@docker.com> 2016-11-14 11:38:06 -05:00			`* [plugin ls](plugin_ls.md)`
			`* [plugin push](plugin_push.md)`
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2016-06-09 17:57:15 -04:00			`* [plugin rm](plugin_rm.md)`
support env for docker plugin set Signed-off-by: Victor Vieux <vieux@docker.com> 2016-10-31 20:07:05 -04:00			`* [plugin set](plugin_set.md)`
Add docker plugin upgrade This allows a plugin to be upgraded without requiring to uninstall/reinstall a plugin. Since plugin resources (e.g. volumes) are tied to a plugin ID, this is important to ensure resources aren't lost. The plugin must be disabled while upgrading (errors out if enabled). This does not add any convenience flags for automatically disabling/re-enabling the plugin during before/after upgrade. Since an upgrade may change requested permissions, the user is required to accept permissions just like `docker plugin install`. Signed-off-by: Brian Goff <cpuguy83@gmail.com> 2017-01-28 19:54:32 -05:00			`* [plugin upgrade](plugin_upgrade.md)`