doc: clarify that "git daemon --user=<user>" option does not export HOME=~user
The fact that we don't set $HOME may confuse admins who expect ~<user>/.gitconfig to be used, because that is not what we try to read. And worse, since 96b9e0e3, a git-daemon started by root is likely to fail to run at all, as the user we switch to generally cannot read ~root. Signed-off-by: Jeff King <peff@peff.net> Helped-by: W. Trevor King <wking@tremily.us> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Junio C Hamano committed
Apr 12, 2013 at 09:08 UTC
714d25868f156e0969eb8a47e6a1bf3df9c17a5d
1 file changed
+7
Documentation/git-daemon.txt
+7
@@ -147,6 +147,13 @@ OPTIONS
147
Giving these options is an error when used with `--inetd`; use
148
the facility of inet daemon to achieve the same before spawning
149
'git daemon' if needed.
150
++
151
+Like many programs that switch user id, the daemon does not reset
152
+environment variables such as `$HOME` when it runs git programs,
153
+e.g. `upload-pack` and `receive-pack`. When using this option, you
154
+may also want to set and export `HOME` to point at the home
155
+directory of `<user>` before starting the daemon, and make sure any
156
+Git configuration files in that directory are readable by `<user>`.
157
158
--enable=<service>::
159
--disable=<service>::