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