Skip to content

Commit 5bfb269

Browse files
committed
Clarify behavior of user= option. Closes #695
1 parent 11ffa51 commit 5bfb269

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

docs/configuration.rst

+9-5
Original file line numberDiff line numberDiff line change
@@ -365,9 +365,12 @@ follows.
365365

366366
``user``
367367

368-
If :program:`supervisord` is run as the root user, switch users to
369-
this UNIX user account before doing any meaningful processing. This
370-
value has no effect if :program:`supervisord` is not run as root.
368+
Instruct :program:`supervisord` to switch users to this UNIX user
369+
account before doing any meaningful processing. The user can only
370+
be switched if :program:`supervisord` is started as the root user.
371+
If :program:`supervisord` can't switch users, it will still continue
372+
but will write log message at the ``critical`` level saying that it
373+
can't drop privileges.
371374

372375
*Default*: do not switch users
373376

@@ -802,8 +805,9 @@ where specified.
802805

803806
``user``
804807

805-
If :program:`supervisord` runs as root, this UNIX user account will
806-
be used as the account which runs the program. If :program:`supervisord`
808+
Instruct :program:`supervisord` to use this UNIX user account as the
809+
account which runs the program. The user can only be switched if
810+
:program:`supervisord` is run as the root user. If :program:`supervisord`
807811
can't switch to the specified user, the program will not be started.
808812

809813
.. note::

0 commit comments

Comments
 (0)