2016-10-14 18:30:36 -04:00
|
|
|
---
|
|
|
|
title: "plugin install"
|
|
|
|
description: "the plugin install command description and usage"
|
2016-11-03 18:48:30 -04:00
|
|
|
keywords: "plugin, install"
|
2016-10-14 18:30:36 -04:00
|
|
|
---
|
2016-06-09 17:57:15 -04:00
|
|
|
|
2016-10-19 13:25:45 -04:00
|
|
|
<!-- This file is maintained within the docker/docker Github
|
|
|
|
repository at https://github.com/docker/docker/. Make all
|
|
|
|
pull requests against that repo. If you see this file in
|
|
|
|
another repository, consider it read-only there, as it will
|
|
|
|
periodically be overwritten by the definitive file. Pull
|
|
|
|
requests which include edits to this file in other repositories
|
|
|
|
will be rejected.
|
|
|
|
-->
|
|
|
|
|
2016-11-09 20:49:09 -05:00
|
|
|
# plugin install
|
2016-06-09 17:57:15 -04:00
|
|
|
|
2016-07-07 14:43:18 -04:00
|
|
|
```markdown
|
2016-11-07 20:43:11 -05:00
|
|
|
Usage: docker plugin install [OPTIONS] PLUGIN [KEY=VALUE...]
|
2016-06-09 17:57:15 -04:00
|
|
|
|
2016-07-07 14:43:18 -04:00
|
|
|
Install a plugin
|
2016-06-09 17:57:15 -04:00
|
|
|
|
2016-07-07 14:43:18 -04:00
|
|
|
Options:
|
2016-12-12 18:05:53 -05:00
|
|
|
--alias string Local name for plugin
|
2016-08-30 06:45:06 -04:00
|
|
|
--disable Do not enable the plugin on install
|
2017-01-12 07:10:23 -05:00
|
|
|
--disable-content-trust Skip image verification (default true)
|
2016-08-30 06:45:06 -04:00
|
|
|
--grant-all-permissions Grant all permissions necessary to run the plugin
|
2016-07-07 14:43:18 -04:00
|
|
|
--help Print usage
|
|
|
|
```
|
2016-06-09 17:57:15 -04:00
|
|
|
|
2017-02-07 18:42:48 -05:00
|
|
|
## Description
|
|
|
|
|
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
|
2016-09-14 13:18:09 -04:00
|
|
|
the registry. Note that the minimum required registry version to distribute
|
|
|
|
plugins is 2.3.0
|
2016-06-09 17:57:15 -04:00
|
|
|
|
2017-02-07 18:42:48 -05:00
|
|
|
## Examples
|
2016-06-09 17:57:15 -04:00
|
|
|
|
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.
|
2016-06-09 17:57:15 -04:00
|
|
|
|
|
|
|
```bash
|
2016-12-14 03:35:34 -05:00
|
|
|
$ docker plugin install vieux/sshfs DEBUG=1
|
2016-07-20 17:37:55 -04:00
|
|
|
|
2016-12-14 03:35:34 -05:00
|
|
|
Plugin "vieux/sshfs" is requesting the following privileges:
|
2016-07-20 17:37:55 -04:00
|
|
|
- network: [host]
|
2016-12-14 03:35:34 -05:00
|
|
|
- device: [/dev/fuse]
|
|
|
|
- capabilities: [CAP_SYS_ADMIN]
|
2016-06-09 17:57:15 -04:00
|
|
|
Do you grant the above permissions? [y/N] y
|
2016-12-14 03:35:34 -05:00
|
|
|
vieux/sshfs
|
2016-06-09 17:57:15 -04:00
|
|
|
```
|
|
|
|
|
|
|
|
After the plugin is installed, it appears in the list of plugins:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
$ docker plugin ls
|
2016-07-20 17:37:55 -04:00
|
|
|
|
2016-12-26 13:17:35 -05:00
|
|
|
ID NAME TAG DESCRIPTION ENABLED
|
2016-12-14 03:35:34 -05:00
|
|
|
69553ca1d123 vieux/sshfs latest sshFS plugin for Docker true
|
2016-06-09 17:57:15 -04:00
|
|
|
```
|
|
|
|
|
2017-02-07 18:42:48 -05:00
|
|
|
## Related commands
|
2016-06-09 17:57:15 -04:00
|
|
|
|
2016-10-04 15:01:19 -04:00
|
|
|
* [plugin create](plugin_create.md)
|
2016-06-09 17:57:15 -04:00
|
|
|
* [plugin disable](plugin_disable.md)
|
2016-11-14 11:38:06 -05:00
|
|
|
* [plugin enable](plugin_enable.md)
|
2016-06-09 17:57:15 -04:00
|
|
|
* [plugin inspect](plugin_inspect.md)
|
2016-11-14 11:38:06 -05:00
|
|
|
* [plugin ls](plugin_ls.md)
|
|
|
|
* [plugin push](plugin_push.md)
|
2016-06-09 17:57:15 -04:00
|
|
|
* [plugin rm](plugin_rm.md)
|
2016-10-31 20:07:05 -04:00
|
|
|
* [plugin set](plugin_set.md)
|
2017-01-28 19:54:32 -05:00
|
|
|
* [plugin upgrade](plugin_upgrade.md)
|