Google Git
Sign in
chromium / external / gitster / git-htmldocs / d7f343f3a5563a5c1b3f0c35659b84832df060b1 / . / git-http-backend.html
blob: 98bdc709ad08e6a822ca0edca23bac17820a298d [file] [log] [blame]
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]6<meta name="generator" content="AsciiDoc 8.5.2" />
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]7<title>git-http-backend(1)</title>
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]8<style type="text/css">
9/* Debug borders */
10p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11/*
12 border: 1px solid red;
13*/
14}
15
16body {
17 margin: 1em 5% 1em 5%;
18}
19
20a {
21 color: blue;
22 text-decoration: underline;
23}
24a:visited {
25 color: fuchsia;
26}
27
28em {
29 font-style: italic;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]30 color: navy;
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]31}
32
33strong {
34 font-weight: bold;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]35 color: #083194;
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]36}
37
38tt {
39 color: navy;
40}
41
42h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
48}
49
50h1, h2, h3 {
51 border-bottom: 2px solid silver;
52}
53h2 {
54 padding-top: 0.5em;
55}
56h3 {
57 float: left;
58}
59h3 + * {
60 clear: left;
61}
62
63div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
66}
67
68hr {
69 border: 1px solid silver;
70}
71
72p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
75}
76
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]77ul, ol, li > p {
78 margin-top: 0;
79}
80
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]81pre {
82 padding: 0;
83 margin: 0;
84}
85
86span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
91}
92span#email {
93}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]94span#revnumber, span#revdate, span#revremark {
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]95 font-family: sans-serif;
96}
97
98div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
104}
105div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
108}
109div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
112}
113
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]114div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
117}
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]118div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]121 margin-top: 1.0em;
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]122 margin-bottom: 1.5em;
123}
124div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]129}
130
131div.content { /* Block element content. */
132 padding: 0;
133}
134
135/* Block element titles. */
136div.title, caption.title {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]137 color: #527bbd;
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
143}
144div.title + * {
145 margin-top: 0;
146}
147
148td div.title:first-child {
149 margin-top: 0.0em;
150}
151div.content div.title:first-child {
152 margin-top: 0.0em;
153}
154div.content + div.title {
155 margin-top: 0.0em;
156}
157
158div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
162}
163
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]164div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
168}
169
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]170div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]173 margin-right: 10%;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]174 border-left: 5px solid #dddddd;
175 color: #777777;
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]176}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]177
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]178div.quoteblock > div.attribution {
179 padding-top: 0.5em;
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]180 text-align: right;
181}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]182
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]183div.verseblock > div.content {
184 white-space: pre;
185}
186div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
189}
190/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]191div.verseblock + div.attribution {
192 text-align: left;
193}
194
195div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
202}
203div.admonitionblock td.content {
204 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]205 border-left: 3px solid #dddddd;
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]206}
207
208div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]211}
212
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]213div.imageblock div.content { padding-left: 0; }
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]214span.image img { border-style: none; }
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]215a.image:visited { color: white; }
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]216
217dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
220}
221dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]224 font-style: normal;
225 color: navy;
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]226}
227dd > *:first-child {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]228 margin-top: 0.1em;
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]229}
230
231ul, ol {
232 list-style-position: outside;
233}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]234ol.arabic {
235 list-style-type: decimal;
236}
237ol.loweralpha {
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]238 list-style-type: lower-alpha;
239}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]240ol.upperalpha {
241 list-style-type: upper-alpha;
242}
243ol.lowerroman {
244 list-style-type: lower-roman;
245}
246ol.upperroman {
247 list-style-type: upper-roman;
248}
249
250div.compact ul, div.compact ol,
251div.compact p, div.compact p,
252div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
255}
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]256
257div.tableblock > table {
258 border: 3px solid #527bbd;
259}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]260thead, p.table.header {
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]261 font-family: sans-serif;
262 font-weight: bold;
263}
264tfoot {
265 font-weight: bold;
266}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]267td > div.verse {
268 white-space: pre;
269}
270p.table {
271 margin-top: 0;
272}
273/* Because the table frame attribute is overriden by CSS in most browsers. */
274div.tableblock > table[frame="void"] {
275 border-style: none;
276}
277div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
280}
281div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
284}
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]285
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]286
287div.hdlist {
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
290}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]291div.hdlist tr {
292 padding-bottom: 15px;
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]293}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]294dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
296}
297td.hdlist1 {
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]298 vertical-align: top;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]299 font-style: normal;
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]300 padding-right: 0.8em;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]301 color: navy;
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]302}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]303td.hdlist2 {
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]304 vertical-align: top;
305}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]306div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
309}
310
311.comment {
312 background: yellow;
313}
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]314
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]315.footnote, .footnoteref {
316 font-size: 0.8em;
317}
318
319span.footnote, span.footnoteref {
320 vertical-align: super;
321}
322
323#footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
326}
327
328#footnotes div.footnote {
329 margin: 0 0 5px 0;
330}
331
332#footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
340}
341
342
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]343@media print {
344 div#footer-badges { display: none; }
345}
346
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]347div#toc {
348 margin-bottom: 2.5em;
349}
350
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]351div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
358}
359
360div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
363}
364div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
367}
368div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
371}
372div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
375}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]376/* Overrides for manpage documents */
377h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
382}
383h2 {
384 border-style: none;
385}
386div.sectionbody {
387 margin-left: 5%;
388}
389
390@media print {
391 div#toc { display: none; }
392}
393
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]394/* Workarounds for IE6's broken and incomplete CSS2. */
395
396div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
400}
401div.sidebar-title, div.image-title {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]402 color: #527bbd;
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
407}
408
409div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
413}
414
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]415div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
418}
419
420div.verseblock-content {
421 white-space: pre;
422}
423div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]426}
427
428div.exampleblock-content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]429 border-left: 3px solid #dddddd;
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]430 padding-left: 0.5em;
431}
432
433/* IE6 sets dynamically generated links as visited. */
434div#toc a:visited { color: blue; }
435</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]436<script type="text/javascript">
437/*<![CDATA[*/
438window.onload = function(){asciidoc.footnotes();}
439var asciidoc = { // Namespace.
440
441/////////////////////////////////////////////////////////////////////
442// Table Of Contents generator
443/////////////////////////////////////////////////////////////////////
444
445/* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
447 *
448 * Table Of Content generator
449 * Version: 0.4
450 *
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
453 */
454
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
457
458// toclevels = 1..4.
459toc: function (toclevels) {
460
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
468 }
469 return text;
470 }
471
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
476 }
477
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
490 }
491 iterate(i);
492 }
493 }
494 }
495 iterate(el);
496 return result;
497 }
498
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
512 }
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
515},
516
517
518/////////////////////////////////////////////////////////////////////
519// Footnotes generator
520/////////////////////////////////////////////////////////////////////
521
522/* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
524 */
525
526footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
547 }
548 }
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
561 }
562 }
563 }
564}
565
566}
567/*]]>*/
568</script>
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]569</head>
570<body>
571<div id="header">
572<h1>
573git-http-backend(1) Manual Page
574</h1>
575<h2>NAME</h2>
576<div class="sectionbody">
577<p>git-http-backend -
578 Server side implementation of Git over HTTP
579</p>
580</div>
581</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]582<div id="content">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]583<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]584<div class="sectionbody">
585<div class="verseblock">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]586<div class="verseblock-content"><em>git http-backend</em></div>
587<div class="verseblock-attribution">
588</div></div>
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]589</div>
590<h2 id="_description">DESCRIPTION</h2>
591<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]592<div class="paragraph"><p>A simple CGI program to serve the contents of a Git repository to Git
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]593clients accessing the repository over http:// and https:// protocols.
Junio C Hamano167b1382010-01-31 23:04:31[diff] [blame]594The program supports clients fetching using both the smart HTTP protocol
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]595and the backwards-compatible dumb HTTP protocol, as well as clients
596pushing using the smart HTTP protocol.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]597<div class="paragraph"><p>It verifies that the directory has the magic file
Junio C Hamano6ce6b6c2010-01-18 01:25:50[diff] [blame]598"git-daemon-export-ok", and it will refuse to export any git directory
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]599that hasn&#8217;t explicitly been marked for export this way (unless the
Junio C Hamano6ce6b6c2010-01-18 01:25:50[diff] [blame]600GIT_HTTP_EXPORT_ALL environmental variable is set).</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]601<div class="paragraph"><p>By default, only the <tt>upload-pack</tt> service is enabled, which serves
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]602<em>git fetch-pack</em> and <em>git ls-remote</em> clients, which are invoked from
603<em>git fetch</em>, <em>git pull</em>, and <em>git clone</em>. If the client is authenticated,
604the <tt>receive-pack</tt> service is enabled, which serves <em>git send-pack</em>
605clients, which is invoked from <em>git push</em>.</p></div>
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]606</div>
607<h2 id="_services">SERVICES</h2>
608<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]609<div class="paragraph"><p>These services can be enabled/disabled using the per-repository
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]610configuration file:</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]611<div class="dlist"><dl>
612<dt class="hdlist1">
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]613http.getanyfile
614</dt>
615<dd>
616<p>
Junio C Hamano1f630d52010-04-01 04:49:25[diff] [blame]617 This serves Git clients older than version 1.6.6 that are unable to use the
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]618 upload pack service. When enabled, clients are able to read
619 any file within the repository, including objects that are
620 no longer reachable from a branch but are still present.
621 It is enabled by default, but a repository can disable it
622 by setting this configuration item to <tt>false</tt>.
623</p>
624</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]625<dt class="hdlist1">
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]626http.uploadpack
627</dt>
628<dd>
629<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]630 This serves <em>git fetch-pack</em> and <em>git ls-remote</em> clients.
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]631 It is enabled by default, but a repository can disable it
632 by setting this configuration item to <tt>false</tt>.
633</p>
634</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]635<dt class="hdlist1">
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]636http.receivepack
637</dt>
638<dd>
639<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]640 This serves <em>git send-pack</em> clients, allowing push. It is
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]641 disabled by default for anonymous users, and enabled by
642 default for users authenticated by the web server. It can be
643 disabled by setting this item to <tt>false</tt>, or enabled for all
644 users, including anonymous users, by setting it to <tt>true</tt>.
645</p>
646</dd>
647</dl></div>
648</div>
649<h2 id="_url_translation">URL TRANSLATION</h2>
650<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]651<div class="paragraph"><p>To determine the location of the repository on disk, <em>git http-backend</em>
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]652concatenates the environment variables PATH_INFO, which is set
653automatically by the web server, and GIT_PROJECT_ROOT, which must be set
654manually in the web server configuration. If GIT_PROJECT_ROOT is not
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]655set, <em>git http-backend</em> reads PATH_TRANSLATED, which is also set
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]656automatically by the web server.</p></div>
657</div>
658<h2 id="_examples">EXAMPLES</h2>
659<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]660<div class="paragraph"><p>All of the following examples map <em>http://$hostname/git/foo/bar.git</em>
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]661to <em>/var/www/git/foo/bar.git</em>.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]662<div class="dlist"><dl>
663<dt class="hdlist1">
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]664Apache 2.x
665</dt>
666<dd>
667<p>
668 Ensure mod_cgi, mod_alias, and mod_env are enabled, set
669 GIT_PROJECT_ROOT (or DocumentRoot) appropriately, and
670 create a ScriptAlias to the CGI:
671</p>
672<div class="listingblock">
673<div class="content">
674<pre><tt>SetEnv GIT_PROJECT_ROOT /var/www/git
Junio C Hamano6ce6b6c2010-01-18 01:25:50[diff] [blame]675SetEnv GIT_HTTP_EXPORT_ALL
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]676ScriptAlias /git/ /usr/libexec/git-core/git-http-backend/</tt></pre>
677</div></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]678<div class="paragraph"><p>To enable anonymous read access but authenticated write access,
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]679require authorization with a LocationMatch directive:</p></div>
680<div class="listingblock">
681<div class="content">
682<pre><tt>&lt;LocationMatch "^/git/.*/git-receive-pack$"&gt;
683 AuthType Basic
684 AuthName "Git Access"
685 Require group committers
686 ...
687&lt;/LocationMatch&gt;</tt></pre>
688</div></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]689<div class="paragraph"><p>To require authentication for both reads and writes, use a Location
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]690directive around the repository, or one of its parent directories:</p></div>
691<div class="listingblock">
692<div class="content">
693<pre><tt>&lt;Location /git/private&gt;
694 AuthType Basic
695 AuthName "Private Git Access"
696 Require group committers
697 ...
698&lt;/Location&gt;</tt></pre>
699</div></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]700<div class="paragraph"><p>To serve gitweb at the same url, use a ScriptAliasMatch to only
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]701those URLs that <em>git http-backend</em> can handle, and forward the
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]702rest to gitweb:</p></div>
703<div class="listingblock">
704<div class="content">
705<pre><tt>ScriptAliasMatch \
706 "(?x)^/git/(.*/(HEAD | \
707 info/refs | \
708 objects/(info/[^/]+ | \
709 [0-9a-f]{2}/[0-9a-f]{38} | \
710 pack/pack-[0-9a-f]{40}\.(pack|idx)) | \
711 git-(upload|receive)-pack))$" \
712 /usr/libexec/git-core/git-http-backend/$1
713
714ScriptAlias /git/ /var/www/cgi-bin/gitweb.cgi/</tt></pre>
715</div></div>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]716<div class="paragraph"><p>To serve multiple repositories from different <a href="gitnamespaces.html">gitnamespaces(7)</a> in a
Junio C Hamanof7279012011-08-18 06:13:13[diff] [blame]717single repository:</p></div>
718<div class="listingblock">
719<div class="content">
720<pre><tt>SetEnvIf Request_URI "^/git/([^/]*)" GIT_NAMESPACE=$1
721ScriptAliasMatch ^/git/[^/]*(.*) /usr/libexec/git-core/git-http-backend/storage.git$1</tt></pre>
722</div></div>
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]723</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]724<dt class="hdlist1">
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]725Accelerated static Apache 2.x
726</dt>
727<dd>
728<p>
729 Similar to the above, but Apache can be used to return static
730 files that are stored on disk. On many systems this may
731 be more efficient as Apache can ask the kernel to copy the
732 file contents from the file system directly to the network:
733</p>
734<div class="listingblock">
735<div class="content">
736<pre><tt>SetEnv GIT_PROJECT_ROOT /var/www/git
737
738AliasMatch ^/git/(.*/objects/[0-9a-f]{2}/[0-9a-f]{38})$ /var/www/git/$1
739AliasMatch ^/git/(.*/objects/pack/pack-[0-9a-f]{40}.(pack|idx))$ /var/www/git/$1
740ScriptAlias /git/ /usr/libexec/git-core/git-http-backend/</tt></pre>
741</div></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]742<div class="paragraph"><p>This can be combined with the gitweb configuration:</p></div>
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]743<div class="listingblock">
744<div class="content">
745<pre><tt>SetEnv GIT_PROJECT_ROOT /var/www/git
746
747AliasMatch ^/git/(.*/objects/[0-9a-f]{2}/[0-9a-f]{38})$ /var/www/git/$1
748AliasMatch ^/git/(.*/objects/pack/pack-[0-9a-f]{40}.(pack|idx))$ /var/www/git/$1
749ScriptAliasMatch \
750 "(?x)^/git/(.*/(HEAD | \
751 info/refs | \
752 objects/info/[^/]+ | \
753 git-(upload|receive)-pack))$" \
754 /usr/libexec/git-core/git-http-backend/$1
755ScriptAlias /git/ /var/www/cgi-bin/gitweb.cgi/</tt></pre>
756</div></div>
757</dd>
758</dl></div>
759</div>
760<h2 id="_environment">ENVIRONMENT</h2>
761<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]762<div class="paragraph"><p><em>git http-backend</em> relies upon the CGI environment variables set
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]763by the invoking web server, including:</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]764<div class="ulist"><ul>
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]765<li>
766<p>
767PATH_INFO (if GIT_PROJECT_ROOT is set, otherwise PATH_TRANSLATED)
768</p>
769</li>
770<li>
771<p>
772REMOTE_USER
773</p>
774</li>
775<li>
776<p>
777REMOTE_ADDR
778</p>
779</li>
780<li>
781<p>
782CONTENT_TYPE
783</p>
784</li>
785<li>
786<p>
787QUERY_STRING
788</p>
789</li>
790<li>
791<p>
792REQUEST_METHOD
793</p>
794</li>
795</ul></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]796<div class="paragraph"><p>The GIT_HTTP_EXPORT_ALL environmental variable may be passed to
Junio C Hamano6ce6b6c2010-01-18 01:25:50[diff] [blame]797<em>git-http-backend</em> to bypass the check for the "git-daemon-export-ok"
798file in each repository before allowing export of that repository.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]799<div class="paragraph"><p>The backend process sets GIT_COMMITTER_NAME to <em>$REMOTE_USER</em> and
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]800GIT_COMMITTER_EMAIL to <em>${REMOTE_USER}@http.${REMOTE_ADDR}</em>,
801ensuring that any reflogs created by <em>git-receive-pack</em> contain some
802identifying information of the remote user who performed the push.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]803<div class="paragraph"><p>All CGI environment variables are available to each of the hooks
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]804invoked by the <em>git-receive-pack</em>.</p></div>
805</div>
806<h2 id="_author">Author</h2>
807<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]808<div class="paragraph"><p>Written by Shawn O. Pearce &lt;<a href="mailto:spearce@spearce.org">spearce@spearce.org</a>&gt;.</p></div>
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]809</div>
810<h2 id="_documentation">Documentation</h2>
811<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]812<div class="paragraph"><p>Documentation by Shawn O. Pearce &lt;<a href="mailto:spearce@spearce.org">spearce@spearce.org</a>&gt;.</p></div>
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]813</div>
814<h2 id="_git">GIT</h2>
815<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]816<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]817</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]818</div>
819<div id="footnotes"><hr /></div>
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]820<div id="footer">
821<div id="footer-text">
Junio C Hamano02194af2011-11-17 20:33:59[diff] [blame]822Last updated 2011-11-15 13:45:02 PDT
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]823</div>
824</div>
825</body>
826</html>