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">
5 <meta http-equiv=
"Content-Type" content=
"text/html; charset=UTF-8" />
6 <meta name=
"generator" content=
"AsciiDoc 8.5.2" />
7 <title>git-http-backend(
1)
</title>
8 <style type=
"text/css">
10 p
, li
, dt
, dd
, div
, pre
, h1
, h2
, h3
, h4
, h5
, h6
{
12 border: 1px solid red;
17 margin: 1em 5% 1em 5%;
22 text-decoration: underline
;
42 h1
, h2
, h3
, h4
, h5
, h6
{
44 font-family: sans-serif
;
51 border-bottom: 2px solid silver
;
69 border: 1px solid silver
;
88 font-family: sans-serif
;
94 span#revnumber
, span#revdate
, span#revremark
{
95 font-family: sans-serif
;
99 font-family: sans-serif
;
101 border-top: 2px solid silver
;
107 padding-bottom: 0.5em;
111 padding-bottom: 0.5em;
116 margin-bottom: 1.5em;
118 div
.tableblock
, div
.imageblock
, div
.exampleblock
, div
.verseblock
,
119 div
.quoteblock
, div
.literalblock
, div
.listingblock
, div
.sidebarblock
,
120 div
.admonitionblock
{
122 margin-bottom: 1.5em;
124 div
.admonitionblock
{
126 margin-bottom: 2.0em;
131 div
.content
{ /* Block element content. */
135 /* Block element titles. */
136 div
.title
, caption
.title
{
138 font-family: sans-serif
;
142 margin-bottom: 0.5em;
148 td div
.title:first-child
{
151 div
.content div
.title:first-child
{
154 div
.content
+ div
.title
{
158 div
.sidebarblock
> div
.content
{
160 border: 1px solid silver
;
164 div
.listingblock
> div
.content
{
165 border: 1px solid silver
;
170 div
.quoteblock
, div
.verseblock
{
174 border-left: 5px solid
#dddddd;
178 div
.quoteblock
> div
.attribution
{
183 div
.verseblock
> div
.content
{
186 div
.verseblock
> div
.attribution
{
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div
.verseblock
+ div
.attribution
{
195 div
.admonitionblock
.icon
{
199 text-decoration: underline
;
201 padding-right: 0.5em;
203 div
.admonitionblock td
.content
{
205 border-left: 3px solid
#dddddd;
208 div
.exampleblock
> div
.content
{
209 border-left: 3px solid
#dddddd;
213 div
.imageblock div
.content
{ padding-left: 0; }
214 span
.image img
{ border-style: none
; }
215 a
.image:visited
{ color: white
; }
219 margin-bottom: 0.8em;
232 list-style-position: outside
;
235 list-style-type: decimal
;
238 list-style-type: lower-alpha
;
241 list-style-type: upper-alpha
;
244 list-style-type: lower-roman
;
247 list-style-type: upper-roman
;
250 div
.compact ul
, div
.compact ol
,
251 div
.compact p
, div
.compact p
,
252 div
.compact div
, div
.compact div
{
254 margin-bottom: 0.1em;
257 div
.tableblock
> table
{
258 border: 3px solid
#527bbd;
260 thead
, p
.table
.header
{
261 font-family: sans-serif
;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div
.tableblock
> table
[frame
="void"] {
277 div
.tableblock
> table
[frame
="hsides"] {
278 border-left-style: none
;
279 border-right-style: none
;
281 div
.tableblock
> table
[frame
="vsides"] {
282 border-top-style: none
;
283 border-bottom-style: none
;
289 margin-bottom: 0.8em;
292 padding-bottom: 15px;
294 dt
.hdlist1
.strong
, td
.hdlist1
.strong
{
300 padding-right: 0.8em;
306 div
.hdlist
.compact tr
{
315 .footnote, .footnoteref {
319 span
.footnote
, span
.footnoteref
{
320 vertical-align: super
;
324 margin: 20px 0 20px 0;
328 #footnotes div
.footnote
{
334 border-top: 1px solid silver
;
344 div#footer-badges
{ display: none
; }
348 margin-bottom: 2.5em;
353 font-family: sans-serif
;
357 margin-bottom: 0.1em;
360 div
.toclevel1
, div
.toclevel2
, div
.toclevel3
, div
.toclevel4
{
376 /* Overrides for manpage documents */
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver
;
381 border-bottom: 2px solid silver
;
391 div#toc
{ display: none
; }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
396 div
.sidebar-content
{
398 border: 1px solid silver
;
401 div
.sidebar-title
, div
.image-title
{
403 font-family: sans-serif
;
406 margin-bottom: 0.5em;
409 div
.listingblock div
.content
{
410 border: 1px solid silver
;
415 div
.quoteblock-attribution
{
420 div
.verseblock-content
{
423 div
.verseblock-attribution
{
428 div
.exampleblock-content
{
429 border-left: 3px solid
#dddddd;
433 /* IE6 sets dynamically generated links as visited. */
434 div#toc
a:visited
{ color: blue
; }
436 <script type=
"text/javascript">
438 window
.onload = function(){asciidoc
.footnotes();}
439 var asciidoc
= { // Namespace.
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
448 * Table Of Content generator
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.
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
459 toc: function (toclevels
) {
461 function getText(el
) {
463 for (var i
= el
.firstChild
; i
!= null; i
= i
.nextSibling
) {
464 if (i
.nodeType
== 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
466 else if (i
.firstChild
!= null)
472 function TocEntry(el
, text
, toclevel
) {
475 this.toclevel
= toclevel
;
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
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);
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");
510 div
.className
= "toclevel" + entry
.toclevel
;
511 toc
.appendChild(div
);
513 if (entries
.length
== 0)
514 toc
.parentNode
.removeChild(toc
);
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
526 footnotes: function () {
527 var cont
= document
.getElementById("content");
528 var noteholder
= document
.getElementById("footnotes");
529 var spans
= cont
.getElementsByTagName("span");
532 for (i
=0; i
<spans
.length
; i
++) {
533 if (spans
[i
].className
== "footnote") {
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>";
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
;
550 noteholder
.parentNode
.removeChild(noteholder
);
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.
559 "[<a href='#_footnote_" + n
+
560 "' title='View footnote' class='footnote'>" + n
+ "</a>]";
573 git-http-backend(
1) Manual Page
576 <div class=
"sectionbody">
577 <p>git-http-backend -
578 Server side implementation of Git over HTTP
583 <h2 id=
"_synopsis">SYNOPSIS
</h2>
584 <div class=
"sectionbody">
585 <div class=
"verseblock">
586 <div class=
"verseblock-content"><em>git http-backend
</em></div>
587 <div class=
"verseblock-attribution">
590 <h2 id=
"_description">DESCRIPTION
</h2>
591 <div class=
"sectionbody">
592 <div class=
"paragraph"><p>A simple CGI program to serve the contents of a Git repository to Git
593 clients accessing the repository over http:// and https:// protocols.
594 The program supports clients fetching using both the smart HTTP protocol
595 and the backwards-compatible dumb HTTP protocol, as well as clients
596 pushing using the smart HTTP protocol.
</p></div>
597 <div class=
"paragraph"><p>It verifies that the directory has the magic file
598 "git-daemon-export-ok", and it will refuse to export any git directory
599 that hasn
’t explicitly been marked for export this way (unless the
600 GIT_HTTP_EXPORT_ALL environmental variable is set).
</p></div>
601 <div class=
"paragraph"><p>By default, only the
<tt>upload-pack
</tt> service is enabled, which serves
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,
604 the
<tt>receive-pack
</tt> service is enabled, which serves
<em>git send-pack
</em>
605 clients, which is invoked from
<em>git push
</em>.
</p></div>
607 <h2 id=
"_services">SERVICES
</h2>
608 <div class=
"sectionbody">
609 <div class=
"paragraph"><p>These services can be enabled/disabled using the per-repository
610 configuration file:
</p></div>
611 <div class=
"dlist"><dl>
617 This serves Git clients older than version
1.6.6 that are unable to use the
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>.
630 This serves
<em>git fetch-pack
</em> and
<em>git ls-remote
</em> clients.
631 It is enabled by default, but a repository can disable it
632 by setting this configuration item to
<tt>false
</tt>.
640 This serves
<em>git send-pack
</em> clients, allowing push. It is
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>.
649 <h2 id=
"_url_translation">URL TRANSLATION
</h2>
650 <div class=
"sectionbody">
651 <div class=
"paragraph"><p>To determine the location of the repository on disk,
<em>git http-backend
</em>
652 concatenates the environment variables PATH_INFO, which is set
653 automatically by the web server, and GIT_PROJECT_ROOT, which must be set
654 manually in the web server configuration. If GIT_PROJECT_ROOT is not
655 set,
<em>git http-backend
</em> reads PATH_TRANSLATED, which is also set
656 automatically by the web server.
</p></div>
658 <h2 id=
"_examples">EXAMPLES
</h2>
659 <div class=
"sectionbody">
660 <div class=
"paragraph"><p>All of the following examples map
<em>http://$hostname/git/foo/bar.git
</em>
661 to
<em>/var/www/git/foo/bar.git
</em>.
</p></div>
662 <div class=
"dlist"><dl>
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:
672 <div class=
"listingblock">
673 <div class=
"content">
674 <pre><tt>SetEnv GIT_PROJECT_ROOT /var/www/git
675 SetEnv GIT_HTTP_EXPORT_ALL
676 ScriptAlias /git/ /usr/libexec/git-core/git-http-backend/
</tt></pre>
678 <div class=
"paragraph"><p>To enable anonymous read access but authenticated write access,
679 require authorization with a LocationMatch directive:
</p></div>
680 <div class=
"listingblock">
681 <div class=
"content">
682 <pre><tt><LocationMatch
"^/git/.*/git-receive-pack$">
684 AuthName
"Git Access"
685 Require group committers
687 </LocationMatch
></tt></pre>
689 <div class=
"paragraph"><p>To require authentication for both reads and writes, use a Location
690 directive around the repository, or one of its parent directories:
</p></div>
691 <div class=
"listingblock">
692 <div class=
"content">
693 <pre><tt><Location /git/private
>
695 AuthName
"Private Git Access"
696 Require group committers
698 </Location
></tt></pre>
700 <div class=
"paragraph"><p>To serve gitweb at the same url, use a ScriptAliasMatch to only
701 those URLs that
<em>git http-backend
</em> can handle, and forward the
702 rest to gitweb:
</p></div>
703 <div class=
"listingblock">
704 <div class=
"content">
705 <pre><tt>ScriptAliasMatch \
706 "(?x)^/git/(.*/(HEAD | \
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
714 ScriptAlias /git/ /var/www/cgi-bin/gitweb.cgi/
</tt></pre>
716 <div class=
"paragraph"><p>To serve multiple repositories from different
<a href=
"gitnamespaces.html">gitnamespaces(
7)
</a> in a
717 single repository:
</p></div>
718 <div class=
"listingblock">
719 <div class=
"content">
720 <pre><tt>SetEnvIf Request_URI
"^/git/([^/]*)" GIT_NAMESPACE=$
1
721 ScriptAliasMatch ^/git/[^/]*(.*) /usr/libexec/git-core/git-http-backend/storage.git$
1</tt></pre>
725 Accelerated static Apache
2.x
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:
734 <div class=
"listingblock">
735 <div class=
"content">
736 <pre><tt>SetEnv GIT_PROJECT_ROOT /var/www/git
738 AliasMatch ^/git/(.*/objects/[
0-
9a-f]{
2}/[
0-
9a-f]{
38})$ /var/www/git/$
1
739 AliasMatch ^/git/(.*/objects/pack/pack-[
0-
9a-f]{
40}.(pack|idx))$ /var/www/git/$
1
740 ScriptAlias /git/ /usr/libexec/git-core/git-http-backend/
</tt></pre>
742 <div class=
"paragraph"><p>This can be combined with the gitweb configuration:
</p></div>
743 <div class=
"listingblock">
744 <div class=
"content">
745 <pre><tt>SetEnv GIT_PROJECT_ROOT /var/www/git
747 AliasMatch ^/git/(.*/objects/[
0-
9a-f]{
2}/[
0-
9a-f]{
38})$ /var/www/git/$
1
748 AliasMatch ^/git/(.*/objects/pack/pack-[
0-
9a-f]{
40}.(pack|idx))$ /var/www/git/$
1
750 "(?x)^/git/(.*/(HEAD | \
752 objects/info/[^/]+ | \
753 git-(upload|receive)-pack))$" \
754 /usr/libexec/git-core/git-http-backend/$
1
755 ScriptAlias /git/ /var/www/cgi-bin/gitweb.cgi/
</tt></pre>
760 <h2 id=
"_environment">ENVIRONMENT
</h2>
761 <div class=
"sectionbody">
762 <div class=
"paragraph"><p><em>git http-backend
</em> relies upon the CGI environment variables set
763 by the invoking web server, including:
</p></div>
764 <div class=
"ulist"><ul>
767 PATH_INFO (if GIT_PROJECT_ROOT is set, otherwise PATH_TRANSLATED)
796 <div class=
"paragraph"><p>The GIT_HTTP_EXPORT_ALL environmental variable may be passed to
797 <em>git-http-backend
</em> to bypass the check for the
"git-daemon-export-ok"
798 file in each repository before allowing export of that repository.
</p></div>
799 <div class=
"paragraph"><p>The backend process sets GIT_COMMITTER_NAME to
<em>$REMOTE_USER
</em> and
800 GIT_COMMITTER_EMAIL to
<em>${REMOTE_USER}@http.${REMOTE_ADDR}
</em>,
801 ensuring that any reflogs created by
<em>git-receive-pack
</em> contain some
802 identifying information of the remote user who performed the push.
</p></div>
803 <div class=
"paragraph"><p>All CGI environment variables are available to each of the hooks
804 invoked by the
<em>git-receive-pack
</em>.
</p></div>
806 <h2 id=
"_author">Author
</h2>
807 <div class=
"sectionbody">
808 <div class=
"paragraph"><p>Written by Shawn O. Pearce
<<a href=
"mailto:spearce@spearce.org">spearce@spearce.org
</a>>.
</p></div>
810 <h2 id=
"_documentation">Documentation
</h2>
811 <div class=
"sectionbody">
812 <div class=
"paragraph"><p>Documentation by Shawn O. Pearce
<<a href=
"mailto:spearce@spearce.org">spearce@spearce.org
</a>>.
</p></div>
814 <h2 id=
"_git">GIT
</h2>
815 <div class=
"sectionbody">
816 <div class=
"paragraph"><p>Part of the
<a href=
"git.html">git(
1)
</a> suite
</p></div>
819 <div id=
"footnotes"><hr /></div>
821 <div id=
"footer-text">
822 Last updated
2011-
09-
21 23:
01:
14 PDT