git-http-backend.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   3     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   5 <head>
   6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
   7 <meta name="generator" content="AsciiDoc 10.2.0" />
   8 <title>git-http-backend(1)</title>
   9 <style type="text/css">
  10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
  11
  12 /* Default font. */
  13 body {
  14   font-family: Georgia,serif;
  15 }
  16
  17 /* Title font. */
  18 h1, h2, h3, h4, h5, h6,
  19 div.title, caption.title,
  20 thead, p.table.header,
  21 #toctitle,
  22 #author, #revnumber, #revdate, #revremark,
  23 #footer {
  24   font-family: Arial,Helvetica,sans-serif;
  25 }
  26
  27 body {
  28   margin: 1em 5% 1em 5%;
  29 }
  30
  31 a {
  32   color: blue;
  33   text-decoration: underline;
  34 }
  35 a:visited {
  36   color: fuchsia;
  37 }
  38
  39 em {
  40   font-style: italic;
  41   color: navy;
  42 }
  43
  44 strong {
  45   font-weight: bold;
  46   color: #083194;
  47 }
  48
  49 h1, h2, h3, h4, h5, h6 {
  50   color: #527bbd;
  51   margin-top: 1.2em;
  52   margin-bottom: 0.5em;
  53   line-height: 1.3;
  54 }
  55
  56 h1, h2, h3 {
  57   border-bottom: 2px solid silver;
  58 }
  59 h2 {
  60   padding-top: 0.5em;
  61 }
  62 h3 {
  63   float: left;
  64 }
  65 h3 + * {
  66   clear: left;
  67 }
  68 h5 {
  69   font-size: 1.0em;
  70 }
  71
  72 div.sectionbody {
  73   margin-left: 0;
  74 }
  75
  76 hr {
  77   border: 1px solid silver;
  78 }
  79
  80 p {
  81   margin-top: 0.5em;
  82   margin-bottom: 0.5em;
  83 }
  84
  85 ul, ol, li > p {
  86   margin-top: 0;
  87 }
  88 ul > li     { color: #aaa; }
  89 ul > li > * { color: black; }
  90
  91 .monospaced, code, pre {
  92   font-family: "Courier New", Courier, monospace;
  93   font-size: inherit;
  94   color: navy;
  95   padding: 0;
  96   margin: 0;
  97 }
  98 pre {
  99   white-space: pre-wrap;
 100 }
 101
 102 #author {
 103   color: #527bbd;
 104   font-weight: bold;
 105   font-size: 1.1em;
 106 }
 107 #email {
 108 }
 109 #revnumber, #revdate, #revremark {
 110 }
 111
 112 #footer {
 113   font-size: small;
 114   border-top: 2px solid silver;
 115   padding-top: 0.5em;
 116   margin-top: 4.0em;
 117 }
 118 #footer-text {
 119   float: left;
 120   padding-bottom: 0.5em;
 121 }
 122 #footer-badges {
 123   float: right;
 124   padding-bottom: 0.5em;
 125 }
 126
 127 #preamble {
 128   margin-top: 1.5em;
 129   margin-bottom: 1.5em;
 130 }
 131 div.imageblock, div.exampleblock, div.verseblock,
 132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 133 div.admonitionblock {
 134   margin-top: 1.0em;
 135   margin-bottom: 1.5em;
 136 }
 137 div.admonitionblock {
 138   margin-top: 2.0em;
 139   margin-bottom: 2.0em;
 140   margin-right: 10%;
 141   color: #606060;
 142 }
 143
 144 div.content { /* Block element content. */
 145   padding: 0;
 146 }
 147
 148 /* Block element titles. */
 149 div.title, caption.title {
 150   color: #527bbd;
 151   font-weight: bold;
 152   text-align: left;
 153   margin-top: 1.0em;
 154   margin-bottom: 0.5em;
 155 }
 156 div.title + * {
 157   margin-top: 0;
 158 }
 159
 160 td div.title:first-child {
 161   margin-top: 0.0em;
 162 }
 163 div.content div.title:first-child {
 164   margin-top: 0.0em;
 165 }
 166 div.content + div.title {
 167   margin-top: 0.0em;
 168 }
 169
 170 div.sidebarblock > div.content {
 171   background: #ffffee;
 172   border: 1px solid #dddddd;
 173   border-left: 4px solid #f0f0f0;
 174   padding: 0.5em;
 175 }
 176
 177 div.listingblock > div.content {
 178   border: 1px solid #dddddd;
 179   border-left: 5px solid #f0f0f0;
 180   background: #f8f8f8;
 181   padding: 0.5em;
 182 }
 183
 184 div.quoteblock, div.verseblock {
 185   padding-left: 1.0em;
 186   margin-left: 1.0em;
 187   margin-right: 10%;
 188   border-left: 5px solid #f0f0f0;
 189   color: #888;
 190 }
 191
 192 div.quoteblock > div.attribution {
 193   padding-top: 0.5em;
 194   text-align: right;
 195 }
 196
 197 div.verseblock > pre.content {
 198   font-family: inherit;
 199   font-size: inherit;
 200 }
 201 div.verseblock > div.attribution {
 202   padding-top: 0.75em;
 203   text-align: left;
 204 }
 205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 206 div.verseblock + div.attribution {
 207   text-align: left;
 208 }
 209
 210 div.admonitionblock .icon {
 211   vertical-align: top;
 212   font-size: 1.1em;
 213   font-weight: bold;
 214   text-decoration: underline;
 215   color: #527bbd;
 216   padding-right: 0.5em;
 217 }
 218 div.admonitionblock td.content {
 219   padding-left: 0.5em;
 220   border-left: 3px solid #dddddd;
 221 }
 222
 223 div.exampleblock > div.content {
 224   border-left: 3px solid #dddddd;
 225   padding-left: 0.5em;
 226 }
 227
 228 div.imageblock div.content { padding-left: 0; }
 229 span.image img { border-style: none; vertical-align: text-bottom; }
 230 a.image:visited { color: white; }
 231
 232 dl {
 233   margin-top: 0.8em;
 234   margin-bottom: 0.8em;
 235 }
 236 dt {
 237   margin-top: 0.5em;
 238   margin-bottom: 0;
 239   font-style: normal;
 240   color: navy;
 241 }
 242 dd > *:first-child {
 243   margin-top: 0.1em;
 244 }
 245
 246 ul, ol {
 247     list-style-position: outside;
 248 }
 249 ol.arabic {
 250   list-style-type: decimal;
 251 }
 252 ol.loweralpha {
 253   list-style-type: lower-alpha;
 254 }
 255 ol.upperalpha {
 256   list-style-type: upper-alpha;
 257 }
 258 ol.lowerroman {
 259   list-style-type: lower-roman;
 260 }
 261 ol.upperroman {
 262   list-style-type: upper-roman;
 263 }
 264
 265 div.compact ul, div.compact ol,
 266 div.compact p, div.compact p,
 267 div.compact div, div.compact div {
 268   margin-top: 0.1em;
 269   margin-bottom: 0.1em;
 270 }
 271
 272 tfoot {
 273   font-weight: bold;
 274 }
 275 td > div.verse {
 276   white-space: pre;
 277 }
 278
 279 div.hdlist {
 280   margin-top: 0.8em;
 281   margin-bottom: 0.8em;
 282 }
 283 div.hdlist tr {
 284   padding-bottom: 15px;
 285 }
 286 dt.hdlist1.strong, td.hdlist1.strong {
 287   font-weight: bold;
 288 }
 289 td.hdlist1 {
 290   vertical-align: top;
 291   font-style: normal;
 292   padding-right: 0.8em;
 293   color: navy;
 294 }
 295 td.hdlist2 {
 296   vertical-align: top;
 297 }
 298 div.hdlist.compact tr {
 299   margin: 0;
 300   padding-bottom: 0;
 301 }
 302
 303 .comment {
 304   background: yellow;
 305 }
 306
 307 .footnote, .footnoteref {
 308   font-size: 0.8em;
 309 }
 310
 311 span.footnote, span.footnoteref {
 312   vertical-align: super;
 313 }
 314
 315 #footnotes {
 316   margin: 20px 0 20px 0;
 317   padding: 7px 0 0 0;
 318 }
 319
 320 #footnotes div.footnote {
 321   margin: 0 0 5px 0;
 322 }
 323
 324 #footnotes hr {
 325   border: none;
 326   border-top: 1px solid silver;
 327   height: 1px;
 328   text-align: left;
 329   margin-left: 0;
 330   width: 20%;
 331   min-width: 100px;
 332 }
 333
 334 div.colist td {
 335   padding-right: 0.5em;
 336   padding-bottom: 0.3em;
 337   vertical-align: top;
 338 }
 339 div.colist td img {
 340   margin-top: 0.3em;
 341 }
 342
 343 @media print {
 344   #footer-badges { display: none; }
 345 }
 346
 347 #toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 #toctitle {
 352   color: #527bbd;
 353   font-size: 1.1em;
 354   font-weight: bold;
 355   margin-top: 1.0em;
 356   margin-bottom: 0.1em;
 357 }
 358
 359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 360   margin-top: 0;
 361   margin-bottom: 0;
 362 }
 363 div.toclevel2 {
 364   margin-left: 2em;
 365   font-size: 0.9em;
 366 }
 367 div.toclevel3 {
 368   margin-left: 4em;
 369   font-size: 0.9em;
 370 }
 371 div.toclevel4 {
 372   margin-left: 6em;
 373   font-size: 0.9em;
 374 }
 375
 376 span.aqua { color: aqua; }
 377 span.black { color: black; }
 378 span.blue { color: blue; }
 379 span.fuchsia { color: fuchsia; }
 380 span.gray { color: gray; }
 381 span.green { color: green; }
 382 span.lime { color: lime; }
 383 span.maroon { color: maroon; }
 384 span.navy { color: navy; }
 385 span.olive { color: olive; }
 386 span.purple { color: purple; }
 387 span.red { color: red; }
 388 span.silver { color: silver; }
 389 span.teal { color: teal; }
 390 span.white { color: white; }
 391 span.yellow { color: yellow; }
 392
 393 span.aqua-background { background: aqua; }
 394 span.black-background { background: black; }
 395 span.blue-background { background: blue; }
 396 span.fuchsia-background { background: fuchsia; }
 397 span.gray-background { background: gray; }
 398 span.green-background { background: green; }
 399 span.lime-background { background: lime; }
 400 span.maroon-background { background: maroon; }
 401 span.navy-background { background: navy; }
 402 span.olive-background { background: olive; }
 403 span.purple-background { background: purple; }
 404 span.red-background { background: red; }
 405 span.silver-background { background: silver; }
 406 span.teal-background { background: teal; }
 407 span.white-background { background: white; }
 408 span.yellow-background { background: yellow; }
 409
 410 span.big { font-size: 2em; }
 411 span.small { font-size: 0.6em; }
 412
 413 span.underline { text-decoration: underline; }
 414 span.overline { text-decoration: overline; }
 415 span.line-through { text-decoration: line-through; }
 416
 417 div.unbreakable { page-break-inside: avoid; }
 418
 419
 420 /*
 421  * xhtml11 specific
 422  *
 423  * */
 424
 425 div.tableblock {
 426   margin-top: 1.0em;
 427   margin-bottom: 1.5em;
 428 }
 429 div.tableblock > table {
 430   border: 3px solid #527bbd;
 431 }
 432 thead, p.table.header {
 433   font-weight: bold;
 434   color: #527bbd;
 435 }
 436 p.table {
 437   margin-top: 0;
 438 }
 439 /* Because the table frame attribute is overridden by CSS in most browsers. */
 440 div.tableblock > table[frame="void"] {
 441   border-style: none;
 442 }
 443 div.tableblock > table[frame="hsides"] {
 444   border-left-style: none;
 445   border-right-style: none;
 446 }
 447 div.tableblock > table[frame="vsides"] {
 448   border-top-style: none;
 449   border-bottom-style: none;
 450 }
 451
 452
 453 /*
 454  * html5 specific
 455  *
 456  * */
 457
 458 table.tableblock {
 459   margin-top: 1.0em;
 460   margin-bottom: 1.5em;
 461 }
 462 thead, p.tableblock.header {
 463   font-weight: bold;
 464   color: #527bbd;
 465 }
 466 p.tableblock {
 467   margin-top: 0;
 468 }
 469 table.tableblock {
 470   border-width: 3px;
 471   border-spacing: 0px;
 472   border-style: solid;
 473   border-color: #527bbd;
 474   border-collapse: collapse;
 475 }
 476 th.tableblock, td.tableblock {
 477   border-width: 1px;
 478   padding: 4px;
 479   border-style: solid;
 480   border-color: #527bbd;
 481 }
 482
 483 table.tableblock.frame-topbot {
 484   border-left-style: hidden;
 485   border-right-style: hidden;
 486 }
 487 table.tableblock.frame-sides {
 488   border-top-style: hidden;
 489   border-bottom-style: hidden;
 490 }
 491 table.tableblock.frame-none {
 492   border-style: hidden;
 493 }
 494
 495 th.tableblock.halign-left, td.tableblock.halign-left {
 496   text-align: left;
 497 }
 498 th.tableblock.halign-center, td.tableblock.halign-center {
 499   text-align: center;
 500 }
 501 th.tableblock.halign-right, td.tableblock.halign-right {
 502   text-align: right;
 503 }
 504
 505 th.tableblock.valign-top, td.tableblock.valign-top {
 506   vertical-align: top;
 507 }
 508 th.tableblock.valign-middle, td.tableblock.valign-middle {
 509   vertical-align: middle;
 510 }
 511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
 512   vertical-align: bottom;
 513 }
 514
 515
 516 /*
 517  * manpage specific
 518  *
 519  * */
 520
 521 body.manpage h1 {
 522   padding-top: 0.5em;
 523   padding-bottom: 0.5em;
 524   border-top: 2px solid silver;
 525   border-bottom: 2px solid silver;
 526 }
 527 body.manpage h2 {
 528   border-style: none;
 529 }
 530 body.manpage div.sectionbody {
 531   margin-left: 3em;
 532 }
 533
 534 @media print {
 535   body.manpage div#toc { display: none; }
 536 }
 537
 538
 539 </style>
 540 <script type="text/javascript">
 541 /*<![CDATA[*/
 542 var asciidoc = {  // Namespace.
 543
 544 /////////////////////////////////////////////////////////////////////
 545 // Table Of Contents generator
 546 /////////////////////////////////////////////////////////////////////
 547
 548 /* Author: Mihai Bazon, September 2002
 549  * http://students.infoiasi.ro/~mishoo
 550  *
 551  * Table Of Content generator
 552  * Version: 0.4
 553  *
 554  * Feel free to use this script under the terms of the GNU General Public
 555  * License, as long as you do not remove or alter this notice.
 556  */
 557
 558  /* modified by Troy D. Hanson, September 2006. License: GPL */
 559  /* modified by Stuart Rackham, 2006, 2009. License: GPL */
 560
 561 // toclevels = 1..4.
 562 toc: function (toclevels) {
 563
 564   function getText(el) {
 565     var text = "";
 566     for (var i = el.firstChild; i != null; i = i.nextSibling) {
 567       if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
 568         text += i.data;
 569       else if (i.firstChild != null)
 570         text += getText(i);
 571     }
 572     return text;
 573   }
 574
 575   function TocEntry(el, text, toclevel) {
 576     this.element = el;
 577     this.text = text;
 578     this.toclevel = toclevel;
 579   }
 580
 581   function tocEntries(el, toclevels) {
 582     var result = new Array;
 583     var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
 584     // Function that scans the DOM tree for header elements (the DOM2
 585     // nodeIterator API would be a better technique but not supported by all
 586     // browsers).
 587     var iterate = function (el) {
 588       for (var i = el.firstChild; i != null; i = i.nextSibling) {
 589         if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
 590           var mo = re.exec(i.tagName);
 591           if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
 592             result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
 593           }
 594           iterate(i);
 595         }
 596       }
 597     }
 598     iterate(el);
 599     return result;
 600   }
 601
 602   var toc = document.getElementById("toc");
 603   if (!toc) {
 604     return;
 605   }
 606
 607   // Delete existing TOC entries in case we're reloading the TOC.
 608   var tocEntriesToRemove = [];
 609   var i;
 610   for (i = 0; i < toc.childNodes.length; i++) {
 611     var entry = toc.childNodes[i];
 612     if (entry.nodeName.toLowerCase() == 'div'
 613      && entry.getAttribute("class")
 614      && entry.getAttribute("class").match(/^toclevel/))
 615       tocEntriesToRemove.push(entry);
 616   }
 617   for (i = 0; i < tocEntriesToRemove.length; i++) {
 618     toc.removeChild(tocEntriesToRemove[i]);
 619   }
 620
 621   // Rebuild TOC entries.
 622   var entries = tocEntries(document.getElementById("content"), toclevels);
 623   for (var i = 0; i < entries.length; ++i) {
 624     var entry = entries[i];
 625     if (entry.element.id == "")
 626       entry.element.id = "_toc_" + i;
 627     var a = document.createElement("a");
 628     a.href = "#" + entry.element.id;
 629     a.appendChild(document.createTextNode(entry.text));
 630     var div = document.createElement("div");
 631     div.appendChild(a);
 632     div.className = "toclevel" + entry.toclevel;
 633     toc.appendChild(div);
 634   }
 635   if (entries.length == 0)
 636     toc.parentNode.removeChild(toc);
 637 },
 638
 639
 640 /////////////////////////////////////////////////////////////////////
 641 // Footnotes generator
 642 /////////////////////////////////////////////////////////////////////
 643
 644 /* Based on footnote generation code from:
 645  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 646  */
 647
 648 footnotes: function () {
 649   // Delete existing footnote entries in case we're reloading the footnodes.
 650   var i;
 651   var noteholder = document.getElementById("footnotes");
 652   if (!noteholder) {
 653     return;
 654   }
 655   var entriesToRemove = [];
 656   for (i = 0; i < noteholder.childNodes.length; i++) {
 657     var entry = noteholder.childNodes[i];
 658     if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
 659       entriesToRemove.push(entry);
 660   }
 661   for (i = 0; i < entriesToRemove.length; i++) {
 662     noteholder.removeChild(entriesToRemove[i]);
 663   }
 664
 665   // Rebuild footnote entries.
 666   var cont = document.getElementById("content");
 667   var spans = cont.getElementsByTagName("span");
 668   var refs = {};
 669   var n = 0;
 670   for (i=0; i<spans.length; i++) {
 671     if (spans[i].className == "footnote") {
 672       n++;
 673       var note = spans[i].getAttribute("data-note");
 674       if (!note) {
 675         // Use [\s\S] in place of . so multi-line matches work.
 676         // Because JavaScript has no s (dotall) regex flag.
 677         note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
 678         spans[i].innerHTML =
 679           "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
 680           "' title='View footnote' class='footnote'>" + n + "</a>]";
 681         spans[i].setAttribute("data-note", note);
 682       }
 683       noteholder.innerHTML +=
 684         "<div class='footnote' id='_footnote_" + n + "'>" +
 685         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
 686         n + "</a>. " + note + "</div>";
 687       var id =spans[i].getAttribute("id");
 688       if (id != null) refs["#"+id] = n;
 689     }
 690   }
 691   if (n == 0)
 692     noteholder.parentNode.removeChild(noteholder);
 693   else {
 694     // Process footnoterefs.
 695     for (i=0; i<spans.length; i++) {
 696       if (spans[i].className == "footnoteref") {
 697         var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
 698         href = href.match(/#.*/)[0];  // Because IE return full URL.
 699         n = refs[href];
 700         spans[i].innerHTML =
 701           "[<a href='#_footnote_" + n +
 702           "' title='View footnote' class='footnote'>" + n + "</a>]";
 703       }
 704     }
 705   }
 706 },
 707
 708 install: function(toclevels) {
 709   var timerId;
 710
 711   function reinstall() {
 712     asciidoc.footnotes();
 713     if (toclevels) {
 714       asciidoc.toc(toclevels);
 715     }
 716   }
 717
 718   function reinstallAndRemoveTimer() {
 719     clearInterval(timerId);
 720     reinstall();
 721   }
 722
 723   timerId = setInterval(reinstall, 500);
 724   if (document.addEventListener)
 725     document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
 726   else
 727     window.onload = reinstallAndRemoveTimer;
 728 }
 729
 730 }
 731 asciidoc.install();
 732 /*]]>*/
 733 </script>
 734 </head>
 735 <body class="manpage">
 736 <div id="header">
 737 <h1>
 738 git-http-backend(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-http-backend -
 743    Server side implementation of Git over HTTP
 744 </p>
 745 </div>
 746 </div>
 747 <div id="content">
 748 <div class="sect1">
 749 <h2 id="_synopsis">SYNOPSIS</h2>
 750 <div class="sectionbody">
 751 <div class="verseblock">
 752 <pre class="content"><em>git http-backend</em></pre>
 753 <div class="attribution">
 754 </div></div>
 755 </div>
 756 </div>
 757 <div class="sect1">
 758 <h2 id="_description">DESCRIPTION</h2>
 759 <div class="sectionbody">
 760 <div class="paragraph"><p>A simple CGI program to serve the contents of a Git repository to Git
 761 clients accessing the repository over http:// and https:// protocols.
 762 The program supports clients fetching using both the smart HTTP protocol
 763 and the backwards-compatible dumb HTTP protocol, as well as clients
 764 pushing using the smart HTTP protocol. It also supports Git&#8217;s
 765 more-efficient "v2" protocol if properly configured; see the
 766 discussion of <code>GIT_PROTOCOL</code> in the ENVIRONMENT section below.</p></div>
 767 <div class="paragraph"><p>It verifies that the directory has the magic file
 768 "git-daemon-export-ok", and it will refuse to export any Git directory
 769 that hasn&#8217;t explicitly been marked for export this way (unless the
 770 <code>GIT_HTTP_EXPORT_ALL</code> environment variable is set).</p></div>
 771 <div class="paragraph"><p>By default, only the <code>upload-pack</code> service is enabled, which serves
 772 <em>git fetch-pack</em> and <em>git ls-remote</em> clients, which are invoked from
 773 <em>git fetch</em>, <em>git pull</em>, and <em>git clone</em>.  If the client is authenticated,
 774 the <code>receive-pack</code> service is enabled, which serves <em>git send-pack</em>
 775 clients, which is invoked from <em>git push</em>.</p></div>
 776 </div>
 777 </div>
 778 <div class="sect1">
 779 <h2 id="_services">SERVICES</h2>
 780 <div class="sectionbody">
 781 <div class="paragraph"><p>These services can be enabled/disabled using the per-repository
 782 configuration file:</p></div>
 783 <div class="dlist"><dl>
 784 <dt class="hdlist1">
 785 http.getanyfile
 786 </dt>
 787 <dd>
 788 <p>
 789         This serves Git clients older than version 1.6.6 that are unable to use the
 790         upload pack service.  When enabled, clients are able to read
 791         any file within the repository, including objects that are
 792         no longer reachable from a branch but are still present.
 793         It is enabled by default, but a repository can disable it
 794         by setting this configuration value to <code>false</code>.
 795 </p>
 796 </dd>
 797 <dt class="hdlist1">
 798 http.uploadpack
 799 </dt>
 800 <dd>
 801 <p>
 802         This serves <em>git fetch-pack</em> and <em>git ls-remote</em> clients.
 803         It is enabled by default, but a repository can disable it
 804         by setting this configuration value to <code>false</code>.
 805 </p>
 806 </dd>
 807 <dt class="hdlist1">
 808 http.receivepack
 809 </dt>
 810 <dd>
 811 <p>
 812         This serves <em>git send-pack</em> clients, allowing push.  It is
 813         disabled by default for anonymous users, and enabled by
 814         default for users authenticated by the web server.  It can be
 815         disabled by setting this item to <code>false</code>, or enabled for all
 816         users, including anonymous users, by setting it to <code>true</code>.
 817 </p>
 818 </dd>
 819 </dl></div>
 820 </div>
 821 </div>
 822 <div class="sect1">
 823 <h2 id="_url_translation">URL TRANSLATION</h2>
 824 <div class="sectionbody">
 825 <div class="paragraph"><p>To determine the location of the repository on disk, <em>git http-backend</em>
 826 concatenates the environment variables PATH_INFO, which is set
 827 automatically by the web server, and GIT_PROJECT_ROOT, which must be set
 828 manually in the web server configuration.  If GIT_PROJECT_ROOT is not
 829 set, <em>git http-backend</em> reads PATH_TRANSLATED, which is also set
 830 automatically by the web server.</p></div>
 831 </div>
 832 </div>
 833 <div class="sect1">
 834 <h2 id="_examples">EXAMPLES</h2>
 835 <div class="sectionbody">
 836 <div class="paragraph"><p>All of the following examples map <code>http://$hostname/git/foo/bar.git</code>
 837 to <code>/var/www/git/foo/bar.git</code>.</p></div>
 838 <div class="dlist"><dl>
 839 <dt class="hdlist1">
 840 Apache 2.x
 841 </dt>
 842 <dd>
 843 <p>
 844         Ensure mod_cgi, mod_alias, and mod_env are enabled, set
 845         GIT_PROJECT_ROOT (or DocumentRoot) appropriately, and
 846         create a ScriptAlias to the CGI:
 847 </p>
 848 <div class="listingblock">
 849 <div class="content">
 850 <pre><code>SetEnv GIT_PROJECT_ROOT /var/www/git
 851 SetEnv GIT_HTTP_EXPORT_ALL
 852 ScriptAlias /git/ /usr/libexec/git-core/git-http-backend/
 853
 854 # This is not strictly necessary using Apache and a modern version of
 855 # git-http-backend, as the webserver will pass along the header in the
 856 # environment as HTTP_GIT_PROTOCOL, and http-backend will copy that into
 857 # GIT_PROTOCOL. But you may need this line (or something similar if you
 858 # are using a different webserver), or if you want to support older Git
 859 # versions that did not do that copying.
 860 #
 861 # Having the webserver set up GIT_PROTOCOL is perfectly fine even with
 862 # modern versions (and will take precedence over HTTP_GIT_PROTOCOL,
 863 # which means it can be used to override the client's request).
 864 SetEnvIf Git-Protocol ".*" GIT_PROTOCOL=$0</code></pre>
 865 </div></div>
 866 <div class="paragraph"><p>To enable anonymous read access but authenticated write access,
 867 require authorization for both the initial ref advertisement (which we
 868 detect as a push via the service parameter in the query string), and the
 869 receive-pack invocation itself:</p></div>
 870 <div class="listingblock">
 871 <div class="content">
 872 <pre><code>RewriteCond %{QUERY_STRING} service=git-receive-pack [OR]
 873 RewriteCond %{REQUEST_URI} /git-receive-pack$
 874 RewriteRule ^/git/ - [E=AUTHREQUIRED:yes]
 875
 876 &lt;LocationMatch "^/git/"&gt;
 877         Order Deny,Allow
 878         Deny from env=AUTHREQUIRED
 879
 880         AuthType Basic
 881         AuthName "Git Access"
 882         Require group committers
 883         Satisfy Any
 884         ...
 885 &lt;/LocationMatch&gt;</code></pre>
 886 </div></div>
 887 <div class="paragraph"><p>If you do not have <code>mod_rewrite</code> available to match against the query
 888 string, it is sufficient to just protect <code>git-receive-pack</code> itself,
 889 like:</p></div>
 890 <div class="listingblock">
 891 <div class="content">
 892 <pre><code>&lt;LocationMatch "^/git/.*/git-receive-pack$"&gt;
 893         AuthType Basic
 894         AuthName "Git Access"
 895         Require group committers
 896         ...
 897 &lt;/LocationMatch&gt;</code></pre>
 898 </div></div>
 899 <div class="paragraph"><p>In this mode, the server will not request authentication until the
 900 client actually starts the object negotiation phase of the push, rather
 901 than during the initial contact.  For this reason, you must also enable
 902 the <code>http.receivepack</code> config option in any repositories that should
 903 accept a push. The default behavior, if <code>http.receivepack</code> is not set,
 904 is to reject any pushes by unauthenticated users; the initial request
 905 will therefore report <code>403 Forbidden</code> to the client, without even giving
 906 an opportunity for authentication.</p></div>
 907 <div class="paragraph"><p>To require authentication for both reads and writes, use a Location
 908 directive around the repository, or one of its parent directories:</p></div>
 909 <div class="listingblock">
 910 <div class="content">
 911 <pre><code>&lt;Location /git/private&gt;
 912         AuthType Basic
 913         AuthName "Private Git Access"
 914         Require group committers
 915         ...
 916 &lt;/Location&gt;</code></pre>
 917 </div></div>
 918 <div class="paragraph"><p>To serve gitweb at the same url, use a ScriptAliasMatch to only
 919 those URLs that <em>git http-backend</em> can handle, and forward the
 920 rest to gitweb:</p></div>
 921 <div class="listingblock">
 922 <div class="content">
 923 <pre><code>ScriptAliasMatch \
 924         "(?x)^/git/(.*/(HEAD | \
 925                         info/refs | \
 926                         objects/(info/[^/]+ | \
 927                                  [0-9a-f]{2}/[0-9a-f]{38} | \
 928                                  pack/pack-[0-9a-f]{40}\.(pack|idx)) | \
 929                         git-(upload|receive)-pack))$" \
 930         /usr/libexec/git-core/git-http-backend/$1
 931
 932 ScriptAlias /git/ /var/www/cgi-bin/gitweb.cgi/</code></pre>
 933 </div></div>
 934 <div class="paragraph"><p>To serve multiple repositories from different <a href="gitnamespaces.html">gitnamespaces(7)</a> in a
 935 single repository:</p></div>
 936 <div class="listingblock">
 937 <div class="content">
 938 <pre><code>SetEnvIf Request_URI "^/git/([^/]*)" GIT_NAMESPACE=$1
 939 ScriptAliasMatch ^/git/[^/]*(.*) /usr/libexec/git-core/git-http-backend/storage.git$1</code></pre>
 940 </div></div>
 941 </dd>
 942 <dt class="hdlist1">
 943 Accelerated static Apache 2.x
 944 </dt>
 945 <dd>
 946 <p>
 947         Similar to the above, but Apache can be used to return static
 948         files that are stored on disk.  On many systems this may
 949         be more efficient as Apache can ask the kernel to copy the
 950         file contents from the file system directly to the network:
 951 </p>
 952 <div class="listingblock">
 953 <div class="content">
 954 <pre><code>SetEnv GIT_PROJECT_ROOT /var/www/git
 955
 956 AliasMatch ^/git/(.*/objects/[0-9a-f]{2}/[0-9a-f]{38})$          /var/www/git/$1
 957 AliasMatch ^/git/(.*/objects/pack/pack-[0-9a-f]{40}.(pack|idx))$ /var/www/git/$1
 958 ScriptAlias /git/ /usr/libexec/git-core/git-http-backend/</code></pre>
 959 </div></div>
 960 <div class="paragraph"><p>This can be combined with the gitweb configuration:</p></div>
 961 <div class="listingblock">
 962 <div class="content">
 963 <pre><code>SetEnv GIT_PROJECT_ROOT /var/www/git
 964
 965 AliasMatch ^/git/(.*/objects/[0-9a-f]{2}/[0-9a-f]{38})$          /var/www/git/$1
 966 AliasMatch ^/git/(.*/objects/pack/pack-[0-9a-f]{40}.(pack|idx))$ /var/www/git/$1
 967 ScriptAliasMatch \
 968         "(?x)^/git/(.*/(HEAD | \
 969                         info/refs | \
 970                         objects/info/[^/]+ | \
 971                         git-(upload|receive)-pack))$" \
 972         /usr/libexec/git-core/git-http-backend/$1
 973 ScriptAlias /git/ /var/www/cgi-bin/gitweb.cgi/</code></pre>
 974 </div></div>
 975 </dd>
 976 <dt class="hdlist1">
 977 Lighttpd
 978 </dt>
 979 <dd>
 980 <p>
 981         Ensure that <code>mod_cgi</code>, <code>mod_alias</code>, <code>mod_auth</code>, <code>mod_setenv</code> are
 982         loaded, then set <code>GIT_PROJECT_ROOT</code> appropriately and redirect
 983         all requests to the CGI:
 984 </p>
 985 <div class="listingblock">
 986 <div class="content">
 987 <pre><code>alias.url += ( "/git" =&gt; "/usr/lib/git-core/git-http-backend" )
 988 $HTTP["url"] =~ "^/git" {
 989         cgi.assign = ("" =&gt; "")
 990         setenv.add-environment = (
 991                 "GIT_PROJECT_ROOT" =&gt; "/var/www/git",
 992                 "GIT_HTTP_EXPORT_ALL" =&gt; ""
 993         )
 994 }</code></pre>
 995 </div></div>
 996 <div class="paragraph"><p>To enable anonymous read access but authenticated write access:</p></div>
 997 <div class="listingblock">
 998 <div class="content">
 999 <pre><code>$HTTP["querystring"] =~ "service=git-receive-pack" {
1000         include "git-auth.conf"
1001 }
1002 $HTTP["url"] =~ "^/git/.*/git-receive-pack$" {
1003         include "git-auth.conf"
1004 }</code></pre>
1005 </div></div>
1006 <div class="paragraph"><p>where <code>git-auth.conf</code> looks something like:</p></div>
1007 <div class="listingblock">
1008 <div class="content">
1009 <pre><code>auth.require = (
1010         "/" =&gt; (
1011                 "method" =&gt; "basic",
1012                 "realm" =&gt; "Git Access",
1013                 "require" =&gt; "valid-user"
1014                )
1015 )
1016 # ...and set up auth.backend here</code></pre>
1017 </div></div>
1018 <div class="paragraph"><p>To require authentication for both reads and writes:</p></div>
1019 <div class="listingblock">
1020 <div class="content">
1021 <pre><code>$HTTP["url"] =~ "^/git/private" {
1022         include "git-auth.conf"
1023 }</code></pre>
1024 </div></div>
1025 </dd>
1026 </dl></div>
1027 </div>
1028 </div>
1029 <div class="sect1">
1030 <h2 id="_environment">ENVIRONMENT</h2>
1031 <div class="sectionbody">
1032 <div class="paragraph"><p><em>git http-backend</em> relies upon the <code>CGI</code> environment variables set
1033 by the invoking web server, including:</p></div>
1034 <div class="ulist"><ul>
1035 <li>
1036 <p>
1037 PATH_INFO (if GIT_PROJECT_ROOT is set, otherwise PATH_TRANSLATED)
1038 </p>
1039 </li>
1040 <li>
1041 <p>
1042 REMOTE_USER
1043 </p>
1044 </li>
1045 <li>
1046 <p>
1047 REMOTE_ADDR
1048 </p>
1049 </li>
1050 <li>
1051 <p>
1052 CONTENT_TYPE
1053 </p>
1054 </li>
1055 <li>
1056 <p>
1057 QUERY_STRING
1058 </p>
1059 </li>
1060 <li>
1061 <p>
1062 REQUEST_METHOD
1063 </p>
1064 </li>
1065 </ul></div>
1066 <div class="paragraph"><p>The <code>GIT_HTTP_EXPORT_ALL</code> environment variable may be passed to
1067 <em>git-http-backend</em> to bypass the check for the "git-daemon-export-ok"
1068 file in each repository before allowing export of that repository.</p></div>
1069 <div class="paragraph"><p>The <code>GIT_HTTP_MAX_REQUEST_BUFFER</code> environment variable (or the
1070 <code>http.maxRequestBuffer</code> config option) may be set to change the
1071 largest ref negotiation request that git will handle during a fetch; any
1072 fetch requiring a larger buffer will not succeed.  This value should not
1073 normally need to be changed, but may be helpful if you are fetching from
1074 a repository with an extremely large number of refs.  The value can be
1075 specified with a unit (e.g., <code>100M</code> for 100 megabytes). The default is
1076 10 megabytes.</p></div>
1077 <div class="paragraph"><p>Clients may probe for optional protocol capabilities (like the v2
1078 protocol) using the <code>Git-Protocol</code> HTTP header. In order to support
1079 these, the contents of that header must appear in the <code>GIT_PROTOCOL</code>
1080 environment variable. Most webservers will pass this header to the CGI
1081 via the <code>HTTP_GIT_PROTOCOL</code> variable, and <code>git-http-backend</code> will
1082 automatically copy that to <code>GIT_PROTOCOL</code>. However, some webservers may
1083 be more selective about which headers they&#8217;ll pass, in which case they
1084 need to be configured explicitly (see the mention of <code>Git-Protocol</code> in
1085 the Apache config from the earlier EXAMPLES section).</p></div>
1086 <div class="paragraph"><p>The backend process sets GIT_COMMITTER_NAME to <em>$REMOTE_USER</em> and
1087 GIT_COMMITTER_EMAIL to <em>${REMOTE_USER}@http.${REMOTE_ADDR}</em>,
1088 ensuring that any reflogs created by <em>git-receive-pack</em> contain some
1089 identifying information of the remote user who performed the push.</p></div>
1090 <div class="paragraph"><p>All <code>CGI</code> environment variables are available to each of the hooks
1091 invoked by the <em>git-receive-pack</em>.</p></div>
1092 </div>
1093 </div>
1094 <div class="sect1">
1095 <h2 id="_git">GIT</h2>
1096 <div class="sectionbody">
1097 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1098 </div>
1099 </div>
1100 </div>
1101 <div id="footnotes"><hr /></div>
1102 <div id="footer">
1103 <div id="footer-text">
1104 Last updated
1105  2023-10-23 14:43:46 PDT
1106 </div>
1107 </div>
1108 </body>
1109 </html>