DockerCLI/docs/reference/commandline/plugin_install.md

2.1 KiB

plugin install

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

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