docker plugin install
Description
Install a plugin
API 1.25+
The client and daemon API must both be at least
1.25
to use this command. Use the docker version command on the client to check
your client and daemon API versions.
Usage
$ docker plugin install [OPTIONS] PLUGIN [KEY=VALUE...]
Extended 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
For example uses of this command, refer to the examples section below.
Options
| Name, shorthand | Default | Description |
--alias |
Local name for plugin | |
--disable |
Do not enable the plugin on install | |
--disable-content-trust |
true |
Skip image verification |
--grant-all-permissions |
Grant all permissions necessary to run the plugin |
Examples
The following example installs vieus/sshfs plugin and sets 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 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:
$ docker plugin ls
ID NAME DESCRIPTION ENABLED
69553ca1d123 vieux/sshfs:latest sshFS plugin for Docker true
Parent command
| Command | Description |
|---|---|
| docker plugin | Manage plugins |
Related commands
| Command | Description |
| docker plugin create | Create a plugin from a rootfs and configuration. Plugin data directory must contain config.json and rootfs directory. |
| docker plugin disable | Disable a plugin |
| docker plugin enable | Enable a plugin |
| docker plugin inspect | Display detailed information on one or more plugins |
| docker plugin install | Install a plugin |
| docker plugin ls | List plugins |
| docker plugin push | Push a plugin to a registry |
| docker plugin rm | Remove one or more plugins |
| docker plugin set | Change settings for a plugin |
| docker plugin upgrade | Upgrade an existing plugin |