| Edwin Kempin | f729574 | 2012-07-16 15:03:46 +0200 | [diff] [blame] | 1 | plugin install |
| 2 | ============== |
| 3 | |
| 4 | NAME |
| 5 | ---- |
| 6 | plugin install - Install/Add a plugin. |
| 7 | |
| 8 | plugin add - Install/Add a plugin. |
| 9 | |
| 10 | SYNOPSIS |
| 11 | -------- |
| Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 12 | -- |
| Edwin Kempin | f729574 | 2012-07-16 15:03:46 +0200 | [diff] [blame] | 13 | 'ssh' -p <port> <host> 'gerrit plugin install | add' |
| 14 | [--name <NAME> | -n <NAME>] |
| 15 | - | <URL> | <PATH> |
| Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 16 | -- |
| Edwin Kempin | f729574 | 2012-07-16 15:03:46 +0200 | [diff] [blame] | 17 | |
| 18 | DESCRIPTION |
| 19 | ----------- |
| 20 | Install/Add a plugin. The plugin will be copied into the site path's |
| 21 | `plugins` directory. |
| 22 | |
| 23 | ACCESS |
| 24 | ------ |
| 25 | Caller must be a member of the privileged 'Administrators' group. |
| 26 | |
| 27 | SCRIPTING |
| 28 | --------- |
| 29 | This command is intended to be used in scripts. |
| 30 | |
| 31 | OPTIONS |
| 32 | ------- |
| 33 | -:: |
| Dariusz Luksza | 357a242 | 2012-11-12 06:16:26 +0100 | [diff] [blame^] | 34 | Plugin jar or js as piped input. |
| Edwin Kempin | f729574 | 2012-07-16 15:03:46 +0200 | [diff] [blame] | 35 | |
| 36 | <URL>:: |
| 37 | URL from where the plugin should be downloaded. This can be an |
| 38 | HTTP or FTP site. |
| 39 | |
| 40 | <PATH>:: |
| Dariusz Luksza | 357a242 | 2012-11-12 06:16:26 +0100 | [diff] [blame^] | 41 | Absolute file path to the plugin jar or js. |
| Edwin Kempin | f729574 | 2012-07-16 15:03:46 +0200 | [diff] [blame] | 42 | |
| 43 | --name:: |
| 44 | -n:: |
| David Ostrovsky | 366ad0e | 2013-09-05 19:59:09 +0200 | [diff] [blame] | 45 | The name under which the plugin should be installed. Note: if the plugin |
| 46 | provides its own name in the MANIFEST file, then the plugin name from the |
| 47 | MANIFEST file has precedence over this option. |
| Edwin Kempin | f729574 | 2012-07-16 15:03:46 +0200 | [diff] [blame] | 48 | |
| 49 | EXAMPLES |
| 50 | -------- |
| 51 | Install a plugin from an absolute file path on the server's host: |
| 52 | |
| 53 | ==== |
| Dariusz Luksza | 357a242 | 2012-11-12 06:16:26 +0100 | [diff] [blame^] | 54 | ssh -p 29418 localhost gerrit plugin install -n name.jar \ |
| Edwin Kempin | f729574 | 2012-07-16 15:03:46 +0200 | [diff] [blame] | 55 | $(pwd)/my-plugin.jar |
| 56 | ==== |
| 57 | |
| Dariusz Luksza | 357a242 | 2012-11-12 06:16:26 +0100 | [diff] [blame^] | 58 | Install a WebUi plugin from an absolute file path on the server's host: |
| 59 | |
| 60 | ==== |
| 61 | ssh -p 29418 localhost gerrit plugin install -n name.js \ |
| 62 | $(pwd)/my-webui-plugin.js |
| 63 | ==== |
| 64 | |
| Edwin Kempin | f729574 | 2012-07-16 15:03:46 +0200 | [diff] [blame] | 65 | Install a plugin from an HTTP site: |
| 66 | |
| 67 | ==== |
| Dariusz Luksza | 357a242 | 2012-11-12 06:16:26 +0100 | [diff] [blame^] | 68 | ssh -p 29418 localhost gerrit plugin install -n name.jar \ |
| 69 | http://build-server/output/our-plugin |
| Edwin Kempin | f729574 | 2012-07-16 15:03:46 +0200 | [diff] [blame] | 70 | ==== |
| 71 | |
| 72 | Install a plugin from piped input: |
| 73 | |
| 74 | ==== |
| Dariusz Luksza | 357a242 | 2012-11-12 06:16:26 +0100 | [diff] [blame^] | 75 | ssh -p 29418 localhost gerrit plugin install -n name.jar \ |
| Edwin Kempin | f729574 | 2012-07-16 15:03:46 +0200 | [diff] [blame] | 76 | - <target/name-0.1.jar |
| 77 | ==== |
| 78 | |
| 79 | GERRIT |
| 80 | ------ |
| 81 | Part of link:index.html[Gerrit Code Review] |
| Yuxuan 'fishy' Wang | 99cb68d | 2013-10-31 17:26:00 -0700 | [diff] [blame] | 82 | |
| 83 | SEARCHBOX |
| 84 | --------- |