github.com/olljanat/moby@v1.13.1/docs/reference/commandline/plugin_install.md (about)

     1  ---
     2  title: "plugin install"
     3  description: "the plugin install command description and usage"
     4  keywords: "plugin, install"
     5  ---
     6  
     7  <!-- This file is maintained within the docker/docker Github
     8       repository at https://github.com/docker/docker/. Make all
     9       pull requests against that repo. If you see this file in
    10       another repository, consider it read-only there, as it will
    11       periodically be overwritten by the definitive file. Pull
    12       requests which include edits to this file in other repositories
    13       will be rejected.
    14  -->
    15  
    16  # plugin install
    17  
    18  ```markdown
    19  Usage:  docker plugin install [OPTIONS] PLUGIN [KEY=VALUE...]
    20  
    21  Install a plugin
    22  
    23  Options:
    24        --alias string            Local name for plugin
    25        --disable                 Do not enable the plugin on install
    26        --grant-all-permissions   Grant all permissions necessary to run the plugin
    27        --help                    Print usage
    28  ```
    29  
    30  Installs and enables a plugin. Docker looks first for the plugin on your Docker
    31  host. If the plugin does not exist locally, then the plugin is pulled from
    32  the registry. Note that the minimum required registry version to distribute
    33  plugins is 2.3.0
    34  
    35  
    36  The following example installs `vieus/sshfs` plugin and [set](plugin_set.md) it's env variable
    37  `DEBUG` to 1. Install consists of pulling the plugin from Docker Hub, prompting
    38  the user to accept the list of privileges that the plugin needs, settings parameters
    39   and enabling the plugin.
    40  
    41  ```bash
    42  $ docker plugin install vieux/sshfs DEBUG=1
    43  
    44  Plugin "vieux/sshfs" is requesting the following privileges:
    45   - network: [host]
    46   - device: [/dev/fuse]
    47   - capabilities: [CAP_SYS_ADMIN]
    48  Do you grant the above permissions? [y/N] y
    49  vieux/sshfs
    50  ```
    51  
    52  After the plugin is installed, it appears in the list of plugins:
    53  
    54  ```bash
    55  $ docker plugin ls
    56  
    57  ID                  NAME                  TAG                 DESCRIPTION                ENABLED
    58  69553ca1d123        vieux/sshfs           latest              sshFS plugin for Docker    true
    59  ```
    60  
    61  ## Related information
    62  
    63  * [plugin create](plugin_create.md)
    64  * [plugin disable](plugin_disable.md)
    65  * [plugin enable](plugin_enable.md)
    66  * [plugin inspect](plugin_inspect.md)
    67  * [plugin ls](plugin_ls.md)
    68  * [plugin push](plugin_push.md)
    69  * [plugin rm](plugin_rm.md)
    70  * [plugin set](plugin_set.md)
    71  * [plugin upgrade](plugin_upgrade.md)