gerrit/Documentation/cmd-plugin-install.txt
Dariusz Luksza 357a242708 Enable standalone JavaScript plugins
The idea of 'standalone JavaScript plugins' came during the 'JavaScript
plugins' talk at the Gerrit User Summit.

The main concept is to automatically install and expose all *.js files
that are in Gerrit's plugins/ directory.  This should lower the entry
point barrier for JS developers.

There is one limitation of such plugins: they cannot contribute
additional resources.  When such are required, the implementer should
inline them in JS code or use the gerrit-plugin-js-archetype.

Change-Id: Ibad8c3938c0855fcabe6937fd8b4d508a9a2eac3
Signed-off-by: Dariusz Luksza <dariusz@luksza.org>
2013-12-07 18:01:54 +01:00

85 lines
1.6 KiB
Plaintext

plugin install
==============
NAME
----
plugin install - Install/Add a plugin.
plugin add - Install/Add a plugin.
SYNOPSIS
--------
--
'ssh' -p <port> <host> 'gerrit plugin install | add'
[--name <NAME> | -n <NAME>]
- | <URL> | <PATH>
--
DESCRIPTION
-----------
Install/Add a plugin. The plugin will be copied into the site path's
`plugins` directory.
ACCESS
------
Caller must be a member of the privileged 'Administrators' group.
SCRIPTING
---------
This command is intended to be used in scripts.
OPTIONS
-------
-::
Plugin jar or js as piped input.
<URL>::
URL from where the plugin should be downloaded. This can be an
HTTP or FTP site.
<PATH>::
Absolute file path to the plugin jar or js.
--name::
-n::
The name under which the plugin should be installed. Note: if the plugin
provides its own name in the MANIFEST file, then the plugin name from the
MANIFEST file has precedence over this option.
EXAMPLES
--------
Install a plugin from an absolute file path on the server's host:
====
ssh -p 29418 localhost gerrit plugin install -n name.jar \
$(pwd)/my-plugin.jar
====
Install a WebUi plugin from an absolute file path on the server's host:
====
ssh -p 29418 localhost gerrit plugin install -n name.js \
$(pwd)/my-webui-plugin.js
====
Install a plugin from an HTTP site:
====
ssh -p 29418 localhost gerrit plugin install -n name.jar \
http://build-server/output/our-plugin
====
Install a plugin from piped input:
====
ssh -p 29418 localhost gerrit plugin install -n name.jar \
- <target/name-0.1.jar
====
GERRIT
------
Part of link:index.html[Gerrit Code Review]
SEARCHBOX
---------