gerrit/Documentation/cmd-suexec.txt
Shawn O. Pearce 477692458c documentation: Clean up command line documentation, examples
The formatting was pretty wrong after upgrading to a newer version
of AsciiDoc, so fix up most of the formatting, correct some order
of commands in the index, and make create-project conform to the
same format used by create-account and create-group.

Change-Id: I555969655ba135e549f0b8b5b02e5f3669a0b282
2011-06-14 16:50:19 -07:00

65 lines
1.2 KiB
Plaintext

suexec
======
NAME
----
suexec - Execute a command as any registered user account
SYNOPSIS
--------
[verse]
'ssh' -p <port>
-i SITE_PATH/etc/ssh_host_rsa_key
'"Gerrit Code Review@localhost"'
'suexec'
--as <EMAIL>
[--from HOST:PORT]
[--]
[COMMAND]
DESCRIPTION
-----------
The suexec command can only be invoked by the magic user `Gerrit
Code Review` and permits executing any other command as any other
registered user account.
OPTIONS
-------
--as::
Email address of the user you want to impersonate.
--from::
Hostname and port of the machine you want to impersonate
the command coming from.
COMMAND::
Gerrit command you want to run.
ACCESS
------
Caller must be the magic user Gerrit Code Review using the SSH
daemon's host key or a key on this daemon's peer host key ring.
SCRIPTING
---------
This command is intended to be used in scripts.
EXAMPLES
--------
Approve the change with commit c0ff33 as "Verified +1" as user bob@example.com
=====
$ sudo -u gerrit ssh -p 29418 \
-i site_path/etc/ssh_host_rsa_key \
"Gerrit Code Review@localhost" \
suexec \
--as bob@example.com \
-- \
gerrit approve --verified +1 c0ff33
=====
GERRIT
------
Part of link:index.html[Gerrit Code Review]