gerrit/Documentation/cmd-suexec.txt
Yuxuan 'fishy' Wang d85b687536 Bypass the rendering differences in AsciiDoctor.
AsciiDoctor have different understanding of [verse] with asciidoc, causing some
rendering differences. To get similar result with asciidoc, we use something
else instead of [verse] now.

Screenshots:
before:
http://imgur.com/JKMdBiv
after:
http://imgur.com/yFVvVac

Change-Id: I14e84f0e998e1e87b633681e8028ad657bde07e4
2013-11-15 11:47:46 -08:00

74 lines
1.5 KiB
Plaintext

suexec
======
NAME
----
suexec - Execute a command as any registered user account
SYNOPSIS
--------
--
'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 permits executing any other command as any other
registered user account.
suexec can only be invoked by the magic user `Gerrit Code Review`,
or any user granted granted the link:access-control.html#capability_runAs[Run As]
capability. The run as capability is permitted to be used only if
link:config-gerrit.html[auth.enableRunAs] is true.
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,
or a user granted the Run As capability.
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]
SEARCHBOX
---------