Autogenerated HTML docs for v2.45.0-31-gd4cc1
[git-htmldocs.git] / git-daemon.html
blob6c1f583e913ae85dceee534a0ed639ee46a5825a
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-daemon(1)</title>
9 <style type="text/css">
10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
12 /* Default font. */
13 body {
14 font-family: Georgia,serif;
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;
27 body {
28 margin: 1em 5% 1em 5%;
31 a {
32 color: blue;
33 text-decoration: underline;
35 a:visited {
36 color: fuchsia;
39 em {
40 font-style: italic;
41 color: navy;
44 strong {
45 font-weight: bold;
46 color: #083194;
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;
56 h1, h2, h3 {
57 border-bottom: 2px solid silver;
59 h2 {
60 padding-top: 0.5em;
62 h3 {
63 float: left;
65 h3 + * {
66 clear: left;
68 h5 {
69 font-size: 1.0em;
72 div.sectionbody {
73 margin-left: 0;
76 hr {
77 border: 1px solid silver;
80 p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
85 ul, ol, li > p {
86 margin-top: 0;
88 ul > li { color: #aaa; }
89 ul > li > * { color: black; }
91 .monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
95 padding: 0;
96 margin: 0;
98 pre {
99 white-space: pre-wrap;
102 #author {
103 color: #527bbd;
104 font-weight: bold;
105 font-size: 1.1em;
107 #email {
109 #revnumber, #revdate, #revremark {
112 #footer {
113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
118 #footer-text {
119 float: left;
120 padding-bottom: 0.5em;
122 #footer-badges {
123 float: right;
124 padding-bottom: 0.5em;
127 #preamble {
128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
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;
137 div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
144 div.content { /* Block element content. */
145 padding: 0;
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;
156 div.title + * {
157 margin-top: 0;
160 td div.title:first-child {
161 margin-top: 0.0em;
163 div.content div.title:first-child {
164 margin-top: 0.0em;
166 div.content + div.title {
167 margin-top: 0.0em;
170 div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
177 div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
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;
192 div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
197 div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
201 div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206 div.verseblock + div.attribution {
207 text-align: left;
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;
218 div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
223 div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
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; }
232 dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
236 dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
242 dd > *:first-child {
243 margin-top: 0.1em;
246 ul, ol {
247 list-style-position: outside;
249 ol.arabic {
250 list-style-type: decimal;
252 ol.loweralpha {
253 list-style-type: lower-alpha;
255 ol.upperalpha {
256 list-style-type: upper-alpha;
258 ol.lowerroman {
259 list-style-type: lower-roman;
261 ol.upperroman {
262 list-style-type: upper-roman;
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;
272 tfoot {
273 font-weight: bold;
275 td > div.verse {
276 white-space: pre;
279 div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
283 div.hdlist tr {
284 padding-bottom: 15px;
286 dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
289 td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
295 td.hdlist2 {
296 vertical-align: top;
298 div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
303 .comment {
304 background: yellow;
307 .footnote, .footnoteref {
308 font-size: 0.8em;
311 span.footnote, span.footnoteref {
312 vertical-align: super;
315 #footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
320 #footnotes div.footnote {
321 margin: 0 0 5px 0;
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;
334 div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
339 div.colist td img {
340 margin-top: 0.3em;
343 @media print {
344 #footer-badges { display: none; }
347 #toc {
348 margin-bottom: 2.5em;
351 #toctitle {
352 color: #527bbd;
353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
360 margin-top: 0;
361 margin-bottom: 0;
363 div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
367 div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
371 div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
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; }
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; }
410 span.big { font-size: 2em; }
411 span.small { font-size: 0.6em; }
413 span.underline { text-decoration: underline; }
414 span.overline { text-decoration: overline; }
415 span.line-through { text-decoration: line-through; }
417 div.unbreakable { page-break-inside: avoid; }
421 * xhtml11 specific
423 * */
425 div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
429 div.tableblock > table {
430 border: 3px solid #527bbd;
432 thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
436 p.table {
437 margin-top: 0;
439 /* Because the table frame attribute is overridden by CSS in most browsers. */
440 div.tableblock > table[frame="void"] {
441 border-style: none;
443 div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
447 div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
454 * html5 specific
456 * */
458 table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
462 thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
466 p.tableblock {
467 margin-top: 0;
469 table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
476 th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
483 table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
487 table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
491 table.tableblock.frame-none {
492 border-style: hidden;
495 th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
498 th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
501 th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
505 th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
508 th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
517 * manpage specific
519 * */
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;
527 body.manpage h2 {
528 border-style: none;
530 body.manpage div.sectionbody {
531 margin-left: 3em;
534 @media print {
535 body.manpage div#toc { display: none; }
539 </style>
540 <script type="text/javascript">
541 /*<![CDATA[*/
542 var asciidoc = { // Namespace.
544 /////////////////////////////////////////////////////////////////////
545 // Table Of Contents generator
546 /////////////////////////////////////////////////////////////////////
548 /* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
551 * Table Of Content generator
552 * Version: 0.4
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.
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
561 // toclevels = 1..4.
562 toc: function (toclevels) {
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);
572 return text;
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
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);
594 iterate(i);
598 iterate(el);
599 return result;
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
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);
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
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);
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
640 /////////////////////////////////////////////////////////////////////
641 // Footnotes generator
642 /////////////////////////////////////////////////////////////////////
644 /* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
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;
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);
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
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);
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;
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>]";
708 install: function(toclevels) {
709 var timerId;
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
731 asciidoc.install();
732 /*]]>*/
733 </script>
734 </head>
735 <body class="manpage">
736 <div id="header">
737 <h1>
738 git-daemon(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-daemon -
743 A really simple server for Git repositories
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 daemon</em> [--verbose] [--syslog] [--export-all]
753 [--timeout=&lt;n&gt;] [--init-timeout=&lt;n&gt;] [--max-connections=&lt;n&gt;]
754 [--strict-paths] [--base-path=&lt;path&gt;] [--base-path-relaxed]
755 [--user-path | --user-path=&lt;path&gt;]
756 [--interpolated-path=&lt;pathtemplate&gt;]
757 [--reuseaddr] [--detach] [--pid-file=&lt;file&gt;]
758 [--enable=&lt;service&gt;] [--disable=&lt;service&gt;]
759 [--allow-override=&lt;service&gt;] [--forbid-override=&lt;service&gt;]
760 [--access-hook=&lt;path&gt;] [--[no-]informative-errors]
761 [--inetd |
762 [--listen=&lt;host-or-ipaddr&gt;] [--port=&lt;n&gt;]
763 [--user=&lt;user&gt; [--group=&lt;group&gt;]]]
764 [--log-destination=(stderr|syslog|none)]
765 [&lt;directory&gt;&#8230;]</pre>
766 <div class="attribution">
767 </div></div>
768 </div>
769 </div>
770 <div class="sect1">
771 <h2 id="_description">DESCRIPTION</h2>
772 <div class="sectionbody">
773 <div class="paragraph"><p>A really simple TCP Git daemon that normally listens on port "DEFAULT_GIT_PORT"
774 aka 9418. It waits for a connection asking for a service, and will serve
775 that service if it is enabled.</p></div>
776 <div class="paragraph"><p>It verifies that the directory has the magic file "git-daemon-export-ok", and
777 it will refuse to export any Git directory that hasn&#8217;t explicitly been marked
778 for export this way (unless the <code>--export-all</code> parameter is specified). If you
779 pass some directory paths as <em>git daemon</em> arguments, the offers are limited to
780 repositories within those directories.</p></div>
781 <div class="paragraph"><p>By default, only <code>upload-pack</code> service is enabled, which serves
782 <em>git fetch-pack</em> and <em>git ls-remote</em> clients, which are invoked
783 from <em>git fetch</em>, <em>git pull</em>, and <em>git clone</em>.</p></div>
784 <div class="paragraph"><p>This is ideally suited for read-only updates, i.e., pulling from
785 Git repositories.</p></div>
786 <div class="paragraph"><p>An <code>upload-archive</code> also exists to serve <em>git archive</em>.</p></div>
787 </div>
788 </div>
789 <div class="sect1">
790 <h2 id="_options">OPTIONS</h2>
791 <div class="sectionbody">
792 <div class="dlist"><dl>
793 <dt class="hdlist1">
794 --strict-paths
795 </dt>
796 <dd>
798 Match paths exactly (i.e. don&#8217;t allow "/foo/repo" when the real path is
799 "/foo/repo.git" or "/foo/repo/.git") and don&#8217;t do user-relative paths.
800 <em>git daemon</em> will refuse to start when this option is enabled and no
801 directory arguments are provided.
802 </p>
803 </dd>
804 <dt class="hdlist1">
805 --base-path=&lt;path&gt;
806 </dt>
807 <dd>
809 Remap all the path requests as relative to the given path.
810 This is sort of "Git root" - if you run <em>git daemon</em> with
811 <em>--base-path=/srv/git</em> on example.com, then if you later try to pull
812 <em>git://example.com/hello.git</em>, <em>git daemon</em> will interpret the path
813 as <code>/srv/git/hello.git</code>.
814 </p>
815 </dd>
816 <dt class="hdlist1">
817 --base-path-relaxed
818 </dt>
819 <dd>
821 If --base-path is enabled and repo lookup fails, with this option
822 <em>git daemon</em> will attempt to lookup without prefixing the base path.
823 This is useful for switching to --base-path usage, while still
824 allowing the old paths.
825 </p>
826 </dd>
827 <dt class="hdlist1">
828 --interpolated-path=&lt;pathtemplate&gt;
829 </dt>
830 <dd>
832 To support virtual hosting, an interpolated path template can be
833 used to dynamically construct alternate paths. The template
834 supports %H for the target hostname as supplied by the client but
835 converted to all lowercase, %CH for the canonical hostname,
836 %IP for the server&#8217;s IP address, %P for the port number,
837 and %D for the absolute path of the named repository.
838 After interpolation, the path is validated against the directory
839 list.
840 </p>
841 </dd>
842 <dt class="hdlist1">
843 --export-all
844 </dt>
845 <dd>
847 Allow pulling from all directories that look like Git repositories
848 (have the <em>objects</em> and <em>refs</em> subdirectories), even if they
849 do not have the <em>git-daemon-export-ok</em> file.
850 </p>
851 </dd>
852 <dt class="hdlist1">
853 --inetd
854 </dt>
855 <dd>
857 Have the server run as an inetd service. Implies --syslog (may be
858 overridden with <code>--log-destination=</code>).
859 Incompatible with --detach, --port, --listen, --user and --group
860 options.
861 </p>
862 </dd>
863 <dt class="hdlist1">
864 --listen=&lt;host-or-ipaddr&gt;
865 </dt>
866 <dd>
868 Listen on a specific IP address or hostname. IP addresses can
869 be either an IPv4 address or an IPv6 address if supported. If IPv6
870 is not supported, then --listen=&lt;hostname&gt; is also not supported and
871 --listen must be given an IPv4 address.
872 Can be given more than once.
873 Incompatible with <code>--inetd</code> option.
874 </p>
875 </dd>
876 <dt class="hdlist1">
877 --port=&lt;n&gt;
878 </dt>
879 <dd>
881 Listen on an alternative port. Incompatible with <code>--inetd</code> option.
882 </p>
883 </dd>
884 <dt class="hdlist1">
885 --init-timeout=&lt;n&gt;
886 </dt>
887 <dd>
889 Timeout (in seconds) between the moment the connection is established
890 and the client request is received (typically a rather low value, since
891 that should be basically immediate).
892 </p>
893 </dd>
894 <dt class="hdlist1">
895 --timeout=&lt;n&gt;
896 </dt>
897 <dd>
899 Timeout (in seconds) for specific client sub-requests. This includes
900 the time it takes for the server to process the sub-request and the
901 time spent waiting for the next client&#8217;s request.
902 </p>
903 </dd>
904 <dt class="hdlist1">
905 --max-connections=&lt;n&gt;
906 </dt>
907 <dd>
909 Maximum number of concurrent clients, defaults to 32. Set it to
910 zero for no limit.
911 </p>
912 </dd>
913 <dt class="hdlist1">
914 --syslog
915 </dt>
916 <dd>
918 Short for <code>--log-destination=syslog</code>.
919 </p>
920 </dd>
921 <dt class="hdlist1">
922 --log-destination=&lt;destination&gt;
923 </dt>
924 <dd>
926 Send log messages to the specified destination.
927 Note that this option does not imply --verbose,
928 thus by default only error conditions will be logged.
929 The &lt;destination&gt; must be one of:
930 </p>
931 <div class="openblock">
932 <div class="content">
933 <div class="dlist"><dl>
934 <dt class="hdlist1">
935 stderr
936 </dt>
937 <dd>
939 Write to standard error.
940 Note that if <code>--detach</code> is specified,
941 the process disconnects from the real standard error,
942 making this destination effectively equivalent to <code>none</code>.
943 </p>
944 </dd>
945 <dt class="hdlist1">
946 syslog
947 </dt>
948 <dd>
950 Write to syslog, using the <code>git-daemon</code> identifier.
951 </p>
952 </dd>
953 <dt class="hdlist1">
954 none
955 </dt>
956 <dd>
958 Disable all logging.
959 </p>
960 </dd>
961 </dl></div>
962 </div></div>
963 <div class="paragraph"><p>The default destination is <code>syslog</code> if <code>--inetd</code> or <code>--detach</code> is specified,
964 otherwise <code>stderr</code>.</p></div>
965 </dd>
966 <dt class="hdlist1">
967 --user-path
968 </dt>
969 <dt class="hdlist1">
970 --user-path=&lt;path&gt;
971 </dt>
972 <dd>
974 Allow &#126;user notation to be used in requests. When
975 specified with no parameter, a request to
976 git://host/&#126;alice/foo is taken as a request to access
977 <em>foo</em> repository in the home directory of user <code>alice</code>.
978 If <code>--user-path=&lt;path&gt;</code> is specified, the same request is
979 taken as a request to access <code>&lt;path&gt;/foo</code> repository in
980 the home directory of user <code>alice</code>.
981 </p>
982 </dd>
983 <dt class="hdlist1">
984 --verbose
985 </dt>
986 <dd>
988 Log details about the incoming connections and requested files.
989 </p>
990 </dd>
991 <dt class="hdlist1">
992 --reuseaddr
993 </dt>
994 <dd>
996 Use SO_REUSEADDR when binding the listening socket.
997 This allows the server to restart without waiting for
998 old connections to time out.
999 </p>
1000 </dd>
1001 <dt class="hdlist1">
1002 --detach
1003 </dt>
1004 <dd>
1006 Detach from the shell. Implies --syslog.
1007 </p>
1008 </dd>
1009 <dt class="hdlist1">
1010 --pid-file=&lt;file&gt;
1011 </dt>
1012 <dd>
1014 Save the process id in <em>file</em>. Ignored when the daemon
1015 is run under <code>--inetd</code>.
1016 </p>
1017 </dd>
1018 <dt class="hdlist1">
1019 --user=&lt;user&gt;
1020 </dt>
1021 <dt class="hdlist1">
1022 --group=&lt;group&gt;
1023 </dt>
1024 <dd>
1026 Change daemon&#8217;s uid and gid before entering the service loop.
1027 When only <code>--user</code> is given without <code>--group</code>, the
1028 primary group ID for the user is used. The values of
1029 the option are given to <code>getpwnam(3)</code> and <code>getgrnam(3)</code>
1030 and numeric IDs are not supported.
1031 </p>
1032 <div class="paragraph"><p>Giving these options is an error when used with <code>--inetd</code>; use
1033 the facility of inet daemon to achieve the same before spawning
1034 <em>git daemon</em> if needed.</p></div>
1035 <div class="paragraph"><p>Like many programs that switch user id, the daemon does not reset
1036 environment variables such as <code>$HOME</code> when it runs git programs,
1037 e.g. <code>upload-pack</code> and <code>receive-pack</code>. When using this option, you
1038 may also want to set and export <code>HOME</code> to point at the home
1039 directory of <code>&lt;user&gt;</code> before starting the daemon, and make sure any
1040 Git configuration files in that directory are readable by <code>&lt;user&gt;</code>.</p></div>
1041 </dd>
1042 <dt class="hdlist1">
1043 --enable=&lt;service&gt;
1044 </dt>
1045 <dt class="hdlist1">
1046 --disable=&lt;service&gt;
1047 </dt>
1048 <dd>
1050 Enable/disable the service site-wide per default. Note
1051 that a service disabled site-wide can still be enabled
1052 per repository if it is marked overridable and the
1053 repository enables the service with a configuration
1054 item.
1055 </p>
1056 </dd>
1057 <dt class="hdlist1">
1058 --allow-override=&lt;service&gt;
1059 </dt>
1060 <dt class="hdlist1">
1061 --forbid-override=&lt;service&gt;
1062 </dt>
1063 <dd>
1065 Allow/forbid overriding the site-wide default with per
1066 repository configuration. By default, all the services
1067 may be overridden.
1068 </p>
1069 </dd>
1070 <dt class="hdlist1">
1071 --[no-]informative-errors
1072 </dt>
1073 <dd>
1075 When informative errors are turned on, git-daemon will report
1076 more verbose errors to the client, differentiating conditions
1077 like "no such repository" from "repository not exported". This
1078 is more convenient for clients, but may leak information about
1079 the existence of unexported repositories. When informative
1080 errors are not enabled, all errors report "access denied" to the
1081 client. The default is --no-informative-errors.
1082 </p>
1083 </dd>
1084 <dt class="hdlist1">
1085 --access-hook=&lt;path&gt;
1086 </dt>
1087 <dd>
1089 Every time a client connects, first run an external command
1090 specified by the &lt;path&gt; with service name (e.g. "upload-pack"),
1091 path to the repository, hostname (%H), canonical hostname
1092 (%CH), IP address (%IP), and TCP port (%P) as its command-line
1093 arguments. The external command can decide to decline the
1094 service by exiting with a non-zero status (or to allow it by
1095 exiting with a zero status). It can also look at the $REMOTE_ADDR
1096 and <code>$REMOTE_PORT</code> environment variables to learn about the
1097 requestor when making this decision.
1098 </p>
1099 <div class="paragraph"><p>The external command can optionally write a single line to its
1100 standard output to be sent to the requestor as an error message when
1101 it declines the service.</p></div>
1102 </dd>
1103 <dt class="hdlist1">
1104 &lt;directory&gt;
1105 </dt>
1106 <dd>
1108 The remaining arguments provide a list of directories. If any
1109 directories are specified, then the <code>git-daemon</code> process will
1110 serve a requested directory only if it is contained in one of
1111 these directories. If <code>--strict-paths</code> is specified, then the
1112 requested directory must match one of these directories exactly.
1113 </p>
1114 </dd>
1115 </dl></div>
1116 </div>
1117 </div>
1118 <div class="sect1">
1119 <h2 id="_services">SERVICES</h2>
1120 <div class="sectionbody">
1121 <div class="paragraph"><p>These services can be globally enabled/disabled using the
1122 command-line options of this command. If finer-grained
1123 control is desired (e.g. to allow <em>git archive</em> to be run
1124 against only in a few selected repositories the daemon serves),
1125 the per-repository configuration file can be used to enable or
1126 disable them.</p></div>
1127 <div class="dlist"><dl>
1128 <dt class="hdlist1">
1129 upload-pack
1130 </dt>
1131 <dd>
1133 This serves <em>git fetch-pack</em> and <em>git ls-remote</em>
1134 clients. It is enabled by default, but a repository can
1135 disable it by setting <code>daemon.uploadpack</code> configuration
1136 item to <code>false</code>.
1137 </p>
1138 </dd>
1139 <dt class="hdlist1">
1140 upload-archive
1141 </dt>
1142 <dd>
1144 This serves <em>git archive --remote</em>. It is disabled by
1145 default, but a repository can enable it by setting
1146 <code>daemon.uploadarch</code> configuration item to <code>true</code>.
1147 </p>
1148 </dd>
1149 <dt class="hdlist1">
1150 receive-pack
1151 </dt>
1152 <dd>
1154 This serves <em>git send-pack</em> clients, allowing anonymous
1155 push. It is disabled by default, as there is <em>no</em>
1156 authentication in the protocol (in other words, anybody
1157 can push anything into the repository, including removal
1158 of refs). This is solely meant for a closed LAN setting
1159 where everybody is friendly. This service can be
1160 enabled by setting <code>daemon.receivepack</code> configuration item to
1161 <code>true</code>.
1162 </p>
1163 </dd>
1164 </dl></div>
1165 </div>
1166 </div>
1167 <div class="sect1">
1168 <h2 id="_examples">EXAMPLES</h2>
1169 <div class="sectionbody">
1170 <div class="dlist"><dl>
1171 <dt class="hdlist1">
1172 We assume the following in /etc/services
1173 </dt>
1174 <dd>
1175 <div class="listingblock">
1176 <div class="content">
1177 <pre><code>$ grep 9418 /etc/services
1178 git 9418/tcp # Git Version Control System</code></pre>
1179 </div></div>
1180 </dd>
1181 <dt class="hdlist1">
1182 <em>git daemon</em> as inetd server
1183 </dt>
1184 <dd>
1186 To set up <em>git daemon</em> as an inetd service that handles any
1187 repository within <code>/pub/foo</code> or <code>/pub/bar</code>, place an entry like
1188 the following into <code>/etc/inetd</code> all on one line:
1189 </p>
1190 <div class="listingblock">
1191 <div class="content">
1192 <pre><code> git stream tcp nowait nobody /usr/bin/git
1193 git daemon --inetd --verbose --export-all
1194 /pub/foo /pub/bar</code></pre>
1195 </div></div>
1196 </dd>
1197 <dt class="hdlist1">
1198 <em>git daemon</em> as inetd server for virtual hosts
1199 </dt>
1200 <dd>
1202 To set up <em>git daemon</em> as an inetd service that handles
1203 repositories for different virtual hosts, <code>www.example.com</code>
1204 and <code>www.example.org</code>, place an entry like the following into
1205 <code>/etc/inetd</code> all on one line:
1206 </p>
1207 <div class="listingblock">
1208 <div class="content">
1209 <pre><code> git stream tcp nowait nobody /usr/bin/git
1210 git daemon --inetd --verbose --export-all
1211 --interpolated-path=/pub/%H%D
1212 /pub/www.example.org/software
1213 /pub/www.example.com/software
1214 /software</code></pre>
1215 </div></div>
1216 <div class="paragraph"><p>In this example, the root-level directory <code>/pub</code> will contain
1217 a subdirectory for each virtual host name supported.
1218 Further, both hosts advertise repositories simply as
1219 <code>git://www.example.com/software/repo.git</code>. For pre-1.4.0
1220 clients, a symlink from <code>/software</code> into the appropriate
1221 default repository could be made as well.</p></div>
1222 </dd>
1223 <dt class="hdlist1">
1224 <em>git daemon</em> as regular daemon for virtual hosts
1225 </dt>
1226 <dd>
1228 To set up <em>git daemon</em> as a regular, non-inetd service that
1229 handles repositories for multiple virtual hosts based on
1230 their IP addresses, start the daemon like this:
1231 </p>
1232 <div class="listingblock">
1233 <div class="content">
1234 <pre><code> git daemon --verbose --export-all
1235 --interpolated-path=/pub/%IP/%D
1236 /pub/192.168.1.200/software
1237 /pub/10.10.220.23/software</code></pre>
1238 </div></div>
1239 <div class="paragraph"><p>In this example, the root-level directory <code>/pub</code> will contain
1240 a subdirectory for each virtual host IP address supported.
1241 Repositories can still be accessed by hostname though, assuming
1242 they correspond to these IP addresses.</p></div>
1243 </dd>
1244 <dt class="hdlist1">
1245 selectively enable/disable services per repository
1246 </dt>
1247 <dd>
1249 To enable <em>git archive --remote</em> and disable <em>git fetch</em> against
1250 a repository, have the following in the configuration file in the
1251 repository (that is the file <em>config</em> next to <code>HEAD</code>, <em>refs</em> and
1252 <em>objects</em>).
1253 </p>
1254 <div class="listingblock">
1255 <div class="content">
1256 <pre><code> [daemon]
1257 uploadpack = false
1258 uploadarch = true</code></pre>
1259 </div></div>
1260 </dd>
1261 </dl></div>
1262 </div>
1263 </div>
1264 <div class="sect1">
1265 <h2 id="_environment">ENVIRONMENT</h2>
1266 <div class="sectionbody">
1267 <div class="paragraph"><p><em>git daemon</em> will set REMOTE_ADDR to the IP address of the client
1268 that connected to it, if the IP address is available. REMOTE_ADDR will
1269 be available in the environment of hooks called when
1270 services are performed.</p></div>
1271 </div>
1272 </div>
1273 <div class="sect1">
1274 <h2 id="_git">GIT</h2>
1275 <div class="sectionbody">
1276 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1277 </div>
1278 </div>
1279 </div>
1280 <div id="footnotes"><hr /></div>
1281 <div id="footer">
1282 <div id="footer-text">
1283 Last updated
1284 2024-02-08 15:45:59 PST
1285 </div>
1286 </div>
1287 </body>
1288 </html>