diff options
Diffstat (limited to 'docs/reference/commandline/plugin_install.md')
| -rw-r--r-- | docs/reference/commandline/plugin_install.md | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/docs/reference/commandline/plugin_install.md b/docs/reference/commandline/plugin_install.md index 0601193ce0..f7ad36dddd 100644 --- a/docs/reference/commandline/plugin_install.md +++ b/docs/reference/commandline/plugin_install.md @@ -27,16 +27,19 @@ Options: --help Print usage ``` +## 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 [set](plugin_set.md) it's env variable -`DEBUG` to 1. Install consists of pulling the plugin from Docker Hub, prompting -the user to accept the list of privileges that the plugin needs, settings parameters - and enabling the plugin. +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 @@ -58,7 +61,7 @@ ID NAME TAG DESCRIPTION 69553ca1d123 vieux/sshfs latest sshFS plugin for Docker true ``` -## Related information +## Related commands * [plugin create](plugin_create.md) * [plugin disable](plugin_disable.md) |