man1/git-http-backend.1

   1 '\" t
   2 .\"     Title: git-http-backend
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-09-13
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.46.1.506.ged155187b4
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-HTTP\-BACKEND" "1" "2024-09-13" "Git 2\&.46\&.1\&.506\&.ged1551" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-http-backend \- Server side implementation of Git over HTTP
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit http\-backend\fR
  36 .fi
  37 .SH "DESCRIPTION"
  38 .sp
  39 A simple CGI program to serve the contents of a Git repository to Git clients accessing the repository over http:// and https:// protocols\&. The program supports clients fetching using both the smart HTTP protocol and the backwards\-compatible dumb HTTP protocol, as well as clients pushing using the smart HTTP protocol\&. It also supports Git\(cqs more\-efficient "v2" protocol if properly configured; see the discussion of \fBGIT_PROTOCOL\fR in the ENVIRONMENT section below\&.
  40 .sp
  41 It verifies that the directory has the magic file "git\-daemon\-export\-ok", and it will refuse to export any Git directory that hasn\(cqt explicitly been marked for export this way (unless the \fBGIT_HTTP_EXPORT_ALL\fR environment variable is set)\&.
  42 .sp
  43 By default, only the \fBupload\-pack\fR service is enabled, which serves \fIgit fetch\-pack\fR and \fIgit ls\-remote\fR clients, which are invoked from \fIgit fetch\fR, \fIgit pull\fR, and \fIgit clone\fR\&. If the client is authenticated, the \fBreceive\-pack\fR service is enabled, which serves \fIgit send\-pack\fR clients, which is invoked from \fIgit push\fR\&.
  44 .SH "SERVICES"
  45 .sp
  46 These services can be enabled/disabled using the per\-repository configuration file:
  47 .PP
  48 http\&.getanyfile
  49 .RS 4
  50 This serves Git clients older than version 1\&.6\&.6 that are unable to use the upload pack service\&. When enabled, clients are able to read any file within the repository, including objects that are no longer reachable from a branch but are still present\&. It is enabled by default, but a repository can disable it by setting this configuration value to
  51 \fBfalse\fR\&.
  52 .RE
  53 .PP
  54 http\&.uploadpack
  55 .RS 4
  56 This serves
  57 \fIgit fetch\-pack\fR
  58 and
  59 \fIgit ls\-remote\fR
  60 clients\&. It is enabled by default, but a repository can disable it by setting this configuration value to
  61 \fBfalse\fR\&.
  62 .RE
  63 .PP
  64 http\&.receivepack
  65 .RS 4
  66 This serves
  67 \fIgit send\-pack\fR
  68 clients, allowing push\&. It is disabled by default for anonymous users, and enabled by default for users authenticated by the web server\&. It can be disabled by setting this item to
  69 \fBfalse\fR, or enabled for all users, including anonymous users, by setting it to
  70 \fBtrue\fR\&.
  71 .RE
  72 .SH "URL TRANSLATION"
  73 .sp
  74 To determine the location of the repository on disk, \fIgit http\-backend\fR concatenates the environment variables PATH_INFO, which is set automatically by the web server, and GIT_PROJECT_ROOT, which must be set manually in the web server configuration\&. If GIT_PROJECT_ROOT is not set, \fIgit http\-backend\fR reads PATH_TRANSLATED, which is also set automatically by the web server\&.
  75 .SH "EXAMPLES"
  76 .sp
  77 All of the following examples map \fBhttp://$hostname/git/foo/bar\&.git\fR to \fB/var/www/git/foo/bar\&.git\fR\&.
  78 .PP
  79 Apache 2\&.x
  80 .RS 4
  81 Ensure mod_cgi, mod_alias, and mod_env are enabled, set GIT_PROJECT_ROOT (or DocumentRoot) appropriately, and create a ScriptAlias to the CGI:
  82 .sp
  83 .if n \{\
  84 .RS 4
  85 .\}
  86 .nf
  87 SetEnv GIT_PROJECT_ROOT /var/www/git
  88 SetEnv GIT_HTTP_EXPORT_ALL
  89 ScriptAlias /git/ /usr/libexec/git\-core/git\-http\-backend/
  90
  91 # This is not strictly necessary using Apache and a modern version of
  92 # git\-http\-backend, as the webserver will pass along the header in the
  93 # environment as HTTP_GIT_PROTOCOL, and http\-backend will copy that into
  94 # GIT_PROTOCOL\&. But you may need this line (or something similar if you
  95 # are using a different webserver), or if you want to support older Git
  96 # versions that did not do that copying\&.
  97 #
  98 # Having the webserver set up GIT_PROTOCOL is perfectly fine even with
  99 # modern versions (and will take precedence over HTTP_GIT_PROTOCOL,
 100 # which means it can be used to override the client\*(Aqs request)\&.
 101 SetEnvIf Git\-Protocol "\&.*" GIT_PROTOCOL=$0
 102 .fi
 103 .if n \{\
 104 .RE
 105 .\}
 106 .sp
 107 To enable anonymous read access but authenticated write access, require authorization for both the initial ref advertisement (which we detect as a push via the service parameter in the query string), and the receive\-pack invocation itself:
 108 .sp
 109 .if n \{\
 110 .RS 4
 111 .\}
 112 .nf
 113 RewriteCond %{QUERY_STRING} service=git\-receive\-pack [OR]
 114 RewriteCond %{REQUEST_URI} /git\-receive\-pack$
 115 RewriteRule ^/git/ \- [E=AUTHREQUIRED:yes]
 116
 117 <LocationMatch "^/git/">
 118         Order Deny,Allow
 119         Deny from env=AUTHREQUIRED
 120
 121         AuthType Basic
 122         AuthName "Git Access"
 123         Require group committers
 124         Satisfy Any
 125         \&.\&.\&.
 126 </LocationMatch>
 127 .fi
 128 .if n \{\
 129 .RE
 130 .\}
 131 .sp
 132 If you do not have
 133 \fBmod_rewrite\fR
 134 available to match against the query string, it is sufficient to just protect
 135 \fBgit\-receive\-pack\fR
 136 itself, like:
 137 .sp
 138 .if n \{\
 139 .RS 4
 140 .\}
 141 .nf
 142 <LocationMatch "^/git/\&.*/git\-receive\-pack$">
 143         AuthType Basic
 144         AuthName "Git Access"
 145         Require group committers
 146         \&.\&.\&.
 147 </LocationMatch>
 148 .fi
 149 .if n \{\
 150 .RE
 151 .\}
 152 .sp
 153 In this mode, the server will not request authentication until the client actually starts the object negotiation phase of the push, rather than during the initial contact\&. For this reason, you must also enable the
 154 \fBhttp\&.receivepack\fR
 155 config option in any repositories that should accept a push\&. The default behavior, if
 156 \fBhttp\&.receivepack\fR
 157 is not set, is to reject any pushes by unauthenticated users; the initial request will therefore report
 158 \fB403 Forbidden\fR
 159 to the client, without even giving an opportunity for authentication\&.
 160 .sp
 161 To require authentication for both reads and writes, use a Location directive around the repository, or one of its parent directories:
 162 .sp
 163 .if n \{\
 164 .RS 4
 165 .\}
 166 .nf
 167 <Location /git/private>
 168         AuthType Basic
 169         AuthName "Private Git Access"
 170         Require group committers
 171         \&.\&.\&.
 172 </Location>
 173 .fi
 174 .if n \{\
 175 .RE
 176 .\}
 177 .sp
 178 To serve gitweb at the same url, use a ScriptAliasMatch to only those URLs that
 179 \fIgit http\-backend\fR
 180 can handle, and forward the rest to gitweb:
 181 .sp
 182 .if n \{\
 183 .RS 4
 184 .\}
 185 .nf
 186 ScriptAliasMatch \e
 187         "(?x)^/git/(\&.*/(HEAD | \e
 188                         info/refs | \e
 189                         objects/(info/[^/]+ | \e
 190                                  [0\-9a\-f]{2}/[0\-9a\-f]{38} | \e
 191                                  pack/pack\-[0\-9a\-f]{40}\e\&.(pack|idx)) | \e
 192                         git\-(upload|receive)\-pack))$" \e
 193         /usr/libexec/git\-core/git\-http\-backend/$1
 194
 195 ScriptAlias /git/ /var/www/cgi\-bin/gitweb\&.cgi/
 196 .fi
 197 .if n \{\
 198 .RE
 199 .\}
 200 .sp
 201 To serve multiple repositories from different
 202 \fBgitnamespaces\fR(7)
 203 in a single repository:
 204 .sp
 205 .if n \{\
 206 .RS 4
 207 .\}
 208 .nf
 209 SetEnvIf Request_URI "^/git/([^/]*)" GIT_NAMESPACE=$1
 210 ScriptAliasMatch ^/git/[^/]*(\&.*) /usr/libexec/git\-core/git\-http\-backend/storage\&.git$1
 211 .fi
 212 .if n \{\
 213 .RE
 214 .\}
 215 .RE
 216 .PP
 217 Accelerated static Apache 2\&.x
 218 .RS 4
 219 Similar to the above, but Apache can be used to return static files that are stored on disk\&. On many systems this may be more efficient as Apache can ask the kernel to copy the file contents from the file system directly to the network:
 220 .sp
 221 .if n \{\
 222 .RS 4
 223 .\}
 224 .nf
 225 SetEnv GIT_PROJECT_ROOT /var/www/git
 226
 227 AliasMatch ^/git/(\&.*/objects/[0\-9a\-f]{2}/[0\-9a\-f]{38})$          /var/www/git/$1
 228 AliasMatch ^/git/(\&.*/objects/pack/pack\-[0\-9a\-f]{40}\&.(pack|idx))$ /var/www/git/$1
 229 ScriptAlias /git/ /usr/libexec/git\-core/git\-http\-backend/
 230 .fi
 231 .if n \{\
 232 .RE
 233 .\}
 234 .sp
 235 This can be combined with the gitweb configuration:
 236 .sp
 237 .if n \{\
 238 .RS 4
 239 .\}
 240 .nf
 241 SetEnv GIT_PROJECT_ROOT /var/www/git
 242
 243 AliasMatch ^/git/(\&.*/objects/[0\-9a\-f]{2}/[0\-9a\-f]{38})$          /var/www/git/$1
 244 AliasMatch ^/git/(\&.*/objects/pack/pack\-[0\-9a\-f]{40}\&.(pack|idx))$ /var/www/git/$1
 245 ScriptAliasMatch \e
 246         "(?x)^/git/(\&.*/(HEAD | \e
 247                         info/refs | \e
 248                         objects/info/[^/]+ | \e
 249                         git\-(upload|receive)\-pack))$" \e
 250         /usr/libexec/git\-core/git\-http\-backend/$1
 251 ScriptAlias /git/ /var/www/cgi\-bin/gitweb\&.cgi/
 252 .fi
 253 .if n \{\
 254 .RE
 255 .\}
 256 .RE
 257 .PP
 258 Lighttpd
 259 .RS 4
 260 Ensure that
 261 \fBmod_cgi\fR,
 262 \fBmod_alias\fR,
 263 \fBmod_auth\fR,
 264 \fBmod_setenv\fR
 265 are loaded, then set
 266 \fBGIT_PROJECT_ROOT\fR
 267 appropriately and redirect all requests to the CGI:
 268 .sp
 269 .if n \{\
 270 .RS 4
 271 .\}
 272 .nf
 273 alias\&.url += ( "/git" => "/usr/lib/git\-core/git\-http\-backend" )
 274 $HTTP["url"] =~ "^/git" {
 275         cgi\&.assign = ("" => "")
 276         setenv\&.add\-environment = (
 277                 "GIT_PROJECT_ROOT" => "/var/www/git",
 278                 "GIT_HTTP_EXPORT_ALL" => ""
 279         )
 280 }
 281 .fi
 282 .if n \{\
 283 .RE
 284 .\}
 285 .sp
 286 To enable anonymous read access but authenticated write access:
 287 .sp
 288 .if n \{\
 289 .RS 4
 290 .\}
 291 .nf
 292 $HTTP["querystring"] =~ "service=git\-receive\-pack" {
 293         include "git\-auth\&.conf"
 294 }
 295 $HTTP["url"] =~ "^/git/\&.*/git\-receive\-pack$" {
 296         include "git\-auth\&.conf"
 297 }
 298 .fi
 299 .if n \{\
 300 .RE
 301 .\}
 302 .sp
 303 where
 304 \fBgit\-auth\&.conf\fR
 305 looks something like:
 306 .sp
 307 .if n \{\
 308 .RS 4
 309 .\}
 310 .nf
 311 auth\&.require = (
 312         "/" => (
 313                 "method" => "basic",
 314                 "realm" => "Git Access",
 315                 "require" => "valid\-user"
 316                )
 317 )
 318 # \&.\&.\&.and set up auth\&.backend here
 319 .fi
 320 .if n \{\
 321 .RE
 322 .\}
 323 .sp
 324 To require authentication for both reads and writes:
 325 .sp
 326 .if n \{\
 327 .RS 4
 328 .\}
 329 .nf
 330 $HTTP["url"] =~ "^/git/private" {
 331         include "git\-auth\&.conf"
 332 }
 333 .fi
 334 .if n \{\
 335 .RE
 336 .\}
 337 .RE
 338 .SH "ENVIRONMENT"
 339 .sp
 340 \fIgit http\-backend\fR relies upon the \fBCGI\fR environment variables set by the invoking web server, including:
 341 .sp
 342 .RS 4
 343 .ie n \{\
 344 \h'-04'\(bu\h'+03'\c
 345 .\}
 346 .el \{\
 347 .sp -1
 348 .IP \(bu 2.3
 349 .\}
 350 PATH_INFO (if GIT_PROJECT_ROOT is set, otherwise PATH_TRANSLATED)
 351 .RE
 352 .sp
 353 .RS 4
 354 .ie n \{\
 355 \h'-04'\(bu\h'+03'\c
 356 .\}
 357 .el \{\
 358 .sp -1
 359 .IP \(bu 2.3
 360 .\}
 361 REMOTE_USER
 362 .RE
 363 .sp
 364 .RS 4
 365 .ie n \{\
 366 \h'-04'\(bu\h'+03'\c
 367 .\}
 368 .el \{\
 369 .sp -1
 370 .IP \(bu 2.3
 371 .\}
 372 REMOTE_ADDR
 373 .RE
 374 .sp
 375 .RS 4
 376 .ie n \{\
 377 \h'-04'\(bu\h'+03'\c
 378 .\}
 379 .el \{\
 380 .sp -1
 381 .IP \(bu 2.3
 382 .\}
 383 CONTENT_TYPE
 384 .RE
 385 .sp
 386 .RS 4
 387 .ie n \{\
 388 \h'-04'\(bu\h'+03'\c
 389 .\}
 390 .el \{\
 391 .sp -1
 392 .IP \(bu 2.3
 393 .\}
 394 QUERY_STRING
 395 .RE
 396 .sp
 397 .RS 4
 398 .ie n \{\
 399 \h'-04'\(bu\h'+03'\c
 400 .\}
 401 .el \{\
 402 .sp -1
 403 .IP \(bu 2.3
 404 .\}
 405 REQUEST_METHOD
 406 .RE
 407 .sp
 408 The \fBGIT_HTTP_EXPORT_ALL\fR environment variable may be passed to \fIgit\-http\-backend\fR to bypass the check for the "git\-daemon\-export\-ok" file in each repository before allowing export of that repository\&.
 409 .sp
 410 The \fBGIT_HTTP_MAX_REQUEST_BUFFER\fR environment variable (or the \fBhttp\&.maxRequestBuffer\fR config option) may be set to change the largest ref negotiation request that git will handle during a fetch; any fetch requiring a larger buffer will not succeed\&. This value should not normally need to be changed, but may be helpful if you are fetching from a repository with an extremely large number of refs\&. The value can be specified with a unit (e\&.g\&., \fB100M\fR for 100 megabytes)\&. The default is 10 megabytes\&.
 411 .sp
 412 Clients may probe for optional protocol capabilities (like the v2 protocol) using the \fBGit\-Protocol\fR HTTP header\&. In order to support these, the contents of that header must appear in the \fBGIT_PROTOCOL\fR environment variable\&. Most webservers will pass this header to the CGI via the \fBHTTP_GIT_PROTOCOL\fR variable, and \fBgit\-http\-backend\fR will automatically copy that to \fBGIT_PROTOCOL\fR\&. However, some webservers may be more selective about which headers they\(cqll pass, in which case they need to be configured explicitly (see the mention of \fBGit\-Protocol\fR in the Apache config from the earlier EXAMPLES section)\&.
 413 .sp
 414 The backend process sets GIT_COMMITTER_NAME to \fI$REMOTE_USER\fR and GIT_COMMITTER_EMAIL to \fI${REMOTE_USER}@http\&.${REMOTE_ADDR}\fR, ensuring that any reflogs created by \fIgit\-receive\-pack\fR contain some identifying information of the remote user who performed the push\&.
 415 .sp
 416 All \fBCGI\fR environment variables are available to each of the hooks invoked by the \fIgit\-receive\-pack\fR\&.
 417 .SH "GIT"
 418 .sp
 419 Part of the \fBgit\fR(1) suite