1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
moby--moby/docs/reference/commandline/plugin_install.md
Sebastiaan van Stijn 9d532b5e2d
docs: update reference docs for plugins
the output/response slightly changed in
340964db1c,
and `:latest` is no longer required for
various actions.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-07-20 23:37:55 +02:00

60 lines
1.5 KiB
Markdown

<!--[metadata]>
+++
title = "plugin install"
description = "the plugin install command description and usage"
keywords = ["plugin, install"]
advisory = "experimental"
[menu.main]
parent = "smn_cli"
+++
<![end-metadata]-->
# plugin install (experimental)
```markdown
Usage: docker plugin install [OPTIONS] PLUGIN
Install a plugin
Options:
--disable do not enable the plugin on install
--grant-all-permissions grant all permissions necessary to run the plugin
--help Print usage
```
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
Docker Hub.
The following example installs `no-remove` plugin. Install consists of pulling the
plugin from Docker Hub, prompting the user to accept the list of privileges that
the plugin needs and enabling the plugin.
```bash
$ docker plugin install tiborvass/no-remove
Plugin "tiborvass/no-remove" is requesting the following privileges:
- network: [host]
- mount: [/data]
- device: [/dev/cpu_dma_latency]
Do you grant the above permissions? [y/N] y
tiborvass/no-remove
```
After the plugin is installed, it appears in the list of plugins:
```bash
$ docker plugin ls
NAME VERSION ACTIVE
tiborvass/no-remove latest true
```
## Related information
* [plugin ls](plugin_ls.md)
* [plugin enable](plugin_enable.md)
* [plugin disable](plugin_disable.md)
* [plugin inspect](plugin_inspect.md)
* [plugin rm](plugin_rm.md)