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