docs/http-backend: mention v2 protocol

Historically there was a little bit of configuration needed at the webserver level in order to get the client's v2 protocol probes to Git. But when we introduced the v2 protocol, we never documented these. As of the previous commit, this should mostly work out of the box without any explicit configuration. But it's worth documenting this to make it clear how we expect it to work, especially in the face of webservers which don't provide all headers over the CGI interface. Or anybody who runs across this documentation but has an older version of Git (or _used_ to have an older version, and wonders why they still have a SetEnvIf line in their Apache config and whether it's still necessary). Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Jeff King committed Sep 10, 2021 at 10:09 UTC 295d81b9e4c91517f4f436a16889027cb86cba57
1 file changed +25 -1
Documentation/git-http-backend.txt
+25 -1
@@ -16,7 +16,9 @@ A simple CGI program to serve the contents of a Git repository to Git
16 clients accessing the repository over http:// and https:// protocols.
17 The program supports clients fetching using both the smart HTTP protocol
18 and the backwards-compatible dumb HTTP protocol, as well as clients
19 -pushing using the smart HTTP protocol.
19 +pushing using the smart HTTP protocol. It also supports Git's
20 +more-efficient "v2" protocol if properly configured; see the
21 +discussion of `GIT_PROTOCOL` in the ENVIRONMENT section below.
22
23 It verifies that the directory has the magic file
24 "git-daemon-export-ok", and it will refuse to export any Git directory
@@ -77,6 +79,18 @@ Apache 2.x::
79 SetEnv GIT_PROJECT_ROOT /var/www/git
80 SetEnv GIT_HTTP_EXPORT_ALL
81 ScriptAlias /git/ /usr/libexec/git-core/git-http-backend/
82 +
83 +# This is not strictly necessary using Apache and a modern version of
84 +# git-http-backend, as the webserver will pass along the header in the
85 +# environment as HTTP_GIT_PROTOCOL, and http-backend will copy that into
86 +# GIT_PROTOCOL. But you may need this line (or something similar if you
87 +# are using a different webserver), or if you want to support older Git
88 +# versions that did not do that copying.
89 +#
90 +# Having the webserver set up GIT_PROTOCOL is perfectly fine even with
91 +# modern versions (and will take precedence over HTTP_GIT_PROTOCOL,
92 +# which means it can be used to override the client's request).
93 +SetEnvIf Git-Protocol ".*" GIT_PROTOCOL=$0
94 ----------------------------------------------------------------
95 +
96 To enable anonymous read access but authenticated write access,
@@ -264,6 +278,16 @@ a repository with an extremely large number of refs. The value can be
278 specified with a unit (e.g., `100M` for 100 megabytes). The default is
279 10 megabytes.
280
281 +Clients may probe for optional protocol capabilities (like the v2
282 +protocol) using the `Git-Protocol` HTTP header. In order to support
283 +these, the contents of that header must appear in the `GIT_PROTOCOL`
284 +environment variable. Most webservers will pass this header to the CGI
285 +via the `HTTP_GIT_PROTOCOL` variable, and `git-http-backend` will
286 +automatically copy that to `GIT_PROTOCOL`. However, some webservers may
287 +be more selective about which headers they'll pass, in which case they
288 +need to be configured explicitly (see the mention of `Git-Protocol` in
289 +the Apache config from the earlier EXAMPLES section).
290 +
291 The backend process sets GIT_COMMITTER_NAME to '$REMOTE_USER' and
292 GIT_COMMITTER_EMAIL to '$\{REMOTE_USER}@http.$\{REMOTE_ADDR\}',
293 ensuring that any reflogs created by 'git-receive-pack' contain some